Exporter Status API
Jan 1 2022 at 12:00 AM
The Exporter Status API is used to send information about the data being exported to be displayed on the front-end. This information can either be Endpoint- or AlarmLogs data. Errors will also be passed through this API.
APIs within Exporter Status API
ExporterStatusAPI
API Calls
SubscribeToExporterEvents
Permission
exporter_health:get
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/ExporterStatusApi/SubscribeToExporterEvents
URL Params
None
Data Params
Example:
{
"exporterInstanceId":"af2b4d55-e618-4832-ab01-53563566d695"
}
- exporterInstanceId: 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
UnsubscribeFromExporterEvents
Permission
exporter_health:get
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/ExporterStatusApi/UnsubscribeFromExporterEvents
URL Params
None
Data Params
Example:
{
"exporterInstanceId":"af2b4d55-e618-4832-ab01-53563566d695"
}
- exporterInstanceId: 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