Content Types

Id of the author user.

Name of the author user.

Username of the author user.

Provide Content Context to filter result

The locale used in the context.

Additional, unspecified attributes.

Id of the field.

The unique name of the field.

The type of this content field such as STRING or HTML.

When the type is REFERENCE, this field holds the type of entity this field links to such as PRODUCT or CONTENT.

When the referenceType is CONTENT, this field holds allowed content models. If empty, allows all.

Whether this field represents a collections

Whether the related FieldData requires a value.

Help text to display on the field (appears as a ? icon by the field that can be hovered over).

Hint text to display below the field in the admin (appears beneath the field, always visible).

The display order of this field in relation to other fields.

Additional attributes needed to further define this field.

The item’s ID.

A unique name for the item.

The content model for this content.

SEO-friendly URI to identify this content item. This will be appended to the parent ContentModel’s uri and used if the model is addressableByUri.

The individual field data for this content

Defines the beginning time for which this content item is active.

Defines the ending time for which this content item is active.

Information on the user who created this item.

Id of the model.

The unique name of this model.

Whether all of this model can be retrieved by navigating to #uri from a storefront app. For example, navigating to /blogs would result in all Content Items using the "Blog" model being fetching. Moreover, those content items would have their own URIs that would be appended to the model’s, e.g., /:ContentModel.uri/:ContentItem.uri.

SEO-friendly URI to retrieve ContentItems of this model.

The list of fields that make up this content model.

Name of the [ContentZone] to retrieve ContentItems for.

<p> If present, all other request attributes will be ignored.

Names of ContentItems to retrieve.

<p> If uri, itemIds, modelId, or modelName are present, then this will be ignored.

Ids of ContentItems to retrieve.

<p> If uri, modelId, or modelName are present, then this will be ignored. If this is present, then itemNames will be ignored.

Name of a ContentModel all of whose ContentItems to retrieve.

<p> If present, itemIds and itemNames will be ignored will be ignored. If uri or modelId are present, then this will be ignored.

Id of a ContentModel all of whose ContentItems to retrieve.

<p> If present, modelId, itemIds, and itemNames will be ignored will be ignored. If uri is present, then this will be ignored.

Pagination options to use on the result set. If not provided, a list of all results will be returned instead.

URI of either a ContentModel all of whose ContentItems should be retrieved or else that of a single ContentItem. In the latter case, the parent ContentModel’s uri should be appended in the request.

Any additional params.

Unpaginated list of results. Only present if no pagination params were present in the request.

Paginated results. Only present if pagination params were present in the request.

Any requested names that did not match active content.

Any requested ids that did not match active content.

Whether any results are present.

Id of the field.

The parent ContentItem. Usually this just contains the item’s ID and not the full projection.

The name of the field.

The value of the field.

Map from theme field group name to another map of theme field names to values. E.g., { 'colors': { 'button-primary': 'black' } }.