Fetch files from collection or bundle

GET metadata for files by collection or bundle ID

get/files

Request

  • Base URL
    http://localhost:26900
  • Auth
    API key in header Authorization

Query parameters

collection_idstring

ID of the collection to retrieve files for

bundle_idstring

ID of the bundle to retrieve files for

Response

Collection of file metadata

countinteger

Number of items returned

limitinteger

Number of items requested

offsetinteger

Start point

total_countinteger

total number of items available

Example response

{
  "count": 10,
  "limit": 10,
  "total_count": 100,
  "items": [
    {
      "path": "images/meme.jpg",
      "is_publishable": true,
      "collection_id": "1234-asdfg-54321-qwerty",
      "bundle_id": "bundle-789-xyz",
      "title": "The latest Meme",
      "size_in_bytes": 14794,
      "type": "image/jpeg",
      "licence": "OGL v3",
      "licence_url": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
      "etag": "1234567890asdfghjk",
      "state": "UPLOADED",
      "content_item": {
        "dataset_id": "cpih01",
        "edition": "time-series",
        "version": "1"
      }
    }
  ]
}

Changes

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