Get async task
The Get async task method is used with ordering a new subscription (see Create sales order) for checking the status of an asynchronous task of the current reseller or any of its downstream resellers. An asynchronous task is used to validate the values of additional attributes on the service side (see Validate order attributes of plan).
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
GET {base_url}/api/v3/resellers/{reseller_id}/async_tasks/{async_task_id}
Arguments
Name | Parameter Type | Data type | Required/Optional | Description | ||
---|---|---|---|---|---|---|
X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating manager's information) | ||
Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json | ||
Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json | ||
base_url | path | string | Required | ActivePlatform URL | ||
reseller_id | path | integer | Required | ID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information) | ||
async_task_id | path | integer | Required | ID of the asynchronous task |
Response model
Name | Data type | Description | ||||||
---|---|---|---|---|---|---|---|---|
data | object | Response data | ||||||
id | string | ID of the asynchronous task | ||||||
type | string | Data type | ||||||
attributes | object | Attributes of the asynchronous task | ||||||
status | string | Status of the asynchronous task:
| ||||||
failure_message | string | Error description — if the asynchronous task is failed due to an error on the platform side (status = failed ) | ||||||
results | object | Information about validation of additional attributes — if the asynchronous task is completed successfully (status = completed ) | ||||||
valid | bool | Validation result:
| ||||||
errors | array | List of keys of additional attributes and error descriptions — if any of additional attributes are not valid (valid = false ) | ||||||
application_attributes | object |
Request example
GET /api/v3/resellers/1/async_tasks/9b68427b-52d5-4c01-9b77-eb1b70517414
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Response example
{
"data":
{
"id": "9b68427b-52d5-4c01-9b77-eb1b70517414",
"type": "async_tasks",
"attributes":
{
"status": "completed",
"failure_message": "",
"results":
{
"valid": true,
"errors": [{}] ,
"application_attributes": {application_attributes}
}
}
}
}