An object containing error codes related to API call validation issues.

Enumeration Members

CANCEL_CMD_ID_REQUIRES_NODE_ID CANCEL_MISSING_REQUIRED_PARAM COMMAND_DATA_TOO_LARGE DEVICE_LIST_REFRESH_REQUIRED DUPLICATE_COMMAND_NODE_IDS FILE_TOO_LARGE INVALID_ASSUME_ROLE_GROUP_IDS_COUNT INVALID_ASSUME_ROLE_NODE_IDS_COUNT INVALID_ASSUME_ROLE_PARAMS INVALID_ASSUME_ROLE_USER_ROLE INVALID_COMMAND_ID INVALID_COMMAND_NODE_IDS INVALID_COMMAND_TIMEOUT INVALID_EVENT_TYPE INVALID_FILE_NAME INVALID_GEO_COORDINATES INVALID_NODE_REFERENCE INVALID_PARAMETER_VALUE INVALID_SIMPLE_TS_PARAMETER INVALID_TIMEZONE_FORMAT INVALID_TS_AGGREGATION INVALID_TS_AGGREGATION_INTERVAL INVALID_TS_DATA_TYPE INVALID_TS_DIFFERENTIAL INVALID_TS_INTERVAL INVALID_TS_PARAMETER INVALID_TS_PARAMETER_MIXED INVALID_TS_RESET_ON_NEGATIVE INVALID_TS_RESULT_COUNT INVALID_TS_TIME_RANGE INVALID_TS_TIMESTAMP INVALID_TS_TIMEZONE INVALID_TS_WEEK_START MISSING_ASSUME_ROLE_NODE_IDS_FOR_VIDEOSTREAM MISSING_AUTH_URL MISSING_AUTOMATION_ACTIONS MISSING_AUTOMATION_EVENTS MISSING_AUTOMATION_ID MISSING_AUTOMATION_NAME MISSING_AUTOMATION_UPDATE_DETAILS MISSING_BASE_URL MISSING_CLIENT_ID MISSING_CUSTOM_PARAM_DATA_TYPE MISSING_CUSTOM_PARAM_NAME MISSING_DELETE_ENDPOINT_PARAMS MISSING_FILE_ENTITY_ID MISSING_FILE_ENTITY_TYPE MISSING_FILE_NAME MISSING_GEO_COORDINATES MISSING_GROUP_ID MISSING_GROUP_NAME MISSING_GROUP_UPDATE_INFO MISSING_IDENTITY_PROVIDER MISSING_LATITUDE MISSING_LONGITUDE MISSING_NODE_ID MISSING_NODE_LIST MISSING_OAUTH_ADAPTER MISSING_OAUTH_CODE MISSING_OTA_JOB_ID MISSING_REDIRECT_URL MISSING_SECRET_KEY MISSING_TS_AGGREGATION_INTERVAL MISSING_TS_TIMESTAMP NODE_UNREACHABLE TIME_SERVICE_NOT_AVAILABLE TIMEZONE_PARAM_NOT_AVAILABLE

Enumeration Members

CANCEL_CMD_ID_REQUIRES_NODE_ID: "CANCEL_CMD_ID_REQUIRES_NODE_ID"

Error code when cmdId is provided without nodeId for cancel.

CANCEL_MISSING_REQUIRED_PARAM: "CANCEL_MISSING_REQUIRED_PARAM"

Error code when neither requestId nor nodeId is provided for cancel.

COMMAND_DATA_TOO_LARGE: "COMMAND_DATA_TOO_LARGE"

Error code indicating command data exceeds 64KB.

DEVICE_LIST_REFRESH_REQUIRED: "DEVICE_LIST_REFRESH_REQUIRED"

Error code indicating the device list refresh is required.

DUPLICATE_COMMAND_NODE_IDS: "DUPLICATE_COMMAND_NODE_IDS"

Error code indicating duplicate node_ids in send command request.

FILE_TOO_LARGE: "FILE_TOO_LARGE"

Error code indicating the file content exceeds the maximum size.

INVALID_ASSUME_ROLE_GROUP_IDS_COUNT: "INVALID_ASSUME_ROLE_GROUP_IDS_COUNT"

Error code indicating that the number of group IDs exceeds the maximum allowed.

