Interface GetFieldsPaginated

interface GetFieldsPaginated {
    expand?: string | string[] | ("key" | "lastUsed" | "screensCount" | "isLocked" | "searcherKey")[];
    id?: string[];
    maxResults?: number;
    orderBy?: string;
    query?: string;
    startAt?: number;
    type?: string[];
}

Properties

expand? id? maxResults? orderBy? query? startAt? type?

Properties

Optional expand

expand?: string | string[] | ("key" | "lastUsed" | "screensCount" | "isLocked" | "searcherKey")[]

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • key returns the key for each field
  • lastUsed returns the date when the value of the field last changed
  • screensCount returns the number of screens related to a field contextsCount returns the number of contexts related to a field
  • isLocked returns information about whether the field is locked
  • searcherKey returns the searcher key for each custom field

Optional id

id?: string[]

The IDs of the custom fields to return or, where query is specified, filter.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional orderBy

orderBy?: string

Order the results by a field:

  • contextsCount sorts by the number of contexts related to a field
  • lastUsed sorts by the date when the value of the field last changed
  • name sorts by the field name
  • screensCount sorts by the number of screens related to a field

Optional query

query?: string

String used to perform a case-insensitive partial match with field names or descriptions.

Optional startAt

startAt?: number

The index of the first item to return in a page of results (page offset).

Optional type

type?: string[]

The type of fields to search.

Settings

Member Visibility

Theme

On This Page

expandidmaxResultsorderByquerystartAttype