/datasets/{id}/editions/{edition}/versions/{version}/dimensions

GET

Get all dimensions which are used in the dataset

Parameters

Name Type Description
edition path An edition of a dataset
id path ID that represents a dataset
version path A version of a dataset
limit query Maximum number of items that will be returned. A value of zero will return zero items.
offset query 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.

Responses

200: A json list of dimensions

Example value
{
  "count": 20,
  "items": [
    {
      "description": "string",
      "dimension": "string",
      "href": "string",
      "id": "string",
      "is_area_type": true,
      "label": "string",
      "links": {
        "code_list": {
          "href": "string",
          "id": "string"
        },
        "options": {
          "href": "string"
        },
        "version": {
          "href": "https://api.beta.ons.gov.uk/v1/datasets/my-dataset/editions/july-september-2017/versions/5",
          "id": "5"
        }
      },
      "number_of_options": 0,
      "variable": "string"
    }
  ],
  "limit": 20,
  "offset": 0,
  "total_count": 123
}

400: Invalid request, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect

404: No dimensions found for version of an edition of a dataset using the id, edition and version provided

500: Failed to process the request due to an internal error