OFoffice-of-national-statistics
Public

Add a dimension to a filter

Add a dimension to filter with a list of options. Note - the is_area_type property is required to ensure a successful filter journey.

post/filters/{id}/dimensions

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    none declared. Required headers: If-Match

Path parameters

idstring required

The unique filter ID for customising a dataset

Headers

If-Matchstring required

Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check

Request body

namestring

The name of the dimension

is_area_typeboolean

Indicates if the dimension is an area type

optionsstring[]

A list of options for dimension to filter on a dataset

Response

The dimension was created

Changes

No recorded changes to this operation across all 1 revision of this API.