content/documentlists

Use the document lists resource to organize your site's documents into a hierarchy. Document lists can contain documents, folders, and complete hierarchies of folders, which contain documents with unique names.

JSON Example

DocumentList Properties

Property Description
documentListType

type: string

Properties for the document list type. Document lists contain documents with an associated document type, such as web pages.

documentTypes

type: list of string

List of document types associated with this document list.

enableActiveDateRanges

type: bool

If set, documents in this list will only be returned if the date queried for their is within their ActiveDateRange.

enablePublishing

type: bool

Indicates if the document list and document list type are enabled to publish. If true, publishing of draft documents in this document list/document list type is enabled for the site. If false, all document changes are immediately published in live mode.

listFQN

type: string

The fully qualified name of the document list.

metadata

type: Mozu.Core.Api.Contracts.Json

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

namespace

type: string

The namespace for the accessible APIs and source capabilities in the core of Kibo eCommerce APIs.

scopeId

type: int

The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id.

scopeType

type: string

The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.

Valid values are: "Tenant", "MasterCatalog", and "Site".

security

type: string

Indicates the security level for the document content as public, administrator, or owner.

supportsActiveDateRanges

type: bool

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.

supportsPublishing

type: bool

Indicates if modified documents are published automatically or saved to publish at a later time. If true, changed documents in this list can be saved as drafts until they are published to the site. If false, all document changes are immediately published in live mode. System-supplied and read only.

usages

type: list of string

A string array that determines where the document or entity list displays. The options are entityManager, for displaying content in the Custom Schema page in Admin, and siteBuilder, for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options:

"usages": ["siteBuilder", "entityManager"]

views

type: list of view

The view in the site used by associated entities or document lists/list types.

view.fields

type: list of viewField

The list of fields to display for a view or an associated schema. For example, the address schema would display fields for postal addresses.

view.viewField.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

view.viewField.target

type: string

Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property.

view.filter

type: string

Used to filter and refine queries, returning data that matches the filter query. If multiple filters are used, they are ANDed together in the query. Filters use expressions to locate content based on a field and operator, such as `cn `for contains.

view.includeInactiveMode

type: string

Specifies how to filter views based on the status of a document.

Note:  This property requires the following criteria before it takes effect:
  • The includeInactive parameter of the GetViewDocuments operation must be set to true. This parameter is always set to true whenever a view is requested through Admin. However, if you make a request for a view through the API (using the GetViewDocuments operation), you must set the parameter to true manually. If you set the includeInactive parameter to false or leave it blank instead, then only documents within the active date range (or documents without an active date range specified) return in the view.
  • The document list requested in the view must support active date ranges. If it does not have active date ranges enabled, then the includeInactiveMode property is ignored.

You can specify the following values for this property:

all or null—all documents return in the view.

active—only documents within the active date range (or documents without an active date range specified) return in the view.

scheduled—only documents with an active date range set in the future return in the view.

activeOrScheduled—only scheduled and active documents return in the view.

ended—only documents with an active date range set in the past return in the view.

view.isAdminDefault

type: bool

If true, specifies that the view is the default view for a documentList or documentListType when viewed in Admin. If no view is specified as default, then the first view in the documentList or documentListType is default. Only one view within a documentList or documentListType can have this value set to true.

view.isVisibleInStorefront

type: bool

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

view.metadata

type: Mozu.Core.Api.Contracts.Json

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

view.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

view.usages

type: list of string

A string array that determines where the document or entity list displays. The options are entityManager, for displaying content in the Custom Schema page in Admin, and siteBuilder, for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options:

"usages": ["siteBuilder", "entityManager"]

Operations

Operation Name Request URI Description
CreateDocumentList POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new documentList

DeleteDocumentList DELETE %7bdocumentListName%7d

Deletes the specified `DocumentListName`.

GetDocumentList GET %7bdocumentListName%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieve the details of a document list by providing the list name.

GetDocumentLists GET %3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a collection of document lists.

UpdateDocumentList PUT %7bdocumentListName%7d%3fresponseFields%3d%7bresponseFields%7d

Updates a `DocumentListName`.