Schema Object


Properties
createdDatestringRead-onlyformat date-time

Date and time the translation schema was created.


displayNamestringmaxLength 100

Translation schema name displayed in the Translation Manager.


duplicateContentboolean

Whether to duplicate the translated content when a site containing the translation schema and content is duplicated.

Default: false


fieldsMap <string, SchemaField>minItems 1maxItems 1000format map

List of fields for the translation schema. This property uses a string to map to a SchemaField (Map<string, SchemaField>). The string serves as a key, which you'll need to access each field in the schema and when adding translation content.


hiddenboolean

Whether the translation schema is hidden from the site.

Default: false


idstringRead-onlyformat GUID

Translation schema ID.


keySchemaKey

Translation schema unique key identifier.


parentIdstringformat GUID

A reference to the parent schema. For example, if the schema is for a menu item, this property would contain the schema ID of the menu it belongs to.

Required when require_parent_entity is set to true.


previewFieldsPreviewFields

Fields displayed in content previews. For example, a product name for a product translation schema.


requireParentEntityboolean

Whether content created or updated with this schema must include a parent_entity_id. When set to true, any Create Content or Update Content call targeting this schema will fail if parent_entity_id is missing or empty.

The schema itself must also have a parent_id defined, otherwise the schema Create or Update call will fail with SchemaRequireParentEntityWithoutParentIdException.

Default: false

Example: A "menu-item" schema that always belongs to a "menu" parent schema would set require_parent_entity = true and parent_id to the "menu" schema ID. Every translation content item created for "menu-item" must then specify which menu it belongs to via parent_entity_id.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing revision must be used when updating a schema.


updatedDatestringRead-onlyformat date-time

Date and time the translation schema was updated.

Did this help?