Interface ReleaseQueryOptions

interface ReleaseQueryOptions {
    entities.sys.id[in]?: string;
    entities.sys.linkType?: string;
    entities[exists]?: boolean;
    limit?: number;
    order?: string;
    pageNext?: string;
    sys.createdBy.sys.id[in]?: string;
    sys.id[in]?: string;
    sys.id[nin]?: string;
    sys.schemaVersion?: "Release.v1" | "Release.v2";
    sys.status[in]?: ReleaseStatus;
    sys.status[nin]?: ReleaseStatus;
    title[match]?: string;
}

Properties

entities.sys.id[in]? entities.sys.linkType? entities[exists]? limit? order? pageNext? sys.createdBy.sys.id[in]? sys.id[in]? sys.id[nin]? sys.schemaVersion? sys.status[in]? sys.status[nin]? title[match]?

Properties

Optionalentities.sys.id[in]

entities.sys.id[in]?: string

Find releases containing the specified, comma-separated entities. Requires entities.sys.linkType

Optionalentities.sys.linkType

entities.sys.linkType?: string

Find releases filtered by the Entity type (Asset, Entry)

Optionalentities[exists]

entities[exists]?: boolean

Filter by empty Releases (exists=false) or Releases with items (exists=true)

Optionallimit

limit?: number

Limit how many records are returned in the result

Default

100

Optionalorder

order?: string

Order releases Supported values include

  • title, -title
  • sys.updatedAt, -sys.updatedAt
  • sys.createdAt, -sys.createdAt

Default

-sys.updatedAt

OptionalpageNext

pageNext?: string

If present, will return results based on a pagination cursor

Optionalsys.createdBy.sys.id[in]

sys.createdBy.sys.id[in]?: string

Comma-separated list of user Ids to find releases by creator

Optionalsys.id[in]

sys.id[in]?: string

Comma-separated list of Ids to find (inclusion)

Optionalsys.id[nin]

sys.id[nin]?: string

Comma-separated list of ids to exclude from the query

Optionalsys.schemaVersion

sys.schemaVersion?: "Release.v1" | "Release.v2"

Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases.

Optionalsys.status[in]

sys.status[in]?: ReleaseStatus

Comma-separated filter (inclusion) by Release status (active, archived)

Optionalsys.status[nin]

sys.status[nin]?: ReleaseStatus

Comma-separated filter (exclusion) by Release status (active, archived)

Optionaltitle[match]

title[match]?: string

Find releases using full text phrase and term matching

Settings

Member Visibility

On This Page

Properties