Walk the org-wide graph outward from an entity

GET

/ontology/entities/:entityId/related

GET

/ontology/entities/:entityId/related

$ curl https://api.cloudraker.com/ontology/entities/entityId/related \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entities": [
3     {
4       "id": "org-12345",
5       "type": "organization",
6       "name": "Acme Corporation",
7       "distance": 1
8     },
9     {
10       "id": "user-67890",
11       "type": "user",
12       "name": "Jane Doe",
13       "distance": 1
14     },
15     {
16       "id": "project-54321",
17       "type": "project",
18       "name": "Project Phoenix",
19       "distance": 2
20     }
21   ],
22   "edges": [
23     {
24       "sourceId": "user-67890",
25       "targetId": "org-12345",
26       "relation": "employed_by",
27       "fileId": "file-98765"
28     },
29     {
30       "sourceId": "project-54321",
31       "targetId": "org-12345",
32       "relation": "owned_by",
33       "fileId": "file-87654"
34     }
35   ]
36 }

Returns { entities, edges } — the neighbourhood of an entity within the org-wide (org) graph, up to ?depth= hops (1-3, default 1). Neighbour entities carry id, type, name, distance; edges carry sourceId, targetId, relation, fileId. Org-admin only — requires the admin role; non-admins get a 403.

Returns `{ entities, edges }` — the neighbourhood of an entity within the org-wide (`org`) graph, up to `?depth=` hops (1-3, default 1). Neighbour entities carry `id`, `type`, `name`, `distance`; edges carry `sourceId`, `targetId`, `relation`, `fileId`. Org-admin only — requires the admin role; non-admins get a 403.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired

Query parameters

depthintegerOptional1-3Defaults to 1

Hops to walk, 1–3. Defaults to 1.

Response

Neighbouring entities and the connecting edges.

entitieslist of objects

edgeslist of objects