Skip to main content
PUT
/
content
/
documenttypes
/
{documentTypeName}
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "namespace": "<string>",
  "documentTypeFQN": "<string>",
  "adminName": "<string>",
  "installationPackage": "<string>",
  "version": "<string>",
  "metadata": "<unknown>",
  "properties": [
    {
      "name": "<string>",
      "isRequired": true,
      "isMultiValued": true,
      "propertyType": {
        "name": "<string>",
        "namespace": "<string>",
        "propertyTypeFQN": "<string>",
        "adminName": "<string>",
        "installationPackage": "<string>",
        "version": "<string>",
        "dataType": "<string>",
        "isQueryable": true,
        "isSortable": true,
        "isAggregatable": true
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
documentTypeName
string
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

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

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

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

​
adminName
string | null

The administrative name of the documentType.

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

​
version
string | null

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

​
metadata
any | null

Allows arbitrary data to be stored on the documentType.

​
properties
object[] | null

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

Response

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

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

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

​
adminName
string | null

The administrative name of the documentType.

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

​
version
string | null

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

​
metadata
any | null

Allows arbitrary data to be stored on the documentType.

​
properties
object[] | null

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