Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Tasks

Get task details

Returns the status and additional information about a particular task using the Task ID.

get/msp/v2/tasks/{taskID}

Path parameters

taskIDstring required

Specify the unique ID of the task for which you want to know the current status. Task ID is received in response to the API calls made to Create a Customer, Create a Tenant, and so on.

Headers

Authorizationstring required

Specify the Bearer access token

Response

Ok

idstring

The unique ID of the task. Example - 'c8b54819-486a-497a-b86e-5b93f2422711'

namestring

The name of the task for which this activity was initiated. Example - 'customerCreate'

entityTypestring
  • The entity type of the task. Example - 'MSP'
  • This field contains information to be consumed by MSP services, caller should not interpret, use or depend on its presence in response.
entityIdstring
  • The unique entity ID of the task. Example - MSP:25a2d3d0-3e17-40f4-945e-66fff6c6e853
  • This field contains information to be consumed by MSP services, caller should not interpret, use or depend on its presence in response.
statusinteger
  • The status of the task.
    • 1 - Queued
    • 2 - InProgress
    • 3 - Paused
    • 4 - Finished
createdOnstring date-time

The date and time on which the MSP task was created. Example - '2022-10-15T00:00:00Z'

updatedOnstring date-time

The date and time on which the MSP task was last updated. Example - '2022-10-15T00:00:00Z'

Example response

{
  "id": "c8b54819-486a-497a-b86e-5b93f2422711",
  "name": "customerCreate",
  "entityType": "MSP",
  "entityId": "MSP:25a2d3d0-3e17-40f4-945e-66fff6c6e853",
  "status": 4,
  "output": {
    "successResp": {
      "entityId": "1e9b6464-69ac-47d8-b97b-7f595d47504c"
    },
    "errorResp": {
      "code": 2304,
      "message": "Customer name already exists"
    }
  },
  "createdOn": "2022-10-25T00:00:00Z",
  "updatedOn": "2022-10-25T00:00:00Z"
}