Create Document List Type

post https://t{tenantId}-s{siteId}.{env}.mozu.com/api/content/documentlistTypes

Create Document List Type. Creating a new documentListType will tell the Content service to immediately create a document list of the new type within the set scopeType. For instance, a scopeType of "site" will create a list in each site for the tenant. Any defaultDocuments defined for the type will be created within each list, which will be addressable via the type's fully qualified name (FQN) and will use the type's defined views, usages, and metadata by default.

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

name

string | null

The name component of the documentListTypeFQN, name@namespace. The name must be unique within the namespace component and cannot be updated.
Each documentList created from the documentListType will use this value.

namespace

string | null

The namespace component of the documentListTypeFQN, 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.
Each documentList created from the documentListType will use this value.

documentListTypeFQN

string | null

The unique identifier of the documentListType, represented by name@namespace. The documentListTypeFQN must be provided when creating the documentListType, or the name and namespace fields must be provided.
This field cannot be updated and each documentList created from the documentListType will use this value.

scopeType

string | null

The context level at which this documentListType will create documentLists. Valid values are "tenant", "masterCatalog", "catalog" and "site". This field is read-only after insert.

installationPackage

string | null

Optionally, a documentListType can be defined in an installationPackage and then installed into a tenant. Installed documentListsTypes 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.

defaultDocuments

array of objects | null

The definition of any documents to create when a documentList is created.

defaultDocuments

documentTypeFQNs

array of strings | null

The full names (name@namespace) of the types of documents that can be created within the documentLists belonging to this documentListType.
Each documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.

documentTypeFQNs

supportsPublishing

boolean

Determines if documentLists belonging to this documentListType will support drafting and publishing documents.
This field defaults to false and cannot be updated. Each documentList created from the documentListType will use this value.

enablePublishing

boolean | null

Determines if documentLists belonging to this documentListType have publishing turned on or off.
Each documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.

supportsActiveDateRanges

boolean

Determines if documentLists belonging to this documentListType will support drafting and ActiveDateRanges documents.
This field defaults to false and cannot be updated. Each documentList created from the documentListType will use this value.

enableActiveDateRanges

boolean | null

Determines if documentLists belonging to this documentListType have ActiveDateRanges turned on or off.
Each documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.

views

array of objects | null

An array of one or more views, which each allow GET access to a projection of fields from the documents in the given documentList.
Each documentList created from this documentListType will use this value, but it can be overridden in an individual documentList.

views

usages

array of strings | null

An array of strings that describes to the Mozu platform the manner(s) in which a documentList can be used. The following values are valid:
entitymanager -- the documentList should be visible in the Admin Content/Entities screen, which allows admin users to create, manage and publish documents within the documentList.
sitebuilder -- the documentList should be visible in Sitebuilder. A documentList will display in the Sitebuilder Navigation Content List node, which supports document creation, management and web cms integration.
Each documentList created from this documentListType will use this value, but it can be overridden in an individual documentList.

usages

metadata

string

Allows arbitrary data to be stored on the documentListType. Each documentList created from this documentListType will use this value,
but it can be overridden in an individual documentList.

Response

Response body

object

name

string | null

namespace

string | null

documentListTypeFQN

string | null

scopeType

string | null

The context level at which this documentListType will create documentLists. Valid values are "tenant", "masterCatalog", "catalog" and "site". This field is read-only after insert.

installationPackage

string | null

version

string | null

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

defaultDocuments

array of objects | null

The definition of any documents to create when a documentList is created.

defaultDocuments

object

name

string | null

The name of the document to create.

documentTypeFQN

string | null

The full name of the documentType that underlies this document.

properties

string

The properties of this document.

locale

string | null

tbd

documentTypeFQNs

array of strings | null

documentTypeFQNs

supportsPublishing

boolean

enablePublishing

boolean | null

supportsActiveDateRanges

boolean

enableActiveDateRanges

boolean | null

views

array of objects | null

views

object

name

string | null

A view is addressed via its name, which is unique within the documentList or documentListType in which it is defined.

usages

array of strings | null

tbd

usages

metadata

string

The metadata field allows arbitrary data to be stored on the view.

isVisibleInStorefront

boolean | null

The isVisibleInStorefront field indicates whether documents in the view can be accessed from the Mozu storefront application. If true, the storefront application and storefront client application (javascript tier)
can GET documents from the view.

filter

string | null

Filter criteria to apply automatically when documents from this view are accessed, using the standard Mozu filter syntax. Only documents matching the filter criteria will be returned.
Any filter provided by an operation is combined with the view filter.

includeInactiveMode

string | null

If view documents are requested with includeInactive=true, then this controls which documents return. If includeInactive is not provided or set to false, then only active documents return.
If not set, or set to "all", then all documents return.
If set to "active", then only documents within the active date range and documents with no active date range are returned.
If set to "scheduled", then only documents with an active date range in the future are returned.
If set to "activeOrScheduled", then only documents that are active or documents with an active date range in the future are returned.
If set to "ended", then only documents with an active date range in the past are returned.

isAdminDefault

boolean | null

fields

array of objects | null

Designation of which document fields are returned (projection) when GETing documents from the view.

fields

object

name

string | null

The name of the field projected into the view document, meaning the name given to the target field after it is projected.
The name must be unique within the list of viewFields provided in the view.

target

string | null

Specifies the document field to project. First-class fields will be returned on the document, but can be projected into the view properties.
Valid first-class fields include name, id, documentTypeFqn, listFqn and publishState. Dynamic fields within the properties field can be projected by prefixing the target string with "properties."
Example: "properties.property1". If a property is an object, then dot notation can be used to walk to particular subelements. Example: "properties.property1.subProperty1"
Individual array elements can be selected as well. Example: "properties.property1.subProperty1.subSubArray[2].propertyOnArrayItem"
Any target miss will result in a null value returning for the projected field.

usages

array of strings | null

usages

metadata

string

Allows arbitrary data to be stored on the documentListType. Each documentList created from this documentListType will use this value,
but it can be overridden in an individual documentList.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://t0-s0.sandbox.mozu.com/api/content/documentlistTypes \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success