openOBD functions are functions that can be created to automate diagnostic routines using gRPC. The function is a predefined procedure that can be created to perform an automated task.
Get a list of openOBD functions to perform an automated service.
Successful response.
object >= 0 properties Applied query parameters, including defaults. | |||||||||||||||||||||||||||||
Array of objects (Function) >= 0 items List of functions. | |||||||||||||||||||||||||||||
Array (>= 0 items)
| |||||||||||||||||||||||||||||
| total | integer <int64> Total number of resources matching provided query parameters. | ||||||||||||||||||||||||||||
An error occurred - see status code and problem response for more information.
{- "query": {
- "limit": 25
}, - "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "online": true,
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
- "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "hidden"
}
], - "total": 4
}Create an openOBD function.
Function information to register.
| id required | string <uuid> The identifier of the openOBD function. | ||||||
| description required | string [ 1 .. 1500 ] characters Description as set by the function owner. | ||||||
| name required | string [ 3 .. 255 ] characters Name as set by the function owner. | ||||||
required | object (Money) Price that should be paid for a function invocation. | ||||||
| public required | boolean Whether this function is available for other partners to execute. If set to false, this function can only invoked by the partner that registered the function. | ||||||
| supported_products | Array of strings <uuid> >= 0 items Supported products as set by the function owner. | ||||||
| supported_vehicles | Array of integers <int64> >= 0 items Supported vehicles as set by the function owner. | ||||||
| version required | string [ 1 .. 50 ] characters Version as set by the function owner. Any string is allowed. E.g. '1.12.3a', 'beta', '21', etc. | ||||||
| visibility required | string (FunctionVisibility) Determines where the function will be shown. Does not affect whether the function can be run or not.
| ||||||
| signature required | string The signature that corresponds with the id of the function. Retrievable from the function-broker. see: https://docs.openobd.com/latest/academy/functions/signature/ | ||||||
Successfully registered the new function.
| id | string <uuid> The identifier of the openOBD function. | ||||||
| description | string [ 1 .. 1500 ] characters Description as set by the function owner. | ||||||
| name | string [ 3 .. 255 ] characters Name as set by the function owner. | ||||||
| online | boolean Whether the function is currently available to be run. | ||||||
object (Money) Price that should be paid for a function invocation. | |||||||
| provider_id | string <uuid> The identifier of the provider that provides this function. | ||||||
| public | boolean Whether this function is available for other partners to execute. If set to false, this function can only invoked by the partner that registered the function. | ||||||
| supported_products | Array of strings <uuid> >= 0 items Supported products as set by the function owner. | ||||||
| supported_vehicles | Array of integers <int64> >= 0 items Supported vehicles as set by the function owner. | ||||||
| version | string [ 1 .. 50 ] characters Version as set by the function owner. Any string is allowed. E.g. '1.12.3a', 'beta', '21', etc. | ||||||
| visibility | string (FunctionVisibility) Determines where the function will be shown. Does not affect whether the function can be run or not.
| ||||||
Bad request.
An error occurred - see status code and problem response for more information.
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "visible",
- "signature": "string"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "online": true,
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
- "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "hidden"
}Retrieve info on a specific openOBD functions to perform an automated service.
Retrieved the function.
| id | string <uuid> The identifier of the openOBD function. | ||||||
| description | string [ 1 .. 1500 ] characters Description as set by the function owner. | ||||||
| name | string [ 3 .. 255 ] characters Name as set by the function owner. | ||||||
| online | boolean Whether the function is currently available to be run. | ||||||
object (Money) Price that should be paid for a function invocation. | |||||||
| provider_id | string <uuid> The identifier of the provider that provides this function. | ||||||
| public | boolean Whether this function is available for other partners to execute. If set to false, this function can only invoked by the partner that registered the function. | ||||||
| supported_products | Array of strings <uuid> >= 0 items Supported products as set by the function owner. | ||||||
| supported_vehicles | Array of integers <int64> >= 0 items Supported vehicles as set by the function owner. | ||||||
| version | string [ 1 .. 50 ] characters Version as set by the function owner. Any string is allowed. E.g. '1.12.3a', 'beta', '21', etc. | ||||||
| visibility | string (FunctionVisibility) Determines where the function will be shown. Does not affect whether the function can be run or not.
| ||||||
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "online": true,
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
- "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "hidden"
}Updates an existing function.
Function information to store.
| id required | string <uuid> The identifier of the openOBD function. | ||||||
| description required | string [ 1 .. 1500 ] characters Description as set by the function owner. | ||||||
| name required | string [ 3 .. 255 ] characters Name as set by the function owner. | ||||||
required | object (Money) Price that should be paid for a function invocation. | ||||||
| public required | boolean Whether this function is available for other partners to execute. If set to false, this function can only invoked by the partner that registered the function. | ||||||
| supported_products | Array of strings <uuid> >= 0 items Supported products as set by the function owner. | ||||||
| supported_vehicles | Array of integers <int64> >= 0 items Supported vehicles as set by the function owner. | ||||||
| version required | string [ 1 .. 50 ] characters Version as set by the function owner. Any string is allowed. E.g. '1.12.3a', 'beta', '21', etc. | ||||||
| visibility required | string (FunctionVisibility) Determines where the function will be shown. Does not affect whether the function can be run or not.
| ||||||
Successfully updated the function.
| id | string <uuid> The identifier of the openOBD function. | ||||||
| description | string [ 1 .. 1500 ] characters Description as set by the function owner. | ||||||
| name | string [ 3 .. 255 ] characters Name as set by the function owner. | ||||||
| online | boolean Whether the function is currently available to be run. | ||||||
object (Money) Price that should be paid for a function invocation. | |||||||
| provider_id | string <uuid> The identifier of the provider that provides this function. | ||||||
| public | boolean Whether this function is available for other partners to execute. If set to false, this function can only invoked by the partner that registered the function. | ||||||
| supported_products | Array of strings <uuid> >= 0 items Supported products as set by the function owner. | ||||||
| supported_vehicles | Array of integers <int64> >= 0 items Supported vehicles as set by the function owner. | ||||||
| version | string [ 1 .. 50 ] characters Version as set by the function owner. Any string is allowed. E.g. '1.12.3a', 'beta', '21', etc. | ||||||
| visibility | string (FunctionVisibility) Determines where the function will be shown. Does not affect whether the function can be run or not.
| ||||||
Bad request.
An error occurred - see status code and problem response for more information.
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "visible"
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string",
- "name": "string",
- "online": true,
- "price": {
- "amount": 0,
- "currency": "EUR"
}, - "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
- "public": true,
- "supported_products": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "supported_vehicles": [
- 0
], - "version": "beta 1.12.3a (semi-production)",
- "visibility": "hidden"
}Deleted an existing function.
Successfully removed.
An error occurred - see status code and problem response for more information.
Returned when the request cannot be handled due to something that is perceived to be a client error.
{- "detail": "The request violates one or more constraints. Please resolve all of them and try again.",
- "status": 400,
- "title": "Bad request",
- "type": "/problems/violations",
- "violations": [
- {
- "property_path": "gross_price.amount",
- "in": "body",
- "detail": "Value must be greater than 0"
}, - {
- "property_path": "provider_id",
- "in": "query",
- "detail": "Provider with ID 3445 does not exist."
}
]
}