Endpoint Data API
Jan 1 2022 at 12:00 AM
This service is responsible for receiving Endpoint packets, processing them and storing them in hot storage and export storage and additionally processing collection packets and calculating their current state.
APIs within Endpoint Data API
EndpointData
API Calls
SendValue
Permission
ENTITIES_ENDPOINTS_SETVALUE
Accessible
All. See response and accessibility information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Endpoint/SendValue
URL Params
None
Data Params
{
"endpointId": "string",
"value": "object",
"expiresIn": "TimeSpan",
"durable": "bool"
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SubscribeToEndpoint
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Endpoint/SubscribeToEndpoint
URL Params
None
Data Params
{
"endpointId": "string"
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
UnsubscribeFromEndpoint
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Endpoint/UnsubscribeFromEndpoint
URL Params
None
Data Params
{
"endpointId": "string"
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetTimeValue
Permission
ENTITIES_GET on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetTimeValue
URL Params
None
Data Params
Example:
{
"entityId": "00000000-0000-0000-0000-000000000000",
"entryDateTime": "2018-11-20 08:00"
}
entityId: string
entityDateTime: string (YYYY-MM-DD HH:MM)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetDataUsingEntityId
Permission
entities.endpoints:get_value
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetDataUsingEntityId
URL Params
None
Data Params
Example:
{
"entityId": "string",
"startDate": "2018-11-20 08:00",
"endDate": "2018-11-20 08:00",
"lag": true ,
"lead": true
}
entityId: string
startDate: DateTime? (optional)
endDate: DateTime? (optional)
lag: bool (optional)
lead: bool (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetDataUsingEntityIds
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetDataUsingEntityIds
URL Params
None
Data Params
{
"entityIds": "string[]",
"startDate": "DateTime",
"endDate": "DateTime"
}
entityIds: string[]
startDate: DateTime (optional)
endDate: DateTime (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetTimeValues
Permission
entities.endpoints:get_value
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetTimeValues
URL Params
None
Data Params
Example:
{
"entityIds": {"string", "string"}
"entryDateTime": "2018-11-20 08:00"
}
entityIds: string[]
entryDateTime: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetCollectionReset
Permission
entities.endpoints:get_value on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetCollectionReset
URL Params
None
Data Params
Example:
{
"entityId": "string ",
"timestamp": "2018-11-20 08:00"
}
entityId: string
timestamp: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetCollectionValues
Permission
entities.endpoints:get_value on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetCollectionValues
URL Params
None
Data Params
Example:
{
"entityId": "string ",
"timestamp": "2018-11-20 08:00"
}
entityId: string
timestamp: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetCollectionHistory
Permission
entities.endpoints:get_value on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetCollectionHistory
URL Params
None
Data Params
Example:
{
"entityId": "string",
"fromTimestamp": "2018-11-20 08:00",
"toTimestamp": "2018-11-20 08:00"
}
entityId: string
fromTimestamp: DateTime? (optional)
toTimestamp: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetFilteredCollectionHistory
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetFilteredCollectionHistory
URL Params
None
Data Params
Example:
{
"entityId": "string",
"fromTimestamp": "DateTime",
"toTimestamp": "DateTime",
"propertyName": "string",
"propertyValue": "object
}
entityId: string
fromTimeStamp: DateTime (optional)
toTimestamp: DateTime (optional)
propertyName: string
propertyValue: object
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SetMetaData
Permission
entities.endpoints:set_value on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/SetMetadata
URL Params
None
Data Params
{
"entityId": "string",
"metadata": {JObject}
}
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetMetaData
Permission
entities.endpoints:get_value on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EndpointData/GetMetadata
URL Params
None
Data Params
Example:
{
"entityId": "string",
"entryDateTime": "2018-11-20 08:00"
}
entityId: string
entryDateTime: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SendEndpointNotification
Permission
ENTITIES_ENDPOINTS_PUBLISH on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Endpoint/SendEndpointNotification
URL Params
None
Data Params
Example:
{
"endpointId": "string",
"value": {object},
"timestamp": "2018-11-20 08:00"
}
endpointId: string
value: object
timestamp: DateTime? (optional)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SendEndpointNotifications
Permission
ENTITIES_GET on Endpoint Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Endpoint/SendEndpointNotifications
URL Params
None
Data Params
Example:
{
{
"gatewayNotifications":
{
"endpointId": "string",
"value": {object},
"timestamp": "2018-11-20 08:00"
}
}
}
- gatewayNotifications: List
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None