INVALID_ASSUME_ROLE_NODE_IDS_COUNT: "INVALID_ASSUME_ROLE_NODE_IDS_COUNT"

Error code indicating that the number of node IDs exceeds the maximum allowed.

INVALID_ASSUME_ROLE_PARAMS: "INVALID_ASSUME_ROLE_PARAMS"

Error code indicating that both group_ids and node_ids are provided when only one is allowed.

INVALID_ASSUME_ROLE_USER_ROLE: "INVALID_ASSUME_ROLE_USER_ROLE"

Error code indicating that an invalid user role was provided.

INVALID_COMMAND_ID: "INVALID_COMMAND_ID"

Error code indicating invalid command ID (must be 0–65535).

INVALID_COMMAND_NODE_IDS: "INVALID_COMMAND_NODE_IDS"

Error code indicating invalid node_ids count for send command (1–25).

INVALID_COMMAND_TIMEOUT: "INVALID_COMMAND_TIMEOUT"

Error code indicating invalid command timeout (-1 or 1–2592000).

INVALID_EVENT_TYPE: "INVALID_EVENT_TYPE"

Error code indicating invalid event type.

INVALID_FILE_NAME: "INVALID_FILE_NAME"

Error code indicating the file name length is invalid.

INVALID_GEO_COORDINATES: "INVALID_GEO_COORDINATES"

Error code indicating the geo coordinates are invalid.

INVALID_NODE_REFERENCE: "INVALID_NODE_REFERENCE"

Error code indicating the node reference is no longer valid.

INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE"

Error code indicating invalid parameter value.

INVALID_SIMPLE_TS_PARAMETER: "INVALID_SIMPLE_TS_PARAMETER"

Error code indicating the parameter does not support simple time series data.

INVALID_TIMEZONE_FORMAT: "INVALID_TIMEZONE_FORMAT"

Error code indicating the timezone string format is invalid.

INVALID_TS_AGGREGATION: "INVALID_TS_AGGREGATION"

Error code indicating invalid aggregation method in time series request.

INVALID_TS_AGGREGATION_INTERVAL: "INVALID_TS_AGGREGATION_INTERVAL"

Error code indicating invalid aggregation interval in time series request.

INVALID_TS_DATA_TYPE: "INVALID_TS_DATA_TYPE"

Error code indicating invalid data type for time series data.

INVALID_TS_DIFFERENTIAL: "INVALID_TS_DIFFERENTIAL"

Error code indicating invalid differential configuration in time series request.

INVALID_TS_INTERVAL: "INVALID_TS_INTERVAL"

Error code indicating invalid time interval in time series request.

INVALID_TS_PARAMETER: "INVALID_TS_PARAMETER"

Error code indicating the parameter does not support time series data.

INVALID_TS_PARAMETER_MIXED: "INVALID_TS_PARAMETER_MIXED"

Error code indicating both numIntervals and startTime/endTime are provided.

INVALID_TS_RESET_ON_NEGATIVE: "INVALID_TS_RESET_ON_NEGATIVE"

Error code indicating invalid reset on negative configuration in time series request.

INVALID_TS_RESULT_COUNT: "INVALID_TS_RESULT_COUNT"

Error code indicating invalid result count in time series request.

INVALID_TS_TIME_RANGE: "INVALID_TS_TIME_RANGE"

Error code indicating invalid time range in time series request.

INVALID_TS_TIMESTAMP: "INVALID_TS_TIMESTAMP"

Error code indicating invalid timestamp in time series request.

INVALID_TS_TIMEZONE: "INVALID_TS_TIMEZONE"

Error code indicating invalid timezone in time series request.

INVALID_TS_WEEK_START: "INVALID_TS_WEEK_START"

Error code indicating invalid week start in time series request.

MISSING_ASSUME_ROLE_NODE_IDS_FOR_VIDEOSTREAM: "MISSING_ASSUME_ROLE_NODE_IDS_FOR_VIDEOSTREAM"

Error code indicating that node_ids is required for videostream role.

MISSING_AUTH_URL: "MISSING_AUTH_URL"

Error code indicating the auth URL is missing.

MISSING_AUTOMATION_ACTIONS: "MISSING_AUTOMATION_ACTIONS"

