Private

Update a filter

Update the filter by providing new properties, submit a filter for processing by setting query parameter submitted to true

put/filters/{id}

Request

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

Headers

If-Matchstring required

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

Request body

population_typestring

The population type the information is selected from.

Example request

{
  "events": [
    {
      "timestamp": "2016-07-17T08:38:25.316+0000",
      "name": "cantabular-export-start"
    }
  ]
}

Response

The filter job has been updated

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"
    },
    "filter_output": {
      "href": "http://localhost:8080/filter-outputs/95c4669b-3ae9-4ba7-b690-87e890a1c543",
      "id": "95c4669b-3ae9-4ba7-b690-87e890a1c543"
    }
  }
}

Changes

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