Function: getUiModifications()

function getUiModifications(
   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/uiModificationsApps.ts:19

Gets UI modifications. UI modifications can only be retrieved by Forge apps.

Permissions required: None.

The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ expand?: | "data" | string & object | "contexts" | ("data" | string & object | "contexts")[]; maxResults?: number; startAt?: number; }	-
parameters.expand?	| "data" | string & object | "contexts" | ("data" | string & object | "contexts")[]	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - data Returns UI modification data. - contexts Returns UI modification contexts.
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[]; }>