Function: createScreenScheme()
ts
function createScreenScheme(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
id: number;
}>;Defined in: src/cloud/api/screenSchemes.ts:49
Creates a screen scheme.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { description?: string; name: string; screens: { create?: number; default: number; edit?: number; view?: number; }; } | - |
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?: number; default: number; edit?: number; view?: number; } | - |
parameters.screens.create? | number | The ID of the create screen. |
parameters.screens.default? | number | The ID of the default screen. Required when creating a screen scheme. |
parameters.screens.edit? | number | The ID of the edit screen. |
parameters.screens.view? | number | The ID of the view screen. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; id: number; }>