Sustema

ENTITY developer reference

CapabilityProfile

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.

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.

profile_id

Listed in this schema’s required array.

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

revision

Listed in this schema’s required array.

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

environment

Listed in this schema’s required array.

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

synthetic

Listed in this schema’s required array.

Declared type
"boolean"
Reading definition for synthetic
{
  "type": "boolean"
}

territories

Listed in this schema’s required array.

Declared type
"array"
Reading definition for territories
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

subject_types

Listed in this schema’s required array.

Declared type
"array"
Reading definition for subject_types
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

identifier_schemes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for identifier_schemes
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

operations

Listed in this schema’s required array.

Declared type
"array"
Reading definition for operations
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

modules

Listed in this schema’s required array.

Declared type
"array"
Reading definition for modules
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ModuleState"
  },
  "x-profile-maxItems": "collection_items_max"
}

coverage_statement

Listed in this schema’s required array.

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

freshness_statement

Listed in this schema’s required array.

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

limits

Listed in this schema’s required array.

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

terms_revision

Listed in this schema’s required array.

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

limitations

Listed in this schema’s required array.

Declared type
"array"
Reading definition for limitations
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "explanation_characters_max"
  },
  "x-profile-maxItems": "limitations_max"
}

dictionary_revision

Listed in this schema’s required array.

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

source_catalogue_revision

Listed in this schema’s required array.

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

identifier_schedule_revision

Listed in this schema’s required array.

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

commercial_schedule_revision

Listed in this schema’s required array.

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

field_terms

Listed in this schema’s required array.

Declared type
"array"
Reading definition for field_terms
{
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1,
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

release_state

Listed in this schema’s required array.

Declared type
"string"
Reading definition for release_state
{
  "type": "string",
  "enum": [
    "candidate",
    "released",
    "withdrawn"
  ],
  "x-profile-maxLength": "string_characters_max"
}

entitled

Listed in this schema’s required array.

Declared type
"boolean"
Reading definition for entitled
{
  "type": "boolean"
}

readiness

Listed in this schema’s required array.

Declared type
"string"
Reading definition for readiness
{
  "type": "string",
  "enum": [
    "ready",
    "degraded",
    "unavailable"
  ],
  "x-profile-maxLength": "string_characters_max"
}

classification_offers_path

Not listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for classification_offers_path
{
  "anyOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 240,
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

classification_contract_revision

Not listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for classification_contract_revision
{
  "const": "ici-0.1"
}

projection_slots

Listed in this schema’s required array.

Fixed public field vocabulary for this information profile, selected only from public contract/entitlement inputs, never from whether a hidden entity fact exists. A slot advertises a kind of field, not possession of data. Generic not_provided covers absent and existence-withheld values identically; no entity-specific omission/count/hash reveals hidden facts.

Declared type
"array"
Reading definition for projection_slots
{
  "type": "array",
  "maxItems": 256,
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "slot_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      },
      "predicate": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      },
      "module": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      },
      "required_identity": {
        "type": "boolean"
      },
      "assessment_expected": {
        "type": "boolean"
      },
      "confidence_policy_revision": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "required": [
      "slot_id",
      "predicate",
      "module",
      "required_identity",
      "assessment_expected",
      "confidence_policy_revision"
    ]
  },
  "description": "Fixed public field vocabulary for this information profile, selected only from public contract/entitlement inputs, never from whether a hidden entity fact exists. A slot advertises a kind of field, not possession of data. Generic not_provided covers absent and existence-withheld values identically; no entity-specific omission/count/hash reveals hidden facts."
}

adapter_set

Listed in this schema’s required array.

Declared type
"array"
Reading definition for adapter_set
{
  "type": "array",
  "minItems": 1,
  "maxItems": 2,
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "adapter": {
        "enum": [
          "rest",
          "mcp"
        ]
      },
      "encoder_revision": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "unicode_escaping": {
        "enum": [
          "utf8",
          "ascii"
        ]
      },
      "jsonrpc_id_characters_max": {
        "const": 128
      },
      "response_meta_echo": {
        "const": false
      }
    },
    "required": [
      "adapter",
      "encoder_revision",
      "unicode_escaping",
      "jsonrpc_id_characters_max",
      "response_meta_echo"
    ]
  },
  "allOf": [
    {
      "contains": {
        "properties": {
          "adapter": {
            "const": "rest"
          }
        },
        "required": [
          "adapter"
        ]
      },
      "minContains": 0,
      "maxContains": 1
    },
    {
      "contains": {
        "properties": {
          "adapter": {
            "const": "mcp"
          }
        },
        "required": [
          "adapter"
        ]
      },
      "minContains": 0,
      "maxContains": 1
    }
  ]
}

contract_binding

Listed in this schema’s required array.

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

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": {
    "profile_id": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "revision": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "environment": {
      "$ref": "#/components/schemas/Environment"
    },
    "synthetic": {
      "type": "boolean"
    },
    "territories": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "subject_types": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "identifier_schemes": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "operations": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "modules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ModuleState"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "coverage_statement": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "freshness_statement": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "limits": {
      "$ref": "#/components/schemas/Limits"
    },
    "terms_revision": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "explanation_characters_max"
      },
      "x-profile-maxItems": "limitations_max"
    },
    "dictionary_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "source_catalogue_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "identifier_schedule_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "commercial_schedule_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "field_terms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "release_state": {
      "type": "string",
      "enum": [
        "candidate",
        "released",
        "withdrawn"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "entitled": {
      "type": "boolean"
    },
    "readiness": {
      "type": "string",
      "enum": [
        "ready",
        "degraded",
        "unavailable"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "classification_offers_path": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 240,
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "classification_contract_revision": {
      "const": "ici-0.1"
    },
    "projection_slots": {
      "type": "array",
      "maxItems": 256,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "slot_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "predicate": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "module": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "required_identity": {
            "type": "boolean"
          },
          "assessment_expected": {
            "type": "boolean"
          },
          "confidence_policy_revision": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          }
        },
        "required": [
          "slot_id",
          "predicate",
          "module",
          "required_identity",
          "assessment_expected",
          "confidence_policy_revision"
        ]
      },
      "description": "Fixed public field vocabulary for this information profile, selected only from public contract/entitlement inputs, never from whether a hidden entity fact exists. A slot advertises a kind of field, not possession of data. Generic not_provided covers absent and existence-withheld values identically; no entity-specific omission/count/hash reveals hidden facts."
    },
    "adapter_set": {
      "type": "array",
      "minItems": 1,
      "maxItems": 2,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "adapter": {
            "enum": [
              "rest",
              "mcp"
            ]
          },
          "encoder_revision": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "unicode_escaping": {
            "enum": [
              "utf8",
              "ascii"
            ]
          },
          "jsonrpc_id_characters_max": {
            "const": 128
          },
          "response_meta_echo": {
            "const": false
          }
        },
        "required": [
          "adapter",
          "encoder_revision",
          "unicode_escaping",
          "jsonrpc_id_characters_max",
          "response_meta_echo"
        ]
      },
      "allOf": [
        {
          "contains": {
            "properties": {
              "adapter": {
                "const": "rest"
              }
            },
            "required": [
              "adapter"
            ]
          },
          "minContains": 0,
          "maxContains": 1
        },
        {
          "contains": {
            "properties": {
              "adapter": {
                "const": "mcp"
              }
            },
            "required": [
              "adapter"
            ]
          },
          "minContains": 0,
          "maxContains": 1
        }
      ]
    },
    "contract_binding": {
      "$ref": "#/components/schemas/PublicContractBinding"
    }
  },
  "required": [
    "profile_id",
    "revision",
    "environment",
    "synthetic",
    "territories",
    "subject_types",
    "identifier_schemes",
    "operations",
    "modules",
    "coverage_statement",
    "freshness_statement",
    "limits",
    "terms_revision",
    "limitations",
    "dictionary_revision",
    "source_catalogue_revision",
    "identifier_schedule_revision",
    "commercial_schedule_revision",
    "field_terms",
    "release_state",
    "entitled",
    "readiness",
    "projection_slots",
    "adapter_set",
    "contract_binding"
  ],
  "additionalProperties": false
}

Related schemas

All API operations