Interface GetContentProperties

interface GetContentProperties {
    expand?: string[];
    id: string;
    key?: string[];
    limit?: number;
    start?: number;
}

Properties

expand? id key? limit? start?

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 its properties.

Optional key

key?: string[]

The key of the content property.

Optional limit

limit?: number

The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

Optional start

start?: number

The starting index of the returned properties.

Settings

Member Visibility

Theme

On This Page

expandidkeylimitstart

Generated using TypeDoc v0.25.12