Error code indicating the automation actions are missing.

MISSING_AUTOMATION_EVENTS: "MISSING_AUTOMATION_EVENTS"

Error code indicating the automation events are missing.

MISSING_AUTOMATION_ID: "MISSING_AUTOMATION_ID"

Error code indicating the automation ID is missing.

MISSING_AUTOMATION_NAME: "MISSING_AUTOMATION_NAME"

Error code indicating the automation name is missing.

MISSING_AUTOMATION_UPDATE_DETAILS: "MISSING_AUTOMATION_UPDATE_DETAILS"

Error code indicating the automation update details are missing.

MISSING_BASE_URL: "MISSING_BASE_URL"

Error code indicating the base URL is missing.

MISSING_CLIENT_ID: "MISSING_CLIENT_ID"

Error code indicating the client ID is missing.

MISSING_CUSTOM_PARAM_DATA_TYPE: "MISSING_CUSTOM_PARAM_DATA_TYPE"

Error code indicating the custom parameter data type is missing.

MISSING_CUSTOM_PARAM_NAME: "MISSING_CUSTOM_PARAM_NAME"

Error code indicating the custom parameter name is missing.

MISSING_DELETE_ENDPOINT_PARAMS: "MISSING_DELETE_ENDPOINT_PARAMS"

Error code indicating the delete endpoint parameters are missing.

MISSING_FILE_ENTITY_ID: "MISSING_FILE_ENTITY_ID"

Error code indicating the entity id is missing for ota_image uploads.

MISSING_FILE_ENTITY_TYPE: "MISSING_FILE_ENTITY_TYPE"

Error code indicating the entity type is missing.

MISSING_FILE_NAME: "MISSING_FILE_NAME"

Error code indicating the file name is missing.

MISSING_GEO_COORDINATES: "MISSING_GEO_COORDINATES"

Error code indicating the geo coordinates are missing.

MISSING_GROUP_ID: "MISSING_GROUP_ID"

Error code indicating the group ID is missing.

MISSING_GROUP_NAME: "MISSING_GROUP_NAME"

Error code indicating the group name is missing.

MISSING_GROUP_UPDATE_INFO: "MISSING_GROUP_UPDATE_INFO"

Error code indicating the group update info is missing.

MISSING_IDENTITY_PROVIDER: "MISSING_IDENTITY_PROVIDER"

Error code indicating the identity provider is missing.

MISSING_LATITUDE: "MISSING_LATITUDE"

Error code indicating the latitude is missing.

MISSING_LONGITUDE: "MISSING_LONGITUDE"

Error code indicating the longitude is missing.

MISSING_NODE_ID: "MISSING_NODE_ID"

Error code indicating the node ID is missing.

MISSING_NODE_LIST: "MISSING_NODE_LIST"

Error code indicating the node list is missing.

MISSING_OAUTH_ADAPTER: "MISSING_OAUTH_ADAPTER"

Error code indicating the oauth adapter is missing.

MISSING_OAUTH_CODE: "MISSING_OAUTH_CODE"

Error code indicating the oauth code is missing.

MISSING_OTA_JOB_ID: "MISSING_OTA_JOB_ID"

Error code indicating the OTA job ID is missing.

MISSING_REDIRECT_URL: "MISSING_REDIRECT_URL"

Error code indicating the redirect URL is missing.

MISSING_SECRET_KEY: "MISSING_SECRET_KEY"

Error code indicating the secret key is missing.

MISSING_TS_AGGREGATION_INTERVAL: "MISSING_TS_AGGREGATION_INTERVAL"

Error code indicating missing aggregation interval in time series request when aggregate is provided.

MISSING_TS_TIMESTAMP: "MISSING_TS_TIMESTAMP"

Error code indicating missing timestamp in time series request.

NODE_UNREACHABLE: "NODE_UNREACHABLE"

Error code indicating the node is unreachable.

TIME_SERVICE_NOT_AVAILABLE: "TIME_SERVICE_NOT_AVAILABLE"

Error code indicating the time service is not available.

TIMEZONE_PARAM_NOT_AVAILABLE: "TIMEZONE_PARAM_NOT_AVAILABLE"

Error code indicating the timezone parameter is not available.