/filters

POST

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.

Parameters

Name Type Description
filter body Model of all editable properties within a filter

Responses

201: filter was created

Example value
{
  "dataset": {
    "edition": "string",
    "id": "string",
    "version": 0
  },
  "disclosure_control": {
    "blockedoptions": {
      "blocked_count": 0,
      "blocked_options": [
        "string"
      ]
    },
    "dimension": "string",
    "status": "string"
  },
  "filter_id": "string",
  "instance_id": "string",
  "links": {
    "dimensions": {
      "href": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/dimensions"
    },
    "self": {
      "href": "http://localhost:8080/filters/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC",
      "id": "DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
    },
    "version": {
      "href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1",
      "id": 1
    }
  },
  "population_type": "string",
  "published": true,
  "type": "string"
}

400: Invalid request body

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