Sign in

v1

latestOpenAPI 3.0.1raw.githubusercontent.com2025-08-078639.0 KB

Get details of the batch including links to all the files in the batch.

This get will include full details of the batch, for example it's status, the files in the batch.

get/batch/{batchId}

Path parameters

batchIdstring GUID required

A Batch ID.

Response

OK - Return details about the batch.

batchIdstring GUID
status'Incomplete' | 'CommitInProgress' | 'Committed' | 'Rolledback' | 'Failed'
allFilesZipSizeinteger
businessUnitstring
batchPublishedDatestring date-time
expiryDatestring date-time
isAllFilesZipAvailableboolean

Indicates if the zip of all files in the batch is available. See "#/paths/batch/{batchId}/files"