Schema Object


Properties
idstringRead-onlyformat GUID

Translation schema ID.


keyKey

Translation schema unique key identifier.


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.


previewFieldsPreviewFields

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


hiddenboolean

Whether the translation schema is hidden from the site.

Default: false


displayNamestringmaxLength 100

Translation schema name displayed in the Translation Manager.


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.


revisionintegerRead-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.


createdDatestringRead-onlyformat date-time

Date and time the translation schema was created.


updatedDatestringRead-onlyformat date-time

Date and time the translation schema was updated.


duplicateContentboolean

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

Default: false

Schema
JSON
{ "schema": { "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "revision": 1, "createdDate": "2019-10-30T17:22:10.299Z", "updatedDate": "2019-10-30T17:22:10.299Z", "key": { "appId": "4ad2dfe1-a943-45a8-94ac-f1dd8b78821b", "entityType": "Product", "scope": "GLOBAL" }, "fields": { "title": { "id": "title", "type": "SHORT_TEXT", "display_name": "Title", "minLength": 1, "maxLength": 54, "hidden": false, "displayOnly": false }, "description": { "id": "description", "type": "RICH_CONTENT", "display_name": "Description", "minLength": 1, "maxLength": 256, "hidden": false, "displayOnly": false }, "image()": { "id": "image()", "type": "IMAGE", "displayName": "Product's Image", "minLength": null, "maxLength": null, "hidden": false, "displayOnly": false } } } }
Did this help?