Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#Existing EndpointUpdated EndpointPath/Query ParametersResponse Codes
1

GET-/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaAnchors

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


GET-/v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta?target-anchor-name={target-anchor-name}&descendants={descendants}&xpath={xpath}


Parameter NameInRequiredDescription
dataspace-namePathYesDataspace name
source-anchor-namePathYesFirst Anchor Name/Reference Anchor
target-anchor-nameQueryYesSecond Anchor Name/Comparand Anchor
descendantsQueryNoLevel of descendants for delta comparison. 
xpathQueryYesxpath of the node


  • 200 (OK)
    • success
  • 400
    • dataspace not found
      DataspaceNotFoundException
    • anchor not found
      AnchorNotFoundException
    • Data node not found
      DataNodeNotFoundException
    • invalid xpath
      CpsPathException
  • 500
    • unexpected error
2

POST- /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaPayload

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


POST- /v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta?xpath={xpath}

Body

file- yang schema ( Optional )

json - JSON payload as String ( Mandatory )


Parameter NameInRequiredDescription
dataspace-namePathYesDataspace name
source-anchor-namePathYesFirst Anchor Name/Reference Anchor
xpathQueryYesxpath of the node
FileBody (multipart/form-data TBC)OptionalYang file/Zip file containing the schema details.
Text/StringBody (multipart/form-data)YesJSON payload as plain text


...