CPS Delta Endpoints

The CPS Delta feature provides 1 endpoint:

/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta

Description

The following is a Get endpoint, which allows the user to find the delta between configurations stored under two anchors within the same dataspace.

Path Parameters

The endpoint takes 2 path parameters as input:

dataspace-name: name of dataspace where the 2 anchors to be used for delta generation are stored.
anchor-name: the source anchor name, the data under this anchor will be the reference data for delta report generation

Query Parameters

The endpoint takes 3 query parameters as input:

target-anchor-name: the data retrieved from target anchor gets compared against the data retrieved from source anchor
xpath: the xpath to a particular data node, Example: /bookstore/categories[@code=’1’]
descendants: specifies the number of descendants to query.

Sample Delta Report

[
  {
    "action": "ADD",
    "xpath": "/bookstore/categories/[@code=3]",
    "target-data": {
      "code": "3,",
      "name": "kidz"
    }
  },
  {
    "action": "REMOVE",
    "xpath": "/bookstore/categories/[@code=1]",
    "source-data": {
      "code": "1,",
      "name": "Fiction"
    }
  },
  {
    "action": "UPDATE",
    "xpath": "/bookstore/categories/[@code=2]",
    "source-data": {
      "name": "Funny"
    },
    "target-data": {
      "name": "Comic"
    }
  }
]