Metadata Patch Item

A JSON-Patch operation for a change to make to the metadata.

string
/nextState

Required for move or copy.

The location in the metadata JSON object to move or copy from, in the format of a JSON-Pointer.

string
add

The operation type

Value is one of "add", "replace", "remove", "test", "move", "copy"

string
/currentState

The location in the metadata JSON object to apply the changes to, in the format of a JSON-Pointer.

The path must always be prefixed with a /.

Special characters ~ and / in the key must be escaped to ensure the operation can be executed as intended.

string
reviewed

The value to be set or tested.

Required for add, replace, and test operations.

For add, if the value exists already the previous value will be overwritten by the new value.

For replace, the value must exist before replacing.

For test, the existing value at the path location must match the specified value.

Response Example

{
  "op": "add",
  "path": "/currentState",
  "value": "reviewed",
  "from": "/nextState"
}