Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

KnowledgeGraph

Create a knowledge graph external reference

Creates a new external reference attached to the node identified in the path. The composite PK is (workspace_id, node_id, entity_type, entity_id, relationship). On duplicate PK returns 409 with the existing row so the agent can decide to no-op or PATCH.

post/knowledgeGraph/nodes/{node_id}/externalRefs

Path parameters

node_idstring required

The knowledge graph node to attach this reference to

Request body

workspace_idstring required

The workspace to create the reference in

application_idstring

The application ID (used for auth scope)

entity_typestring required

The type of external entity

entity_idstring required

The ID of the external entity

relationshipstring required

The relationship between the node and the entity

entity_variant_idstring

The variant/version ID of the external entity

referenced_entity_versionstring

The version of the externally referenced entity

descriptionstring

Human-readable description of this reference

propertiesobject

Additional structured properties

agent_typestring

Agent type creating this reference

agent_versionstring

Agent version creating this reference

Response

The created external reference

workspace_idstring

The workspace this reference belongs to

node_idstring

The knowledge graph node this reference is attached to

entity_typestring

The type of external entity (e.g. test, flow, plan, step_execution)

entity_idstring

The ID of the external entity

relationshipstring

The relationship between the node and the external entity

entity_variant_idstring

The variant/version ID of the external entity at time of linking

referenced_entity_versionstring

The version of the externally referenced entity (not the ETag)

descriptionstring

Human-readable description of this reference

propertiesobject

Additional structured properties for this reference

versioninteger

Monotonic edit counter (server-managed, readOnly)

u_version_string

ETag for optimistic locking (server-managed, readOnly)

last_updated_bystring

Principal who last updated this reference (server-managed, readOnly)

created_bystring

Principal who created this reference (server-managed, readOnly)

agent_typestring

Agent type that wrote this reference

agent_versionstring

Agent version that wrote this reference

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp