/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
{
  "links": {
    "dimension": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate",
      "id": "aggregate"
    },
    "filter": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324",
      "id": "bd67930a-2856-44b3-a87a-e9e5fb832324"
    },
    "self": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate/options/cpih1dim1T10000",
      "id": "cpih1dim1T10000"
    }
  },
  "option": "cpih1dim1T10000"
}

400: Filter or dimension name not found

404: Dimension option was not found

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

POST

Add an option to a filtered dimension

Parameters

Name Type Description
If-Match header Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check
id path The unique filter ID for customising a dataset
name path The name of a dimension
option path The single option for a dimension

Responses

201: Option was added

Example value
{
  "links": {
    "dimension": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate",
      "id": "aggregate"
    },
    "filter": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324",
      "id": "bd67930a-2856-44b3-a87a-e9e5fb832324"
    },
    "self": {
      "href": "http://localhost:8080/filters/bd67930a-2856-44b3-a87a-e9e5fb832324/dimensions/aggregate/options/cpih1dim1T10000",
      "id": "cpih1dim1T10000"
    }
  },
  "option": "cpih1dim1T10000"
}

400: Filter was not found

404: Dimension name was not found

409: #/responses/FilterConflict

422: Unprocessable entity - instance has been removed

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

DELETE

Remove a single option from a dimension

Parameters

Name Type Description
If-Match header Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check
id path The unique filter ID for customising a dataset
name path The name of a dimension
option path The single option for a dimension

Responses

204: Option was removed

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

404: Dimension option was not found

409: #/responses/FilterConflict

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