Interface GetScreens

interface GetScreens {
    id?: number[];
    maxResults?: number;
    orderBy?: string;
    queryString?: string;
    scope?: string[];
    startAt?: number;
}

Properties

id? maxResults? orderBy? queryString? scope? startAt?

Properties

Optional id

id?: number[]

The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional orderBy

orderBy?: string

Order the results by a field:

  • id Sorts by screen ID.
  • name Sorts by screen name.

Optional queryString

queryString?: string

String used to perform a case-insensitive partial match with screen name.

Optional scope

scope?: string[]

The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.

Optional startAt

startAt?: number

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

Settings

Member Visibility

Theme

On This Page

idmaxResultsorderByqueryStringscopestartAt