Data Extension Schema Object


Properties
idstringRead-onlyformat GUID

Schema ID.


fqdnstringmaxLength 255

FQDN of the entity this schema extends.


namespacestringmaxLength 164

Namespace for this schema. For example, an app creating schemas might use their app name as a namespace. When a site owner creates a user-defined schema, the namespace is: _user_fields.


jsonSchemastruct

Schema definition in JSON schema format with the following vocab extension:

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://wixapis.com/v1/json-schema/extensions", "$vocabulary": { "https://wixapis.com/v1/json-schema/extensions/vocab/data-extensions": true }, "$dynamicAnchor": "meta", "title": "Wix' data-extensions vocabulary meta schema", "type": [ "object", "boolean" ], "properties": { "x-wix-permissions": { "type": "object", "description": "list of identity types that are allowed reading schema properties", "properties": { "read": { "type": "array", "items": { "type": "string", "enum": [ "apps", "owning-app", "users", "users-of-users" ] } }, "write": { "type": "array", "items": { "type": "string", "enum": [ "apps", "owning-app", "users", "users-of-users" ] } } } }, "x-wix-display": { "type": "object", "description": "field display properties", "schema": { "properties": { "placeholder": { "type": "string", "maxLength": 255, "description": "placeholder text for input fields" }, "label": { "type": "string", "maxLength": 255, "description": "label of the input fields" }, "hint": { "type": "string", "maxLength": 255, "description": "a short explanation that appears next to the input field" } } } } } }

updatedDatestringRead-onlyformat date-time

Date and time the schema was last updated.


createdDatestringRead-onlyformat date-time

Date and time the schema was created.


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.


maxLimitBytesintegerRead-onlyformat int32

Maximum allowed schema size in bytes.


currentSizeBytesintegerRead-onlyformat int32

Current schema size in bytes.


extensionPointstringmaxLength 20

Name of the specific entity field this schema is extending, or "ROOT" for extensions for the entire entity. Default: "ROOT".

Did this help?