Task Progress API
Jan 1 2022 at 12:00 AM
The Task Progress API is used as a progress logging tool to keep track of long running background tasks. The developer may include this API to create and log the progress of tasks. The user may keep track of task progress using the Portal UI’s Task Manager.
Developer may include this api to create and log progress of tasks. User may keep track of task progress using Commander Portal’s Task Manager.
APIs within Task Progress API
TaskProgress
API Calls
Get
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/Get
URL Params
None
Data Params
{
"taskProgressIds": ["Guid", "Guid"]
}
- taskPogressIds: Guid[] (required)
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
GetActive
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/GetActive
URL Params
None
Data Params
None
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
GetNextActive
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/GetNextActive
URL Params
None
Data Params
{
"taskProgressId": "Guid"
}
- taskProgressId: Guid (required)
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
GetLogsFor
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/GetLogsFor
URL Params
None
Data Params
{
"searchFilter": {
"TaskProgressId": "Guid",
"SubTaskProgressId": "string",
"Type": "string",
"Limit": "int",
"Skip": "int"
}
}
- searchFilter: LogEntrySearchFilter (required where Limit and Skip are 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
GetProgressFor
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/GetProgressFor
URL Params
None
Data Params
{
"taskProgressIds": ["Guid", "Guid"]
}
- taskProgressIds: Guid[] (required)
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
Acknowledge
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/Acknowledge
URL Params
None
Data Params
{
"taskProgressId": "Guid"
}
- taskProgressId: Guid (required)
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
ExecuteAction
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/ExecuteAction
URL Params
None
Data Params
{
"taskProgressId": "Guid",
"uiAction": "string"
}
- taskProgressId: Guid (required)
- uiAction: string (required)
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
SubscribeToNotifications
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/SubscribeToNotifications
URL Params
None
Data Params
None
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
UnsubscribeFromNotifications
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/TaskProgress/UnsubscribeToNotifications
URL Params
None
Data Params
None
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