image

GET /images/{image_id}/downloads

Request

Base URL
/v1 (relative, and the document’s source URL is not known)
Auth
- API key in header X-Florence-Token
- or API key in header Authorization

Path parameters

image_idstring required

A unique id for an image metadata entry

Response

Successfully got download variants.

countinteger

The number of image downloads returned

limitinteger

The number of image downloads requested

offsetinteger

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

total_countinteger

The total number of image downloads

Example response

{
  "count": 1,
  "items": [
    {
      "id": "original",
      "height": 1080,
      "href": "http://download.ons.gov.uk/images/042e216a-7822-4fa0-a3d6-e3f5248ffc35/image-name.png",
      "palette": "bw",
      "private": "my-private-bucket",
      "public": true,
      "size": 1024000,
      "type": "png",
      "width": 1920,
      "links": {
        "self": "http://localhost:10000/images/042e216a-7822-4fa0-a3d6-e3f5248ffc35/downloads/original",
        "image": "http://localhost:10000/images/042e216a-7822-4fa0-a3d6-e3f5248ffc35"
      },
      "state": "published",
      "error": "import process failed",
      "import_started": "2020-04-26T08:05:52Z",
      "import_completed": "2020-04-26T08:07:32+00:00",
      "publish_started": "2020-04-26T09:51:03-00:00",
      "publish_completed": "2020-04-26T10:01:28Z"
    }
  ],
  "total_count": 1
}

Changes

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