OFoffice-of-national-statistics
Public

Get a filter

Get document describing the filter

get/filters/{id}

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    none declared

Response

The filter was found and document is returned

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"
    }
  }
}

Changes

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