CPS Delta feature Exceptions
Where ever possible the Delta Feature will throw the same exceptions as defined in CPS core. If any new exception for the delta feature are required the following will be updated here.
HTTP response codes for Delta API
The proposed API will be part of the CPS Data Interface. The following response codes will be returned by the API:
# | Sub Interface | Method | Scenario | HTTP Response codes to be implemented | Notes |
---|---|---|---|---|---|
1 | Data | Proposed API: GET- /v1/dataspaces/{dataspace-name}/delta?firstAnchor={anchor-name}?secondAnchor={anchor-name}?xpath={xpath}&descendants={descendants} Proposed method name: <decision pending> | Generate a delta report between 2 anchors in a given dataspace. |
|
Request parameters:
Parameter name | In | Required | Description |
---|---|---|---|
dataspace-name | Path | Yes | Dataspace name |
firstAnchor | Query | Yes | First Anchor Name/Reference Anchor |
secondAnchor | Query | Yes | Second Anchor Name |
xpath | Query | Yes | xpath of the node |
descendants | Query | No | Number of descendants for delta comparison. |