Job Status
The Job Status API allows you to monitor the progress of your bulk operations on entries and assets. This functionality helps tracking the status of jobs, offering comprehensive details about the job's execution and the items present in the job, including nested references. Read more about Nested Reference Publishing.
Get job status
GET
https://api.contentstack.io/v3/bulk/jobs/{job_id}The Get job status request returns comprehensive information of a specific publish/unpublish operation.
NotePass api_version parameter as 3.2 in the Headers section.
Sample Response
Status|200 OK
{
"uid": "e******6-1**a-4**4-8**4-0**********7",
"created_by": "blte*************61",
"updated_by": "",
"created_at": "2024-07-01T05:22:32.475Z",
"updated_at": "2024-07-01T05:22:34.051Z",
"action": "publish",
"api_key": "blt**************0d",
"status": "complete",
"body": {
"branch": "main",
"locales": [
"en-us"
],
"environments": [
"blt6************ce"
],
"published_at": "2024-07-01T05:22:34.051Z",
"scheduled_at": ""
},
"summary": {
"approvals": 0,
"skip": 2,
"state": "completed",
"success": 25,
"total_processed": 29,
"unsuccess": 2
}
}Get job items status
GET
https://api.contentstack.io/v3/bulk/jobs/{job_id}/items?include_count={boolean_value}&type={type_value}&skip={skip_value}&limit={limit_value}&status={status_value}&ct[]={content_type_uid}&include_reference={boolean_value}The Get job items status request retrieves all the details of the items associated with a specific publish/unpublish job, along with their status.
Note
- Pass api_version parameter as 3.2 in the Headers section.
- The include_count query parameter will return the count only if skip is 0 or the value for skip is not provided.
- The item status API request returns only the first 100 items. If you want to fetch the details other than the first 100 in your response, refer to the Pagination section to retrieve data for all items in paginated form.
Sample Response
Status|200 OK
{
"items": [
{
"uid": "bltfc507bd97607bb5b",
"locale": "",
"version": 1,
"title": "Charles_Dickens_Headshot.jpg",
"type": "asset",
"publish_details": {
"status": "success"
},
"publish_locale": "en-us",
"environment": "blt6c683aa0c6be0dce",
"action": "publish",
"published_at": "2024-07-01T05:22:33.931Z",
"scheduled_at": "",
"user": "blte93d4119f79db761",
"depth": 4
},
{
"uid": "blt212c614af8c395cc",
"locale": "en-us",
"version": 2,
"title": "Mark Twain",
"type": "entry",
"publish_details": {
"status": "failed",
"failure_reason": "The entry you want to publish is in-progress. Please fill mandatory fields."
},
"publish_locale": "en-us",
"environment": "blt6c683aa0c6be0dce",
"action": "publish",
"published_at": null,
"scheduled_at": "",
"user": "blte93d4119f79db761",
"depth": 2,
"content_type": {
"uid": "author"
}
},
],
"skip": 0,
"limit": 100,
"total_count": 29
}Get Stack Bulk Task Queue
GET
https://api.contentstack.io/v3/bulk/jobsThe Get Stack Bulk Task Queue request retrieves a list of all the bulk actions performed on entries and assets within a stack.
Sample Response
Status|200 OK
{
"jobItems": [
{
"_id": "66cc68f89e393ee4e7dd1fc2",
"action": "publish",
"job_id": "cs-41e64add-001c-4a34-b841-c017b6a4a993",
"uid": "blt45b6d47d9a1e8824",
"content_type_uid": "ct_1",
"title": "Test_RD",
"locale": "en-us",
"reference": true,
"version": 3,
"created_at": "2024-08-26T11:37:28.851Z",
"updated_at": "2024-08-26T11:37:28.851Z"
},
{
"_id": "66cc68f89e393ee4e7dd1fc3",
"action": "publish",
"job_id": "cs-41e64add-001c-4a34-b841-c017b6a4a993",
"uid": "blta38419e21c526e4d",
"content_type_uid": "ct_1",
"title": "dascs v2",
"locale": "en-us",
"reference": true,
"version": 2,
"created_at": "2024-08-26T11:37:28.851Z",
"updated_at": "2024-08-26T11:37:28.851Z"
},
{
"_id": "66cc68f89e393ee4e7dd1fc5",
"action": "publish",
"job_id": "cs-41e64add-001c-4a34-b841-c017b6a4a993",
"uid": "blt26eef6d406118a1f",
"content_type_uid": "sys_assets",
"title": "beautiful-peacock-feathers.jpg",
"locale": "en-us",
"version": 1,
"created_at": "2024-08-26T11:37:28.884Z",
"updated_at": "2024-08-26T11:37:28.884Z"
},
{
"errors": [
{
"path": "uid",
"errorKey": "This item has already been added to the release"
}
],
"_id": "66cc68f89e393ee4e7dd1fc6",
"action": "publish",
"job_id": "cs-41e64add-001c-4a34-b841-c017b6a4a993",
"uid": "blta38419e21c526e4d",
"content_type_uid": "ct_1",
"title": "dascs v2",
"locale": "en-us",
"version": 2,
"created_at": "2024-08-26T11:37:28.884Z",
"updated_at": "2024-08-26T11:37:28.951Z",
"errored": true
}
]
}