/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 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. |
| 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
{
"count": 20,
"items": [
{
"dimension": "string",
"instance_id": "string",
"label": "string",
"links": {
"code": {
"href": "string",
"id": "string"
},
"code_list": {
"href": "string",
"id": "string"
},
"version": {
"href": "string",
"id": "string"
}
},
"node_id": "string",
"option": "string"
}
],
"limit": 20,
"offset": 0,
"total_count": 123
}