ENTITY developer reference
DeliveryLimitGuidance
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.
One first violated limit, measured before unbounded materialisation. Do not fabricate byte causes for page/count/depth errors. Error envelope itself fits a reserved bounded error lane; unknown submitted effects retain their original operation. Account operation names cover the actual account request/response bound that failed; this schema is guidance, not permission to call an operation. Account input pagination errors use phase=input, constraint=array_items, actual declared limit and request_reduction=reduce_page_size, with no invented byte cause.
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.
operation_name
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for operation_name
{
"type": "string",
"enum": [
"cancelClassificationOrder",
"createClassificationAdjustmentRequest",
"createClassificationOrder",
"createClassificationQuote",
"getCapabilities",
"getClassificationAcquisition",
"getClassificationAdjustmentRequest",
"getClassificationOrder",
"getClassificationOrderItems",
"getClassificationQuote",
"getClassifications",
"getEntity",
"getEvidence",
"getFeedback",
"getHierarchy",
"getOperation",
"getReceipt",
"getRelationships",
"getUsage",
"listClassificationOffers",
"lookupIdentifier",
"resolveReference",
"searchCompanies",
"submitFeedback",
"supplyFeedbackEvidence"
],
"x-documentation-scope": "Public subset: 25 of 80 original members; 55 private account members withheld. This view does not replace the shared source enum."
}response_bytes_max
Listed in this schema’s required array.
Effective operation byte limit for delivery; null for an input or non-byte limit. constraint/limit is the actual first violated bound.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for response_bytes_max
{
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
],
"description": "Effective operation byte limit for delivery; null for an input or non-byte limit. constraint/limit is the actual first violated bound."
}request_reduction
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for request_reduction
{
"enum": [
"reduce_entities",
"reduce_page_size",
"narrow_graph",
"remove_optional_modules",
"contact_support",
"reduce_input",
"continue_after_omission"
]
}suggested_max_entities
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for suggested_max_entities
{
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"type": "null"
}
]
}explanation
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for explanation
{
"type": "string",
"minLength": 1,
"maxLength": 400
}phase
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for phase
{
"enum": [
"input",
"delivery"
]
}constraint
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for constraint
{
"enum": [
"encoded_bytes",
"json_nodes",
"json_depth",
"array_items",
"string_characters",
"attribution_count",
"lineage_count",
"source_clock_count"
]
}limit
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for limit
{
"type": "integer",
"minimum": 1
}location
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for location
{
"type": "string",
"minLength": 1,
"maxLength": 240
}adapter
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for adapter
{
"anyOf": [
{
"enum": [
"rest",
"mcp",
"all"
]
},
{
"type": "null"
}
]
}continuation_cursor
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for continuation_cursor
{
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 4096
},
{
"type": "null"
}
],
"x-profile-maxLength": "string_characters_max"
}skipped_contribution_id
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for skipped_contribution_id
{
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}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",
"additionalProperties": false,
"properties": {
"operation_name": {
"type": "string",
"enum": [
"cancelClassificationOrder",
"createClassificationAdjustmentRequest",
"createClassificationOrder",
"createClassificationQuote",
"getCapabilities",
"getClassificationAcquisition",
"getClassificationAdjustmentRequest",
"getClassificationOrder",
"getClassificationOrderItems",
"getClassificationQuote",
"getClassifications",
"getEntity",
"getEvidence",
"getFeedback",
"getHierarchy",
"getOperation",
"getReceipt",
"getRelationships",
"getUsage",
"listClassificationOffers",
"lookupIdentifier",
"resolveReference",
"searchCompanies",
"submitFeedback",
"supplyFeedbackEvidence"
],
"x-documentation-scope": "Public subset: 25 of 80 original members; 55 private account members withheld. This view does not replace the shared source enum."
},
"response_bytes_max": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
],
"description": "Effective operation byte limit for delivery; null for an input or non-byte limit. constraint/limit is the actual first violated bound."
},
"request_reduction": {
"enum": [
"reduce_entities",
"reduce_page_size",
"narrow_graph",
"remove_optional_modules",
"contact_support",
"reduce_input",
"continue_after_omission"
]
},
"suggested_max_entities": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"type": "null"
}
]
},
"explanation": {
"type": "string",
"minLength": 1,
"maxLength": 400
},
"phase": {
"enum": [
"input",
"delivery"
]
},
"constraint": {
"enum": [
"encoded_bytes",
"json_nodes",
"json_depth",
"array_items",
"string_characters",
"attribution_count",
"lineage_count",
"source_clock_count"
]
},
"limit": {
"type": "integer",
"minimum": 1
},
"location": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"adapter": {
"anyOf": [
{
"enum": [
"rest",
"mcp",
"all"
]
},
{
"type": "null"
}
]
},
"continuation_cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 4096
},
{
"type": "null"
}
],
"x-profile-maxLength": "string_characters_max"
},
"skipped_contribution_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"operation_name",
"response_bytes_max",
"request_reduction",
"suggested_max_entities",
"explanation",
"phase",
"constraint",
"limit",
"location",
"adapter",
"continuation_cursor",
"skipped_contribution_id"
],
"description": "One first violated limit, measured before unbounded materialisation. Do not fabricate byte causes for page/count/depth errors. Error envelope itself fits a reserved bounded error lane; unknown submitted effects retain their original operation. Account operation names cover the actual account request/response bound that failed; this schema is guidance, not permission to call an operation. Account input pagination errors use phase=input, constraint=array_items, actual declared limit and request_reduction=reduce_page_size, with no invented byte cause.",
"allOf": [
{
"if": {
"properties": {
"phase": {
"const": "input"
}
},
"required": [
"phase"
]
},
"then": {
"properties": {
"response_bytes_max": {
"type": "null"
},
"adapter": {
"type": "null"
},
"continuation_cursor": {
"type": "null"
},
"skipped_contribution_id": {
"type": "null"
}
}
}
},
{
"if": {
"properties": {
"continuation_cursor": {
"type": "string"
}
},
"required": [
"continuation_cursor"
]
},
"then": {
"properties": {
"operation_name": {
"const": "getEvidence"
},
"phase": {
"const": "delivery"
},
"request_reduction": {
"const": "continue_after_omission"
},
"skipped_contribution_id": {
"type": "string",
"format": "uuid"
}
}
},
"else": {
"properties": {
"skipped_contribution_id": {
"type": "null"
}
}
}
}
]
}