UKuk-hydrographic-office

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}

Request

  • Base URL
    http://fss.ukho.gov.uk
  • Auth
    HTTP bearer

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"

Changes

No recorded changes to this operation across all 1 revision of this API.