Function: getScreensForField()

function getScreensForField(
   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:21

Returns a paginated list of the screens a field is used in.

Permissions required:Administer Jira global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: string & object | "tab" | (string & object | "tab")[]; fieldId: string; maxResults?: number; startAt?: number; }	-
parameters.expand?	string & object | "tab" | (string & object | "tab")[]	Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.
parameters.fieldId?	string	The ID of the field to return screens for.
parameters.maxResults?	number	The maximum number of items to return per page.
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[]; }>