Update batch

This endpoint cancels a given batch.

Method	Path	Operation*
PATCH	/batches/{batch}	update_batch

*

In order for a user to perform the "update_batch" operation, the "update_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	path	Batch UUID.
status required	string, value is "cancel"	body	Status denoting that the batch should be cancelled.

Response

Attribute	Type	Description
batch	string	Batch UUID.
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.
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).
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).

*

The "hash" attribute is returned only if it was provided in the request to the create_batch endpoint.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.