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

NameTypeRequiredConstraintsDescription
projectIdintegerYesThe unique ID for a specified project.
entityIdstringYesEntity ID (unique within project)
customLogDefinitionIdstringYesCustom log definition ID (unique within entity class).

Responses

200 Successful retrieval of custom log definition.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
customLogDefinitionIdstringNoID of the custom log definition. Must be unique within an Entity Class.
dataStoreConfigurationobjectNoData store configuration of custom log.
Properties of dataStoreConfiguration
PropertyTypeRequiredConstraintsDescription
bulkDataLabelstringNoUnused in this context (leave empty).
cldsConfigobjectNoCLDS configuration. Required only if module type is 'clds'.
Properties of cldsConfig
PropertyTypeRequiredConstraintsDescription
collectionNamestringNoCLDS Log Collection Name. Required only if module type is 'clds'.
moduleInstanceIdstringNoHome App Proxy source path. Required only if module type is 'home_app_proxy'.
moduleTypestringNoone of: clds, home_app_proxyModule type, either 'clds' or 'home_app_proxy'.
displayNamestringNoThe display name of the custom log definition.
numericFieldsarray<object>NoList of numerical field definitions.
Properties of numericFields
PropertyTypeRequiredConstraintsDescription
displayNamestringNoThe display name of the field.
namestringNoThe name of the field.
rangeobjectNoThe range of the field's values.
Properties of range
PropertyTypeRequiredConstraintsDescription
maxnumberNoThe maximum value.
minnumberNoThe minimum value.
unitstringNoThe unit of measure.
stringFieldsarray<object>NoList of string field definitions.
Properties of stringFields
PropertyTypeRequiredConstraintsDescription
displayNamestringNoThe display name of the field
enumDefinitionsarray<object>Noread-only (server-generated)The enumerated human-readable values for the field value
Properties of enumDefinitions
PropertyTypeRequiredConstraintsDescription
namestringNoThe human-readable value for the field value
valuestringNoA field value
namestringNoThe name of the field.

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

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

404 The requested customLog does not exist or is not accessible.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.