/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. The default value is 20, and the maximum limit allowed is 1000
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
{
  "type": "object",
  "properties": {
    "count": {
      "description": "The number of dimensions returned for a version from an edition of a dataset",
      "type": "integer",
      "readOnly": true
    },
    "items": {
      "description": "An array of dimensions",
      "type": "array",
      "items": {
        "description": "A single dimension within a dataset",
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "dimension": {
            "description": "The name of the dimension",
            "type": "string"
          },
          "href": {
            "description": "A link to the code-list entry for the dimension",
            "type": "string"
          },
          "id": {
            "description": "The id of the dimension",
            "type": "string"
          },
          "is_area_type": {
            "description": "Indicates if a dimension is an area-type (census datasets only)",
            "type": "boolean"
          },
          "label": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "properties": {
              "code_list": {
                "description": "The code list related to this dimension",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to the code list",
                    "type": "string"
                  },
                  "id": {
                    "description": "The unique id for the code list",
                    "type": "string"
                  }
                }
              },
              "options": {
                "description": "A list of links related to this dimension",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to a list of options for this dimension",
                    "type": "string"
                  }
                }
              },
              "version": {
                "description": "The dataset version this resource belongs to",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A URL to the version this resource relates to",
                    "type": "string"
                  },
                  "id": {
                    "description": "The version number this resource relates to",
                    "type": "string"
                  }
                }
              }
            }
          },
          "number_of_options": {
            "description": "The number of options available for this dimension",
            "type": "integer"
          },
          "variable": {
            "description": "The variable name (census datasets only)",
            "type": "string"
          }
        }
      }
    },
    "limit": {
      "description": "The number of dimensions requested for a version from an edition of a dataset",
      "type": "integer"
    },
    "offset": {
      "description": "The first row of dimension for a version from an edition of a dataset to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter",
      "type": "integer"
    },
    "total_count": {
      "description": "The total number of dimensions against a version from an edition of a dataset",
      "type": "integer",
      "readOnly": true
    }
  }
}

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

Example value
null

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

Example value
null

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

Example value
null