OFoffice-of-national-statistics
Private

Get a list of contents within a bundle

Changed on

Get a list of contents within a bundle

get/bundles/{id}/contents

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

The bundle was found and the list of contents is returned

countinteger

The number of items returned.

limitinteger

The number of items requested.

offsetinteger

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

total_countinteger

The total number of items available.

Example response

{
  "count": 20,
  "total_count": 123,
  "items": [
    {
      "bundle_id": "9e4e3628-fc85-48cd-80ad-e005d9d283ff",
      "metadata": {
        "dataset_id": "cpih",
        "edition_id": "march",
        "title": "Consumer Prices Index",
        "version_id": 1
      },
      "id": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc",
      "state": "PUBLISHED",
      "links": {
        "edit": "https://publishing.ons.gov.uk/data-admin/series/cpih/editions/time-series/versions/1",
        "preview": "https://publishing.ons.gov.uk/inflationandpriceindices/datasets/cpih/editions/time-series/versions/1"
      }
    }
  ]
}

Changes