Interface GetContentProperty

interface GetContentProperty {
    expand?: string[];
    id: string;
    key: string;
    status?: string[];
}

Properties

expand? id key status?

Properties

Optional expand

expand?: string[]

A multi-value parameter indicating which properties of the content to expand. By default, the version object is expanded.

  • content returns the content that the property is stored against.
  • version returns information about the version of the property, such as the version number, when it was created, etc.

id

id: string

The ID of the content to be queried for the property.

key

key: string

The key of the content property.

Optional status

status?: string[]

Filter the results to a set of content based on their status. If set to any, content with any status is returned. By default it will fetch current and archived statuses ?status=current&status=archived. All supported statuses

  • Any
  • Archived
  • Current
  • Deleted
  • Draft
  • Trashed

Settings

Member Visibility

Theme

On This Page

expandidkeystatus

Generated using TypeDoc v0.25.12