Check Attribute Job Status
- DarkLight
Check Attribute Job Status
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows you to check the processing status of a bulk Attribute submission using the Job ID returned during submission.
Endpoint URL
api/v1/dataobjects/attributes/bulk/jobstatus/{job-id}
HTTP Method
GET
Request Body Structure
Not applicable.
Request Field Description
This table outlines the required fields for the API request, including their types, whether they are mandatory, and their descriptions.
Field Name | Data Type | Required | Description |
|---|---|---|---|
jobId | String | Yes | Unique identifier of the bulk attribute job. |
Sample Response
Success Response
{
"jobId": "777b971f-ad84-4d15-ae4e-578f4b562469",
"status": "success",
"summary": {
"totalEntitiesProcessed": 2,
"totalAttributesProcessed": 6,
"created": 3,
"updated": 1,
"deleted": 2,
"failed": 0
}
}
Partial Success Response
{
"jobId": "777b971f-ad84-4d15-ae4e-578f4b562469",
"status": "partial_success",
"summary": {
"totalEntitiesProcessed": 2,
"totalAttributesProcessed": 6,
"created": 2,
"updated": 1,
"deleted": 1,
"failed": 2
}
}
Error Response
{
"jobId": "777b971f-ad84-4d15-ae4e-578f4b562469",
"status": "error"
}
Response Field Description
This table outlines the response fields for the API request, including their types, whether they are, and their descriptions.
Field Name | Data Type | Description |
|---|---|---|
jobId | String | Unique identifier assigned to the bulk attribute operation. |
status | String | Final outcome of the request. Possible values: success, partial_success, error. |
summary | Object | Aggregated processing counts across all entities. |
results | Array | Contains per-entity and per-attribute processing details. |
Limit
No explicit limits are defined for this API. The frequency of status checks should be managed by the client.
Was this article helpful?