Sustema

ENTITY developer reference

HierarchyResult

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Confidence is scoped to the immutable permitted information profile, not page length or input matching; every returned business fact must be mapped. A simple path has at most graph_depth_max relationships and graph_depth_max+1 entity IDs, matching edges in order without cycles. Aggregate graph bounds still apply.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

root

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for root
{
  "$ref": "#/components/schemas/SubjectRef"
}

nodes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for nodes
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/SubjectRef"
  },
  "x-profile-maxItems": "graph_nodes_max"
}

edges

Listed in this schema’s required array.

Declared type
"array"
Reading definition for edges
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Relationship"
  },
  "x-profile-maxItems": "graph_edges_max"
}

paths

Listed in this schema’s required array.

Declared type
"array"
Reading definition for paths
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "path_id": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "entity_ids": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        "minItems": 1,
        "x-profile-maxItems": "graph_depth_max",
        "x-profile-offset": 1
      },
      "relationship_ids": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        "x-profile-maxItems": "graph_depth_max"
      }
    },
    "required": [
      "path_id",
      "entity_ids",
      "relationship_ids"
    ],
    "additionalProperties": false
  },
  "x-profile-maxItems": "graph_nodes_max"
}

boundaries

Listed in this schema’s required array.

Declared type
"array"
Reading definition for boundaries
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GraphBoundary"
  },
  "x-profile-maxItems": "graph_edges_max"
}

completeness

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for completeness
{
  "$ref": "#/components/schemas/Completeness"
}

snapshot_ref

Listed in this schema’s required array.

Declared type
"string"
Reading definition for snapshot_ref
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

continuation_supported

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for continuation_supported
{
  "const": false
}

confidence_summary

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for confidence_summary
{
  "$ref": "#/components/schemas/ConfidenceSummary"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "root": {
      "$ref": "#/components/schemas/SubjectRef"
    },
    "nodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubjectRef"
      },
      "x-profile-maxItems": "graph_nodes_max"
    },
    "edges": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Relationship"
      },
      "x-profile-maxItems": "graph_edges_max"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path_id": {
            "type": "string",
            "x-profile-maxLength": "string_characters_max"
          },
          "entity_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid",
              "x-profile-maxLength": "string_characters_max"
            },
            "minItems": 1,
            "x-profile-maxItems": "graph_depth_max",
            "x-profile-offset": 1
          },
          "relationship_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid",
              "x-profile-maxLength": "string_characters_max"
            },
            "x-profile-maxItems": "graph_depth_max"
          }
        },
        "required": [
          "path_id",
          "entity_ids",
          "relationship_ids"
        ],
        "additionalProperties": false
      },
      "x-profile-maxItems": "graph_nodes_max"
    },
    "boundaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GraphBoundary"
      },
      "x-profile-maxItems": "graph_edges_max"
    },
    "completeness": {
      "$ref": "#/components/schemas/Completeness"
    },
    "snapshot_ref": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "continuation_supported": {
      "const": false
    },
    "confidence_summary": {
      "$ref": "#/components/schemas/ConfidenceSummary"
    }
  },
  "required": [
    "root",
    "nodes",
    "edges",
    "paths",
    "boundaries",
    "completeness",
    "snapshot_ref",
    "continuation_supported",
    "confidence_summary"
  ],
  "additionalProperties": false,
  "description": "Confidence is scoped to the immutable permitted information profile, not page length or input matching; every returned business fact must be mapped. A simple path has at most graph_depth_max relationships and graph_depth_max+1 entity IDs, matching edges in order without cycles. Aggregate graph bounds still apply.",
  "allOf": [
    {
      "if": {
        "properties": {
          "boundaries": {
            "contains": {
              "properties": {
                "reason": {
                  "enum": [
                    "byte_limit",
                    "node_limit",
                    "depth_limit",
                    "edge_limit"
                  ]
                }
              },
              "required": [
                "reason"
              ]
            }
          }
        },
        "required": [
          "boundaries"
        ]
      },
      "then": {
        "properties": {
          "completeness": {
            "properties": {
              "state": {
                "const": "incomplete"
              }
            }
          }
        }
      }
    }
  ]
}

Related schemas

All API operations