ENTITY developer reference
SourceAttribution
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.
Required licence credit for information actually delivered. applies_to uses RFC6901 JSON Pointers relative to the public response data object, separately authorised GraphQL response data object or individual separately authorised private-integration record; export companions use /rows/{zero-based-row-index}/{column}. Each pointer must resolve to a permitted delivered value. Group only identical source/dataset/licence/date/treatment. Use the actual information-update date, not response time. Credit is not official endorsement; exact completeness is checked against admitted provenance.
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.
source
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for source
{
"type": "string",
"minLength": 1,
"maxLength": 120
}dataset
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for dataset
{
"type": "string",
"minLength": 1,
"maxLength": 120
}licence_ref
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for licence_ref
{
"type": "string",
"minLength": 1,
"maxLength": 240
}source_last_updated
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for source_last_updated
{
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"precision": {
"const": "date"
},
"value": {
"type": "string",
"format": "date",
"maxLength": 10
}
},
"required": [
"precision",
"value"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"precision": {
"const": "instant"
},
"value": {
"type": "string",
"format": "date-time",
"maxLength": 35
}
},
"required": [
"precision",
"value"
]
}
]
}applies_to
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for applies_to
{
"type": "array",
"minItems": 1,
"maxItems": 100000,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 240,
"pattern": "^(?:/(?:[^~/]|~[01])*)+$"
},
"x-profile-maxItems": "json_nodes_max"
}treatment
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for treatment
{
"enum": [
"source_information",
"derived_information"
]
}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": {
"source": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"dataset": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"licence_ref": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"source_last_updated": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"precision": {
"const": "date"
},
"value": {
"type": "string",
"format": "date",
"maxLength": 10
}
},
"required": [
"precision",
"value"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"precision": {
"const": "instant"
},
"value": {
"type": "string",
"format": "date-time",
"maxLength": 35
}
},
"required": [
"precision",
"value"
]
}
]
},
"applies_to": {
"type": "array",
"minItems": 1,
"maxItems": 100000,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 240,
"pattern": "^(?:/(?:[^~/]|~[01])*)+$"
},
"x-profile-maxItems": "json_nodes_max"
},
"treatment": {
"enum": [
"source_information",
"derived_information"
]
}
},
"required": [
"source",
"dataset",
"licence_ref",
"source_last_updated",
"applies_to",
"treatment"
],
"description": "Required licence credit for information actually delivered. applies_to uses RFC6901 JSON Pointers relative to the public response data object, separately authorised GraphQL response data object or individual separately authorised private-integration record; export companions use /rows/{zero-based-row-index}/{column}. Each pointer must resolve to a permitted delivered value. Group only identical source/dataset/licence/date/treatment. Use the actual information-update date, not response time. Credit is not official endorsement; exact completeness is checked against admitted provenance."
}