Sign in

v1

latestOpenAPI 3.0.02026-08-06194226589.8 KB
Schemas

Create a new schema.

post/api/apps/{app}/schemas

Path parameters

appstring required

The name of the app.

Request body

fieldsInReferencesstring[] nullable

The names of the fields that should be used in references.

fieldsInListsstring[] nullable

The names of the fields that should be shown in lists, including meta fields.

previewUrlsobject nullable

The optional preview urls.

categorystring nullable

The category.

isPublishedboolean

Set it to true to autopublish the schema.

namestring required

The name of the schema.

type'Default' | 'Singleton' | 'Component'
isSingletonboolean

Set to true to allow a single content item only.

Response

Schema created.

_linksobject required

The links.

idstring required

The ID of the schema.

createdBystring required

The user that has created the schema.

lastModifiedBystring required

The user that has updated the schema.

namestring required

The name of the schema. Unique within the app.

type'Default' | 'Singleton' | 'Component' required
categorystring nullable

The name of the category.

isSingletonboolean required

Indicates if the schema is a singleton.

isPublishedboolean required

Indicates if the schema is published.

createdstring date-time required

The date and time when the schema has been created.

lastModifiedstring date-time required

The date and time when the schema has been modified last.

versioninteger required

The version of the schema.

previewUrlsobject required

The preview Urls.

fieldsInListsstring[] required

The name of fields that are used in content lists.

fieldsInReferencesstring[] required

The name of fields that are used in content references.