v1

latestOpenAPI 3.0.3Apache 2.02026-07-13161446.9 KB

Data API

Update a document

This API endpoint updates an existing document on the server by describing the changes required (using JSON patch operations)

patch/v1/data/{path}

JSON patch operation type

pathstring required

A JSON pointer to a location within the target document where the operation is performed.

The effective path is this value prefixed with the API call's path parameter.

The server will return a bad request (404) response if:

The parent of the effective path does not refer to an existing document
For remove and replace operations, the effective path does not refer to an existing document.

valueobject

The value to add, replace or test.

[
  {
    "op": "add",
    "path": "-"
  }
]

Success