Retrieve batch file upload status
GET /v2/batches/<batchRef>
Retrieves the current upload status of the batch file that you started uploading.
We recommend that you verify that the file upload status was successful before uploading the next file. This can save you from having to upload files again if you didn't check their status and realize they failed due to a formatting issue or other error.
In the response, if the status is error, the status object contains a log key. The log key contains the URI of the error log. You use the URI of the error log to troubleshoot the upload process by retrieving the error log.
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string |
The UUID of the batch upload. Use the same UUID you generated when you allocated a batch upload location. |
|
The response body can contain the following fields:
|
Attribute |
Description |
Type |
|---|---|---|
|
|
Echo back of the URL used in this request. |
string |
|
|
UUID of the batch, forms part of the href. |
string |
|
|
Echo back of checksum of the uploading file. |
string |
|
|
Echo back of the size of the uploading file. |
integer |
|
|
Details of the file upload location. |
object |
|
|
The allocated URL to which you upload the batch file. This URL is valid for one hour. |
string |
|
|
Date and time that the upload location href expires. |
date time |
|
|
The status of the file upload. |
object |
|
|
The batch file processing status. Possible values:
|
string |
|
|
If the batch upload request contains errors, the location of the log file that includes details of the errors. |
string |
|
|
Contains a summary of statistics on the file upload. |
object |
|
|
The amount of time, in milliseconds, that the batch import job took to run. |
integer |
|
|
The total number of records read from the import file by the batch import job. |
integer |
|
|
The number of records that the batch import job successfully processed. |
integer |
|
|
The number of records that the batch import job failed to process. |
integer |
|
|
Date and time the request was created. |
date time |
|
|
Date and time the request was last updated. |
date time |
curl -X GET '<baseURL>/v2/batches/12af3453-62da-4b31-a646-631b7b5f3009' \
-u '<username>:<password>' \
-H 'Accept: application/json'
Status: uploading:
{
"href": "<baseURL>/v2/batches/12af3453-62da-4b31-b646-631b7b5f3009",
"ref": "12af3453-62da-4b31-b646-631b7b5f3009",
"checksum": "b1d600dbf7463924e24647e626cd7c1e",
"size": 227,
"location": {
"href": "https://sitecore-batch-service-production-eu-west-1.s3.eu-west-1.amazonaws.com/pqsTELpfrXBzxKozB0IoL4xuAT0s7WrH/12af3453-62da-4b31-b646-631b7b5f3009/import.gz?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDAaCWV1LXdlc3QtMSJIMEYCIQCvLllsVnScVKunabp2ecWZ35wWC2qazGUOH38uZ4ebNwIhAPhKsvrNikvkBSJwFo4Heat72zODcLQCPzh87PRThE8qKtUECIn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMNDkzNDAzOTY5MDY2IgzaKR3yFcEnGvR0NjEqqQQiccx7113xYh5boBVgjPQrzpcCLKgXi563nzp0YRIM52WE1LFEezlLQBEcRl9wo0i5ko5%2F8ne%2BPSFGxkc576fPqkdQzQyX9Ub1PA44pwuFzK%2FZSf9mHS7FRqPvvuxlm7srdkceEJK2VAmoUehfKHzDYhtCkPnZyElYwyeZAK7i6QY8u3WqGVIeGiObjZbhB2Ppq9wwSgfbaz5bUpKPwi6%2F3HRzV60gTURhO%2BOJOrxiuTjF6SKm586HQQizeGKWHlOiJghgO22gaqDlowHDMWuCjkPyk%2Fac1LTXNPFnUlQnbMwnvt7iXSRq6BrpZ7hlxxKZrjLT%2Bb35k4BExmE4XnXS%2BeWiSwNmz74xYtGwBzBjDYJL5KQPJBf%2FmmUqRgCV4xex7f8qtp34F4nLcXC0pRxggkSBBSxm214ubh9j7JZYz5QY8KuGDC9pn%2FeNeqFHaS4B%2FKtkNKzU6YyFmQdiXgFMpK22TpKvDQbeX5%2Bazx2lCqBuIR2MSg8xaVxfVOm14tu0WrqIY8luKV9Vpl23LWs713xhg80XwjkUb1nCOu57Lu0hOODrq1lr21CmJWnU7pttLa6fgT2Sineu%2BwkXeTQuVVBfYOw%2BQgyu6yX7hSkskKFMJPSSvSDgcx%2B0z7ze%2F6wwDfc2j94FtriCv77t7RIN1UQYi4%2FWT%2BH1UtqoHEjwf%2B4WUV4sGnzYnWVVNS9D%2FDuhfIcxMtX%2FeC6GY2xl3DaoInj4Dpn%2F%2B%2B%2BDMJy29J0GOqgBLYwZ%2BS6LeU8LGjYX9awM1lZICDgrQ0hlOV350Z6dYGfgRriIVxT3a1tcWbIoa3i2xkJhWKoJlEjgplRBSMEKhYaLbb9OQjKayNjAfDHGNDGr3%2FeGWuhg7SXAXHa1fs1%2BDqeErCylLFgS3TzFH2D7uTNCiSa6z2QS47PQ5lCYhjWqx9odsrCOmAKTrg23disfNZOaHKnlZaug2Yn7zDgbNneWs%2FKjX5GX&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230110T083848Z&X-Amz-SignedHeaders=content-md5%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=3600&X-Amz-Credential=ASIAXFYJLCYVPNLGNNGA%2F20230110%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=00adb6369887346dafc2fdce630f1527ab9482fb2307c921d2850b0d09c0aace",
"expiry": "2024-01-10T09:38:48.910Z"
},
"status": {
"code": "uploading"
},
"createdAt": "2024-01-10T08:38:48.910Z",
"modifiedAt": "2024-01-10T08:38:49.000Z"
}
Status: error:
{
"href":"<baseURL>/v2/batches/3ee694e5-0b77-2d1e-af19-1aa78f500785",
"ref":"3ee694e5-0b77-2d1e-af19-1aa78f500785",
"checksum":"40d9a12f0a3c93c8ed66a3b6f3735790",
"size":3456,
"location":{
"href":"https://sitecore-batch-service-dev-eu-west-1.s3.amazonaws.com/xyzsla2xze5vxn02kf283wo020jg/3ee694e5-0b77-2d1e-af19-1aa78f500785/import.gz?AWSAccessKeyId=AKIAI2JLVI7OT2L6QDRQ&Expires=1459953714&Signature=yIG7nFv5w%2B2N%2Fkz11Eh7BjqSt2U%3D",
"expiry":"2024-04-24T09:33:00.770Z"
},
"status":{
"code":"error",
"log":"https://sitecore-batch-service-dev-eu-west-1.s3.amazonaws.com/xyzsla2xze5vxn02kf283wo020jg/3ee694e5-0b77-2d1e-af19-1aa78f500785/import.gz?AWSAccessKeyId=AKIAI2JLVI7OT2L6QDRQ&Expires=1459953714&Signature=yIG7nFv5w%2B2N%2Fkz11Eh7BjqSt2U%3D"
},
"summaryStats":{
"timeToProcessMillis":614867,
"totalCount":121776,
"succeededCount":121460,
"failedCount":316
},
"createdAt":"2024-04-24T08:33:00.770Z",
"modifiedAt":"2024-04-24T08:46:04.000Z"
}