content/documenttypes

Use the Document Types resource to view the document types supplied by the Content API.

JSON Example

DocumentType Properties

Property Description
adminName

type: string

The administrator name associated with the object/data.

documentTypeFQN

type: string

Fully qualified name of the document type.

installationPackage

type: string

The package of document lists and content documents to be installed.

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.

properties

type: list of property

Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.

property.isMultiValued

type: bool

If true, the attribute can have more than one value.

property.isRequired

type: bool

Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value.

property.name

type: string

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

property.propertyType

type: propertyType

Property type available for content. Property types are like templates that can be reused.

property.propertyType.adminName

type: string

The administrator name associated with the object/data.

property.propertyType.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

property.propertyType.installationPackage

type: string

The package of document lists and content documents to be installed.

property.propertyType.isAggregatable

type: bool

If true, this entity can be grouped.

property.propertyType.isQueryable

type: bool

Indicates if the entity can be located and returned in a search, used for fields and property types. If true, the entity can be searched.

property.propertyType.isSortable

type: bool

Indicates if the fields or property types are sortable on the page. If true, the property type results are sortable. If false, the property type results cannot be sorted by any options.

property.propertyType.name

type: string

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

property.propertyType.namespace

type: string

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

property.propertyType.propertyTypeFQN

type: string

The fully qualified name for the property type for content.

property.propertyType.version

type: string

The current version number of the order, wish list, document list, or document type list.

version

type: string

The current version number of the order, wish list, document list, or document type list.

Operations

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

Creates a new DocumentType

GetDocumentType GET %7bdocumentTypeName%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a system-defined document type.

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

Retrieves a paged list of the system-defined document types.

UpdateDocumentType PUT %7bdocumentTypeName%7d%3fresponseFields%3d%7bresponseFields%7d

Updates a DocumentType