Create Document Type

Create Document Type. All documents have a Document Type that describes the schema that the document must implement and its associated metadata, and is validated whenever a document is created or modified. The immutable types defined out-of-the-box are web_page, entityEditor, document, image, snippets, productContent, categoryContent, pageTemplateContent, emailTemplateContent, and folder.

POST /content/documenttypes

Error

A valid request URL is required to generate request examples

200

{
  "adminName": "<string>",
  "documentTypeFQN": "<string>",
  "installationPackage": "<string>",
  "metadata": "<unknown>",
  "name": "<string>",
  "namespace": "<string>",
  "properties": [
    {
      "isMultiValued": true,
      "isRequired": true,
      "name": "<string>",
      "propertyType": {
        "adminName": "<string>",
        "dataType": "<string>",
        "installationPackage": "<string>",
        "isAggregatable": true,
        "isQueryable": true,
        "isSortable": true,
        "name": "<string>",
        "namespace": "<string>",
        "propertyTypeFQN": "<string>",
        "version": "<string>"
      }
    }
  ],
  "version": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/jsonapplication/octet-streamtext/plain

The schema a document must implement and associated metadata. A documentType is created at a tenant scope and is therefore shared amongst all child contexts (masterCatalog, catalog, site).

adminName · string | null

The administrative name of the documentType.

documentTypeFQN · string | null

The unique identifier of the documentType, represented by name@namespace. The documentTypeFQN must be provided when creating the documentType, or the name and namespace fields must be provided.

installationPackage · string | null

Optionally, a documentType can be defined in an installationPackage and then installed into a tenant. Installed documentTypes can only be updated via installation upgrades. Currently only internal Mozu platform components can create installations. This field is system-supplied and read-only.

metadata · any | null

Allows arbitrary data to be stored on the documentType.

name · string | null

The name component of the documentType, name@namespace. The name must be unique within the namespace component and cannot be updated.

namespace · string | null

The namespace component of the documentType, name@namespace. The issued dev account namespace must be used unless elevated privileges allow a blank namespace to be used. The namespace cannot be updated.

properties · object[] | null

An array of the schema elements that a document implementing this documentType will have.

Show child attributes

version · string | null

The version of the installationPackge installed. This field is read-only.

Response

200

application/json

Success

The schema a document must implement and associated metadata. A documentType is created at a tenant scope and is therefore shared amongst all child contexts (masterCatalog, catalog, site).

adminName · string | null

The administrative name of the documentType.

documentTypeFQN · string | null

The unique identifier of the documentType, represented by name@namespace. The documentTypeFQN must be provided when creating the documentType, or the name and namespace fields must be provided.

installationPackage · string | null

Optionally, a documentType can be defined in an installationPackage and then installed into a tenant. Installed documentTypes can only be updated via installation upgrades. Currently only internal Mozu platform components can create installations. This field is system-supplied and read-only.

metadata · any | null

Allows arbitrary data to be stored on the documentType.

name · string | null

The name component of the documentType, name@namespace. The name must be unique within the namespace component and cannot be updated.

namespace · string | null

The namespace component of the documentType, name@namespace. The issued dev account namespace must be used unless elevated privileges allow a blank namespace to be used. The namespace cannot be updated.

properties · object[] | null

An array of the schema elements that a document implementing this documentType will have.

Show child attributes

version · string | null

The version of the installationPackge installed. This field is read-only.