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

GET

Get a list of options which appear in this dimension and dataset. By default all options are returned, but a subset can be requested by providing offset and limit query parameters, or by providing the list of option IDs, only the IDs that are found will be returned.

Parameters

Name Type Description
dimension path A dimension from a dataset
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 all available items, without limit. The default value is 100.
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.
id query List of ids, as comma separated values and/or as multiple query parameters with the same key (e.g. 'id=op1,op2&id=op3'). It defines the IDs that we want to retrieve. If provided, it takes precedence over offset and limit.

Responses

200: Json object containing all options for a dimension

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 dimension options",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dimension": {
            "description": "The name of the dimension",
            "type": "string"
          },
          "instance_id": {
            "description": "The unique identifier for the instance in which this dimension option is associated to",
            "type": "string"
          },
          "label": {
            "description": "A label given to a dimension option",
            "type": "string"
          },
          "links": {
            "description": "A object with all resources related to a dimension option",
            "type": "object",
            "properties": {
              "code": {
                "description": "A link to the code of the dimension for this option",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "The url of the code that refers to the dimension for this option",
                    "type": "string"
                  },
                  "id": {
                    "description": "The id of the code that refers to the dimension for this option",
                    "type": "string"
                  }
                }
              },
              "code_list": {
                "description": "A link to the code list the dimension for this option belongs to",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "The url of the code list that the dimension for this option belongs to",
                    "type": "string"
                  },
                  "id": {
                    "description": "The id of the code list that the dimension for this option belongs to",
                    "type": "string"
                  }
                }
              },
              "version": {
                "description": "A link to the version of the dataset the option belongs to",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "The href of the version that this option belongs to",
                    "type": "string"
                  },
                  "id": {
                    "description": "The id of the version that this option belongs to",
                    "type": "string"
                  }
                },
                "readOnly": true
              }
            }
          },
          "node_id": {
            "description": "The id of the node",
            "type": "string"
          },
          "option": {
            "description": "An option for a dimension",
            "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 * dimension was incorrect * query parameters incorrect offset provided * query parameters incorrect limit provided

Example value
null

404: No dimension options were found for dimension

Example value
null

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

Example value
null