OFoffice-of-national-statistics
Public

Update a filter

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.

put/filters/{id}

Request

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

Query parameters

submittedboolean

A flag to indicate the submission of a filter

Headers

If-Matchstring required

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

Request body

filter_idstring

A unique id for this resource

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

Response

The filter job has been updated

filter_idstring

A unique id for this resource

instance_idstring

A unique id for this resource

publishedboolean

Indicates if the dataset is published or not

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