/filters/{id}
GET
Get document describing the filter
Responses
200: The filter was found and document is returned
Example value
{
"dataset": {
"edition": "string",
"id": "string",
"version": 0
},
"filter_id": "string",
"instance_id": "string",
"links": {
"dimensions": {
"href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665/dimensions"
},
"self": {
"href": "http://localhost:8080/filters/51f5f643-0633-45be-ae82-63ff4149f665"
},
"version": {
"href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/version/1",
"id": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc"
}
},
"population_type": "string",
"published": true,
"type": "string"
}404: Filter not found
500: Failed to process the request due to an internal error
PUT
Update the filter by providing new properties, submit a filter for processing by setting query parameter `submitted` to `true`. This endpoint is for CMD datasets only.
Parameters
| Name | Type | Description |
|---|---|---|
| submitted | query | A flag to indicate the submission of a filter |
| filter | body | Model of all editable properties within a filter |
| If-Match | header | Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check |
| id | path | The unique filter ID for customising a dataset |
Responses
200: The filter job has been updated
Example value
{
"dataset": {
"edition": "string",
"id": "string",
"version": 0
},
"dimensions": [
{
"name": "string",
"options": [
"string"
]
}
],
"filter_id": "string",
"instance_id": "string",
"links": {
"filter_output": {
"href": "http://localhost:8080/filter-outputs/95c4669b-3ae9-4ba7-b690-87e890a1c543",
"id": "95c4669b-3ae9-4ba7-b690-87e890a1c543"
}
},
"published": true
}