Relationship
/api/v1/relationshipsA generic edge between two entities when no FK fits.
listgetcreatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| source_id | uuid | UUID of the source entity (the 'from' end of the directed edge). |
| source_type | string | Entity type name of the source entity — must match an EDM entity type (e.g. Person, TechnologyAsset). |
| target_id | uuid | UUID of the target entity (the 'to' end of the directed edge). |
| target_type | string | Entity type name of the target entity. Must match one of the EDM entity type names. |
| relationship_type | string | Semantic label describing the nature of this relationship. Common values include 'manages', 'owns', 'depends_on', 'runs_on', 'mitigates', 'member_of', 'reports_ |
| discovered_by | string | System that created or discovered the edge — 'manual' for a human, otherwise an integration/discovery engine (e.g. ad_sync, aws_discovery). |
| properties | json | Arbitrary key-value metadata on this edge, specific to the relationship type. For example, a 'depends_on' edge might include {'criticality': 'hard', 'protocol': |
| confidence | number | Confidence score (0.0 to 1.0) indicating how certain the platform is that this relationship is accurate. 1.0 means authoritative (manually created or confirmed) |
API
client.relationships.*Loading manifest…