v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-14172729.9 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

post/filters

Request body

filter_idstring

A unique id for this resource

population_typestring

If specifying a custom filter, the population type that the data should be queried from

Example request

{
  "links": {
    "version": {
      "href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1",
      "id": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc"
    },
    "dimensions": {
      "href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665/dimensions"
    },
    "self": {
      "href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665"
    }
  },
  "population_type": "Teaching-Dataset"
}

Response

filter was created

filter_idstring

A unique id for this resource

instance_idstring

The instance of a dataset this filter relates to

typestring

The type of filter, e.g. flexible for census filters

publishedboolean

Whether the dataset the filter relates to is published or not

population_typestring

The population type that the filter is based on, this is for Census filters only

Example response

{
  "links": {
    "version": {
      "href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1",
      "id": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc"
    },
    "dimensions": {
      "href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665/dimensions"
    },
    "self": {
      "href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665"
    }
  }
}

All 17 operations