# Get batch
This endpoint cancels a given batch.
| Method | Path | Operation* |
|---|---|---|
| GET | /batches/{batch} | get_batch |
*
In order for a user to perform the "get_batch" operation, the "get_batch" permission must be included in the list of allowed actions in the statement of the user's role.
# Request
| Parameter | Type | In | Description |
|---|---|---|---|
| {batch} required | string | Batch UUID. | |
| download optional * | boolean, DEFAULT=False | query string | Denotes whether to return a download URL or not. The download URL is a temporary URL allowing to download the results of the individual operations of the given batch. |
# Response
| Attribute | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| batch | string | Batch UUID. | |||||||||
| created_ts | timestamp | Time at which the batch was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). | |||||||||
| status | string, value can be "new", "copying", "copied", "hash_mismatch", "validating", "validation_failed", "processing", "processed", "writing_results", "cancel", "cancelling", "cancelled", "deleting", "completed" | Status of the batch. For more details, see the Batch statuses section. | |||||||||
| updated_ts | timestamp | Time at which the batch was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). | |||||||||
| hash * | string | SHA-256 hash(opens new window). | |||||||||
| download ** | dictionary | Holds the temporary download URL and the validity of the download URL.
|
*
The "hash" attribute is returned only if it was provided in the request to the create_batch endpoint.
*
The "download" attribute is returned only if the parameter "download" was provided in the query string of the request.
# Status codes
Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.
Was this article helpful?