Sustema

ENTITY developer reference

LocalizedText

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.

text

Listed in this schema’s required array.

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

language

Listed in this schema’s required array.

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

script

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for script
{
  "anyOf": [
    {
      "type": "string",
      "pattern": "^[A-Z][a-z]{3}$",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

representation

Listed in this schema’s required array.

Declared type
"string"
Reading definition for representation
{
  "type": "string",
  "enum": [
    "original",
    "translation",
    "transliteration"
  ],
  "x-profile-maxLength": "string_characters_max"
}

native_text

Listed in this schema’s required array.

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

transformation_ref

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for transformation_ref
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "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",
  "properties": {
    "text": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "language": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "script": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[A-Z][a-z]{3}$",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "representation": {
      "type": "string",
      "enum": [
        "original",
        "translation",
        "transliteration"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "native_text": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "transformation_ref": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "text",
    "language",
    "script",
    "representation",
    "native_text",
    "transformation_ref"
  ],
  "additionalProperties": false
}

All API operations