GET /asset_model/asset_bulk_tasks/{id}
Retrieves the current status of a bulk asset operation task by ID.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
id |
path |
Required |
String |
text/plain |
null |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The asset bulk task was retrieved successfully. |
|
404 |
1001 |
The specified task ID does not exist or has expired. |
500 |
1002 |
An error occurred while retrieving the task status. |
Response Description
The Asset bulk task.
An Asset bulk task contains the following fields:
- id - String - The ID of the bulk task.
- status - Enum - Indicates the status of the bulk task. Possible values are: IN_PROGRESS, COMPLETED_SUCCESSFULLY, COMPLETED_WITH_ERRORS.
- operation_statuses - Array - An array of operation status objects, one per
asset entry submitted in the original PATCH request. The size and order of this array
matches the input list. Each element contains:
- asset_id - Long - The asset ID. For successful CREATE operations this is the newly assigned asset ID. For DELETE operations this is the ID of the deleted asset. This will be null until the operation completes.
- operation_type - Enum - The type of operation. Possible values are: CREATE, DELETE.
- http_status - Integer - The HTTP status of the operation. This will be null until the operation completes.
Typical values:
- 201 — Asset created successfully.
- 200 — Asset is reconciled with existing asset.
- 204 — Asset deleted successfully.
- 404 — Asset not found (DELETE only).
- 422 — Unprocessable entity (e.g. invalid IP address format, invalid domain, invalid request parameters).
- 500 — Internal server error.
- message - String - Description of the operation result. Set for both success and failure outcomes. This will be null until the operation completes.
- unique_code - Integer - The unique error code. This will only be set if the operation fails, otherwise it will be null.
Note: To check task completion status, it is recommended to poll this endpoint at intervals of at least 5 seconds.
Response Sample
{
"id": "String",
"operation_statuses": [
{
"asset_id": 42,
"http_status": 42,
"message": "String",
"operation_type": "String <one of: CREATE, DELETE>",
"unique_code": 42
}
],
"status": "String <one of: IN_PROGRESS, COMPLETED_SUCCESSFULLY, COMPLETED_WITH_ERRORS>"
}