Function: getScreens()

function getScreens(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/screens.ts:48

Returns a paginated list of all screens or those specified by one or more screen IDs.

Permissions required:Administer Jira global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; scope?: (string & object | "PROJECT" | "TEMPLATE" | "GLOBAL")[]; startAt?: number; }	-
parameters.id?	number[]	The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.orderBy?	"name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"	Order the results by a field: - id Sorts by screen ID. - name Sorts by screen name.
parameters.queryString?	string	String used to perform a case-insensitive partial match with screen name.
parameters.scope?	(string & object | "PROJECT" | "TEMPLATE" | "GLOBAL")[]	The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>