/filters/{id}/dimensions/{name}

GET

Return details of a specific dimension within a filter

Responses

200: A Dimension within a filter was returned

Example value
{
  "id": "string",
  "is_area_type": true,
  "label": "string",
  "links": {
    "filter": {
      "href": "string",
      "id": "string"
    },
    "options": {
      "href": "string",
      "id": "string"
    },
    "self": {
      "href": "string",
      "id": "string"
    }
  },
  "name": "string"
}

400: Filter was not found

404: Dimension name was not found

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

DELETE

Remove a dimension and any options set within the 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

Responses

204: The dimension was removed

400: Filter was not found

404: Dimension name was not found

409: #/responses/FilterConflict

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

PATCH

Patch a list of dimension options for a filter

Parameters

Name Type Description
patch body A list of options for a dimension to filter the dataset
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

Responses

200: The dimension was patched and the successfully applied patch operations are returned

Example value
[
  {
    "op": "add",
    "path": "/options/-",
    "value": [
      "string"
    ]
  }
]

400: Invalid request body, filter job does not exist or too many values have been provided in the patch operations

401: Unauthorised, request lacks valid authentication credentials

404: Dimension was not found

409: Filter was modified by an external entity

422: Unprocessable entity - instance has been removed

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