Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-14172729.9 KB
Public

Update dimension options against a filter job

Patch a list of dimension options for a filter. This endpoint is available for CMD filter types only.

patch/filters/{id}/dimensions/{name}

Headers

If-Matchstring required

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

Request body

op'add' | 'remove'

The operation to be made on path.

  • add - Adding multiple values that are the same or already in resource will not be appended to array.
  • remove - Removing values that do not exist in array will not result in failure
pathstring

Path to value that needs to be operated on. The special '-' key is the indicator of an array at a specific path

valuestring[]

A list of values defined by the operation value. 'op' to define the update against array

Example request

{
  "path": "/options/-"
}

Response

The dimension was patched and the list of dimension options are returned