Get custom log definition
GET/projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}
Base URL: https://api.tinkermode.com
Get the specified custom log definition.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user API key of a user with permission to read the entity custom log, a service account token with the same permission, or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) | |
customLogDefinitionId | string | Yes | Custom log definition ID (unique within entity class). |
Responses
200 Successful retrieval of custom log definition.
Content type: application/json
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customLogDefinitionId | string | No | ID of the custom log definition. Must be unique within an Entity Class. | ||||||||||||||||||||||||||||||||||||||||||||||
dataStoreConfiguration | object | No | Data store configuration of custom log. | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
displayName | string | No | The display name of the custom log definition. | ||||||||||||||||||||||||||||||||||||||||||||||
numericFields | array<object> | No | List of numerical field definitions. | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
stringFields | array<object> | No | List of string field definitions. | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
Response example
{
"customLogDefinitionId": "alcohol_test_result",
"dataStoreConfiguration": {
"bulkDataLabel": "",
"moduleInstanceId": "/alcoholTest/logs",
"moduleType": "home_app_proxy"
},
"displayName": "Alcohol Test Result",
"numericFields": [
{
"displayName": "Value",
"name": "value",
"unit": "mg/L"
}
],
"stringFields": [
{
"displayName": "Alcohol tester model name",
"name": "tester_model"
},
{
"displayName": "Result code",
"enumDefinitions": [
{
"name": "Negative",
"value": "000"
},
{
"name": "Positive",
"value": "100"
},
{
"name": "Sensor Failure",
"value": "999"
}
],
"name": "result_code"
}
]
}401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
404 The requested customLog does not exist or is not accessible.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |