ENTITY developer reference
Classification
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.
assignment_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for assignment_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}subject
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for subject
{
"$ref": "#/components/schemas/SubjectRef"
}taxonomy
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for taxonomy
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}taxonomy_version
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for taxonomy_version
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}code
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for code
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}label
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for label
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}method
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for method
{
"type": "string",
"enum": [
"source_reported",
"mapped",
"inferred"
],
"x-profile-maxLength": "string_characters_max"
}primary
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for primary
{
"type": "string",
"enum": [
"primary",
"secondary",
"unspecified"
],
"x-profile-maxLength": "string_characters_max"
}original_taxonomy
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for original_taxonomy
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}original_version
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for original_version
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}original_code
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for original_code
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}mapping_path
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for mapping_path
{
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
}mapping_quality
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for mapping_quality
{
"type": "string",
"enum": [
"exact",
"approximate",
"one_to_many",
"not_applicable",
"unknown"
],
"x-profile-maxLength": "string_characters_max"
}period
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for period
{
"$ref": "#/components/schemas/Clocks"
}evidence
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for evidence
{
"$ref": "#/components/schemas/EvidenceSummary"
}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"
}confidence
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for confidence
{
"$ref": "#/components/schemas/FactConfidence"
}acquisition_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for acquisition_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}result_version
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for result_version
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
}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": {
"assignment_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"subject": {
"$ref": "#/components/schemas/SubjectRef"
},
"taxonomy": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"taxonomy_version": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"code": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"label": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"method": {
"type": "string",
"enum": [
"source_reported",
"mapped",
"inferred"
],
"x-profile-maxLength": "string_characters_max"
},
"primary": {
"type": "string",
"enum": [
"primary",
"secondary",
"unspecified"
],
"x-profile-maxLength": "string_characters_max"
},
"original_taxonomy": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"original_version": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"original_code": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"mapping_path": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"mapping_quality": {
"type": "string",
"enum": [
"exact",
"approximate",
"one_to_many",
"not_applicable",
"unknown"
],
"x-profile-maxLength": "string_characters_max"
},
"period": {
"$ref": "#/components/schemas/Clocks"
},
"evidence": {
"$ref": "#/components/schemas/EvidenceSummary"
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "explanation_characters_max"
},
"x-profile-maxItems": "limitations_max"
},
"confidence": {
"$ref": "#/components/schemas/FactConfidence"
},
"acquisition_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"result_version": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"assignment_id",
"subject",
"taxonomy",
"taxonomy_version",
"code",
"label",
"method",
"primary",
"original_taxonomy",
"original_version",
"original_code",
"mapping_path",
"mapping_quality",
"period",
"evidence",
"limitations",
"confidence",
"acquisition_id",
"result_version"
],
"additionalProperties": false
}