Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-14183734.3 KB
Public

Create a filter for a dataset

Create a resource for listing a selection of dimensions and dimension options to be added to filter for a dataset. Note - the is_area_type property is required to ensure a successful filter journey.

post/filters

Request body

population_typestring

The population type the information is selected from.

Response

filter was created

filter_idstring

id of filter

instance_idstring

id of instance filter is based on

publishedboolean

is dataset published or not

typestring

type of filter(e.g. flexible)

population_typestring

census dataset/blob filter is based on

Example response

{
  "links": {
    "version": {
      "href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1"
    },
    "self": {
      "href": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC",
      "id": "DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
    },
    "dimensions": {
      "href": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/dimensions"
    }
  }
}