Update Document List

put https://t{tenantId}-s{siteId}.{env}.mozu.com/api/content/documentlists/{documentListName}

Update Document List. The document list can only be accessed if the API context is inclusive of the document list's scope. A document list always belongs to a tenant context, denoted by the scopeType and scopeId fields. For example, if a list belongs to Catalog 123 then it is denoted by scopeType=catalog and scopeId=123.

Path Params

documentListName

string

required

The name of the documentList to update

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

Content Collection values to apply

name

string | null

The name component of the listFQN, name@namespace. The name must be unique within the namespace component and cannot be updated.
If the documentList is based on a documentListType, then this value will be derived from the documentListType.

namespace

string | null

The namespace component of the listFQN, 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.
If the documentList is based on a documentListType, then this value will be derived from the documentListType.

listFQN

string | null

The unique identifier of the documentList, represented by name@namespace. The listFQN must be provided when creating the documentList, or the name and namespace fields must be provided.
If the documentList is based on a documentListType, then this value will be derived from the documentListType.

documentTypes

array of strings | null

An array of the full names (name@namespace) of the documentTypes supported by the documentList. A document in the documentList must belong to one of these documentTypes.
If the documentList is based on a documentListType, then this value will be derived from the documentListType. DocumentTypes can be added/removed to the documentList, even when
based on a documentListType. Existing documents that belong to a documentType removed from the documentList will not be removed.

documentTypes

supportsPublishing

boolean | null

Determines if the documentList will support drafting and publishing documents.
This field defaults to false and cannot be updated.
If the documentList is based on a documentListType, then this value will be derived from the documentListType.

enablePublishing

boolean | null

Determines if the documentList has publishing turned on or off. If the documentList has a supportsPublishing value of true, then the enablePublishing value will be honored.
If enablePublishing is true, then a document draft will be created for a document create or update operation. A document must then be published to become "active".
If enablePublish is false, then all document changes are immediately "active".
If enablePublish is true, then updating it to false will immediately publish all draft changes.
If the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.

supportsActiveDateRanges

boolean | null

Determines if the documentList will support ranges of dates that documents are considered 'active'.
This field defaults to false and cannot be updated.
If the documentList is based on a documentListType, then this value will be derived from the documentListType.

enableActiveDateRanges

boolean | null

Determines if the documentList has ActiveDateRanges turned on or off. If the documentList has a supportsActiveDateRanges value of true, then the enableActiveDateRanges value will be honored.
If enableActiveDateRanges is true, then a document will only be returned if the request is made within the time frame the document has been set to be 'active'.
If enableActiveDateRanges is false, then the properties can be set but will not be honored.
If enableActiveDateRanges is true, then updating it to false will immediately start honoring the previously-set date range.
If the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.

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.
If the documentList is based on a documentListType, then this value will be derived from the documentListType. Views can be added/removed to the documentList, even when
the documentList derives from a documentListType.

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 UI, which allows admin users to create, manage and publish documents within the documentList.
sitebuilder -- the documentList should be visible in Site Builder. A documentList will display in the Site Builder Navigation Content List node, which supports document creation, management and web cms integration.
If the documentList is based on a documentListType, then this value will be derived from the documentListType. Usages can be added or removed from the documentList, even when the documentList derives from a
documentListType.

usages

security

string | null

tbd

scopeId

int32 | null

Used in conjunction with the scopeType field to determine the exact context within which the documentList resides.
Example: A documentList with a scopeId of 5 and scopeType of masterCatalog belongs to masterCatalog 5.
If the documentList is based on a documentListType, then this value will be derived from the documentListType. This value is read-only after the documentList is created.

scopeType

string | null

The context level the documentList resides in. Valid values are "tenant", "masterCatalog", "catalog" and "site". This field is used in conjunction with the scopeId field
to determine the exact context within which this documentList resides. This field is read-only after insert.
If the documentList is based on a documentListType, then this value will be derived from the documentListType. This value is read-only after the documentList is created.

documentListType

string | null

The full name of the documentListType (name@namespace) that underlies the documentList. This value is only populated when the Mozu platform creates a documentList from a documentListType.
A documentList that is directly created cannot specify a documentListType. This field is therefore read-only.

metadata

string

Allows arbitrary data to be stored on the documentList.
If the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.

Response

Response body

object

name

string | null

namespace

string | null

listFQN

string | null

documentTypes

array of strings | null

documentTypes

supportsPublishing

boolean | null

enablePublishing

boolean | null

supportsActiveDateRanges

boolean | null

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

security

string | null

tbd

scopeId

int32 | null

scopeType

string | null

documentListType

string | null

metadata

string

Allows arbitrary data to be stored on the documentList.
If the documentList is based on a documentListType, then this value will be derived from the documentListType, but can be overridden on update.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://t0-s0.sandbox.mozu.com/api/content/documentlists/documentListName \
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