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

GET

Get observations from a version of the dataset. By providing a single option for each dimension, a single observation will be returned. A wildcard (*) can be provided for one dimension, to retrieve a list of observations.

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
<dimension_options> query The name of the dimension option and a single value; each option (dimension) and corresponding value (code) must exist against the version - e.g. `age=30` or one of the dimension options can be represented by a wildcard value `*` e.g. `geography=*`

Responses

200: Json object containing all metadata for a version

Example value
{
  "dimensions": {
    "\u003cdimension name\u003e": {
      "option": {
        "href": "http://localhost:8080/codelists/AB12CD34/codes/K02000001",
        "id": "string"
      }
    }
  },
  "limit": 0,
  "links": {
    "dataset_metadata": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "version": {
      "href": "string",
      "id": "string"
    }
  },
  "observations": [
    {
      "dimensions": {
        "\u003cdimension name\u003e": {
          "href": "http://localhost:8080/codelists/AB12CD34/codes/K02000001",
          "id": "string",
          "label": "string"
        }
      },
      "metadata": [
        {
          "\u003ckey\u003e": "string"
        }
      ],
      "observation": "string"
    }
  ],
  "offset": 0,
  "total_observations": 0,
  "unit_of_measure": "string",
  "usage_notes": [
    {
      "note": "string",
      "title": "string"
    }
  ]
}

400: Invalid request, reasons can be one of the following: * query parameters missing expected dimensions * query parameters contain incorrect dimensions * too many query parameters are set to wildcard (*) value; only one query parameter can be equal to *

404: Resource not found, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect * observations not found for selected query paramaters

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