Skip to content

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 ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; name: string; screens: { create?: number; default: number; edit?: number; view?: number; }; }-
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?: number; default: number; edit?: number; view?: number; }-
parameters.screens.create?numberThe ID of the create screen.
parameters.screens.default?numberThe ID of the default screen. Required when creating a screen scheme.
parameters.screens.edit?numberThe ID of the edit screen.
parameters.screens.view?numberThe ID of the view screen.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; id: number; }>