---
title: "Get details of the batch including links to all the files in the batch."
method: GET
path: "/batch/{batchId}"
---

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

`GET /batch/{batchId}`

## Request

- Base URL: `http://fss.ukho.gov.uk`
- URL: `http://fss.ukho.gov.uk/batch/{batchId}`
- Auth: HTTP bearer

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

## Path parameters

- `batchId` string, GUID, required

## Response `200`

OK - Return details about the batch.

- BatchDetails: Object representing the details of a batch.
  - `batchId` string, GUID
  - `status` 'Incomplete' | 'CommitInProgress' | 'Committed' | 'Rolledback' | 'Failed'
  - `allFilesZipSize` integer
  - `attributes` object[]
    - `key` string
    - `value` string
  - `businessUnit` string
  - `batchPublishedDate` string, date-time
  - `expiryDate` string, date-time
  - `isAllFilesZipAvailable` boolean: Indicates if the zip of all files in the batch is available. See "#/paths/batch/{batchId}/files"
  - `files` object[]
    - `filename` string
    - `fileSize` integer
    - `mimeType` string: The MIME content type of the file.
    - `hash` string, Base64: MD5 hash of the file content.
    - `attributes` object[]
      - `key` string
      - `value` string
    - `links` object: Contains links to the relevant APIs for this file.
      - `get` Link
        - `href` string, uri

## Other responses

- `400`: Bad request - could be an invalid batch ID format. Batch IDs should be a GUID. A valid GUID that doesn't match a batch ID will return status code 404 (Not Found).
- `401`: Unauthorised - either you have not provided any credentials, or your credentials are not recognised.
- `403`: Forbidden - you have been authorised, but you are not allowed to access this resource.
- `404`: Not Found - Could be that the batch ID doesn't exist.
- `410`: Gone - the specified batch has expired and is no longer available.
- `429`: You have sent too many requests in a given amount of time. Please back-off for the time in the Retry-After header (in seconds) and try again.

---

[API](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis.md) - [All operations](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis/revisions/31121f0e92c4?raw)