v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-239817.3 KB
image

Get images filtered by collection id

Returns a list of images metadata filtered by an optional query parameter defining the collection ID

get/images

Query parameters

collection_idstring

A unique id for a collection to filter on

Response

A json object containing a list of images

countinteger

The number of images returned

limitinteger

The number of images requested

offsetinteger

The first row of images to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

total_countinteger

The total number of images

Example response

{
  "count": 1,
  "items": [
    {
      "id": "042e216a-7822-4fa0-a3d6-e3f5248ffc35",
      "collection_id": "5557dcd9-bf58-4a67-94f7-2343569834cc",
      "state": "published",
      "error": "publish process failed",
      "filename": "image-name",
      "license": {
        "title": "Open Government Licence v3.0",
        "href": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
      },
      "links": {
        "downloads": "https://localhost:100000/images/042e216a-7822-4fa0-a3d6-e3f5248ffc35/downloads"
      },
      "upload": {
        "path": "images/025a789c-533f-4ecf-a83b-65412b96b2b7/image-name.png"
      },
      "type": "chart"
    }
  ],
  "total_count": 1
}
All 9 operations