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
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { description?: string; name?: string; screens?: { create?: string; default?: string; edit?: string; view?: string; }; screenSchemeId: string; } | - |
parameters.description? | string | The description of the screen scheme. The maximum length is 255 characters. |
parameters.name? | string | The 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? | string | The ID of the create screen. To remove the screen association, pass a null. |
parameters.screens.default? | string | The ID of the default screen. When specified, must include a screen ID as a default screen is required. |
parameters.screens.edit? | string | The ID of the edit screen. To remove the screen association, pass a null. |
parameters.screens.view? | string | The ID of the view screen. To remove the screen association, pass a null. |
parameters.screenSchemeId? | string | The ID of the screen scheme. |
options? | RequestOptions | - |
Returns
Promise<void>