Cloud Diagrams

Get resource relationships

Walks the diagram graph from the anchor resource and returns related resources. Edge traversal walks the diagram's link set (same-scheme guard, BFS, cycle-safe); group traversal walks the group membership set. The result list is capped at 200 relations; truncated is true when the cap is hit. Read-only: does not mutate diagram state.

get/clouddiagrams/v1/statussheet/{id}/resources/{rid}/relationships

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/clouddiagrams/v1/statussheet/{id}/resources/{rid}/relationships
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

idstring required

Diagram (layer) ID.

ridstring required

Anchor resource ID — must exist as a node, element, or group on the diagram.

Query parameters

direction'downstream' | 'upstream' | 'both'

Edge direction relative to the anchor. both returns upstream and downstream neighbours. Defaults to both.

depth'direct' | 'transitive'

direct returns one-hop neighbours; transitive runs a cycle-safe BFS to the connected component (still capped at 200 relations). Defaults to direct.

kind'edges' | 'group_members' | 'both'

edges walks the link graph; group_members walks group membership (children and parent groups); both merges the two and dedupes by id, preserving the smallest observed hop count. Defaults to edges.

Response

OK - Related resources returned.

direction'downstream' | 'upstream' | 'both' required
depth'direct' | 'transitive' required
kind'edges' | 'group_members' | 'both' required
truncatedboolean required

True when the relation list was capped at 200 entries.

Changes

No recorded changes to this operation across all 1 revision of this API.