/filters/{id}/dimensions/{name}/options/{option}

GET

Get a specified option from the options which will be used to filter the dimension

Responses

200: An option within a dimension was returned

Example value
{
  "description": "An option for a dimension to filter on a dataset. Information on a dimension option can be gathered using the `Dataset API`",
  "type": "object",
  "properties": {
    "dimension_option_url": {
      "description": "A link to a filtered dimension option",
      "type": "string"
    },
    "option": {
      "description": "The filtered dimension option",
      "type": "string"
    }
  }
}

400: Filter or dimension name not found

Example value
null

404: Dimension option was not found

Example value
null

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

Example value
null

POST

Add an option to a filtered dimension

Responses

201: Option was added

Example value
null

400: Filter was not found

Example value
null

404: Dimension name was not found

Example value
null

422: Unprocessable entity - instance has been removed

Example value
null

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

Example value
null

DELETE

Remove a single option from a dimension

Responses

204: Option was removed

Example value
null

400: This error code could be one or more of: * Filter was not found * Dimension name was not found

Example value
null

404: Dimension option was not found

Example value
null

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

Example value
null