Skip to content

Function: updateScreenScheme() ​

ts
function updateScreenScheme(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/screenSchemes.ts:75

Updates a screen scheme. Only screen schemes used in classic projects can be updated.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; name?: string; screens?: { create?: string; default?: string; edit?: string; view?: string; }; screenSchemeId: string; }-
parameters.description?stringThe description of the screen scheme. The maximum length is 255 characters.
parameters.name?stringThe name of the screen scheme. The name must be unique. The maximum length is 255 characters.
parameters.screens?{ create?: string; default?: string; edit?: string; view?: string; }-
parameters.screens.create?stringThe ID of the create screen. To remove the screen association, pass a null.
parameters.screens.default?stringThe ID of the default screen. When specified, must include a screen ID as a default screen is required.
parameters.screens.edit?stringThe ID of the edit screen. To remove the screen association, pass a null.
parameters.screens.view?stringThe ID of the view screen. To remove the screen association, pass a null.
parameters.screenSchemeId?stringThe ID of the screen scheme.
options?RequestOptions-

Returns ​

Promise<void>