Sign in
Entity Graph

Get entity relationship graph as flat nodes and edges

Retrieves the entity relationship graph as a flat nodes-and-edges structure, suitable for frontend visualization tools such as React Flow, Vis.js, and Cytoscape.

get/api/v1/entities/{templateIdentifier}/{entityIdentifier}/graph

Path parameters

templateIdentifierstring required
entityIdentifierstring required

Query parameters

depthinteger

Maximum traversal depth for relationship resolution. Clamped between 1 and 6.

include_databoolean

When true, each graph node includes a data object containing the entity's property values. Defaults to false.

traversal_mode'DIRECT_LINEAGE' | 'BIDIRECTIONAL' | 'OUTBOUND_ONLY'

Specifies the traversal mode for the entity graph. Defaults to DIRECT_LINEAGE.

relationsstring[]

When provided, only relations whose name matches one of the listed values are traversed and included. Omit to include all relations.

propertiesstring[]

When provided, each node's data object is restricted to the listed property names. Requires include_data=true to have any effect. Omit to include all properties.

Response

Flat entity graph successfully retrieved

Changes

Changed in 3 of the 13 revisions of this API.112

  • e6f6d45eade311See the full diff
    • ●

      removed the optional property errorDescription from the response with the 404 status

      response-optional-property-removed

    • ○

      added the optional property error_description to the response with the 404 status

      response-optional-property-added

  • e29b86a4899f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 88fc145b63971See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog