Versions Compared

Key

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

...

POST /dataspaces/{dataspace-name}/anchors

Description

Create a new anchor in the given dataspace (payload includes anchor name, module namespace and revision)

Request Body

application/json

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired
fileIncludes anchor name, module namespace and revisionbodyyangrequired


201 – OK – New resource has been created

...

DELETE /dataspaces/{dataspace-name}/anchors/{anchor-name}

Description

Delete an anchor given a anchor and a dataspace. This will delete the whole tree.

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired
anchor-nameThe name of the anchorpathstringrequired


204 – OK – The resource was successfully deleted


GET /dataspaces/{dataspace-name}/anchors

Description

Read all anchors in the given a dataspace.

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired


200 – OK – Everything is working

...

POST /dataspaces/{dataspace-name}/nodes

Description

Create a (root) node for a given anchor for the given dataspace, the node can have children. Their children will also be persisted as separate nodes in the system.

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired
fileModel fileformyangrequired


201 – OK – New resource has been created



POST /dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes

Description

Get a node given an anchor for the given dataspace (return just one level with just xpath references to its children)

Request Body

{

    "xpath" : "/dataspace/anchors/nodes[1]"

}

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired
anchor-nameThe name of the anchorpathstringrequired


200 – OK – Everything is working

Example Response



POST /dataspaces/{dataspace-id}/nodes

Description

Get a node (under any anchor) given a Xpath expression for the given dataspace

Get all the relevant nodes given a schema node identifier for the given dataspace

Request Body

{

    "xpath" : "/dataspace/anchor/nodes"

}

Request Parameters:

NameDescriptionTypeData type
dataspace-nameThe name of the dataspacepathstringrequired


200 – OK – Everything is working

Example Response



Payload Data Structures

...