API: Linking

Linking Example

In this example, we use Fiddler to execute the commands.

  1. We want to first check the existing links of a object
  2. Then we create a new link
  3. We can check the existance of the new link
  4. Delete the link

Preparation

Header:

This it the header configuration: Put it in the composer tab -> Parser: in the field below the GET / URL input.

Check existing links

First get the object

GET https://demo.virtualskeleton.ch/api/objects/110

We get the 200 Http response code in the Session List and click on the entry in the list to view the JSON output. We check if the desired object is already linked.

if not, we can send the URLs of both objects to create a link using POST

Create a link:

  1. Add this line to the header Content-Type: application/json

  1. The POST endpoint to create the link is

POST https://demo.virtualskeleton.ch/api/object-links

with the Request Body containing both selfUrl’s of the objects (eg. 110, 86):

you get back the object-links id selfURL in the response:

selfUrl=https://demo.virtualskeleton.ch/api/object-links/102

check if the link is present in object 110 using again

GET https://demo.virtualskeleton.ch/api/objects/110

Deleting an existing link

You need to identify the ID of the link. This information is in the object as linkedObjectRelations. To delete to link just use:

DELETE https://demo.virtualskeleton.ch/api/object-links/102

Comments are closed.