links

3 endpoints at a glance

Method	Path	Summary
GET	/links	List Links
POST	/links	Create Link
DELETE	/links/{link_id}	Delete Link

links

---

List Links

GET

/links

List links matching the filters.

Three modes:

• from_type + from_id → outgoing edges
• to_type + to_id → incoming edges
• entity_type + entity_id → both directions in one shot
  (what a detail-page "Related" panel wants)

Parameters

Header Parameters

authorization

Query Parameters

from_type

from_id

to_type

to_id

entity_type

entity_id

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/links

Playground

Headers

authorization

Variables

Key

Value

from_type

from_id

to_type

to_id

entity_type

entity_id

Samples

---

Create Link

POST

/links

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"from": {

  

  

"type": "string",

  

  

"id": "string",

  

  

"ref": {

  

  

  

"additionalProperties": "string"

  

  

}

  

},

  

"to": {

  

  

"type": "string",

  

  

"id": "string",

  

  

"ref": {

  

  

  

"additionalProperties": "string"

  

  

}

  

},

  

"kind": "related"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/links

Playground

Headers

authorization

Body

Samples

---

Delete Link

DELETE

/links/{link_id}

Parameters

Header Parameters

authorization

Path Parameters

link_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/links/{link_id}

Playground

Headers

authorization

Variables

Key

Value

link_id*

Samples

---