Function: createScheme()

function createScheme(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Defined in: src/server/api/workflowSchemes.ts:36

Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

Parameters

Parameter	Type
client	Client
parameters	{ defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>; lastModified?: string; lastModifiedUser?: { active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }
parameters.defaultWorkflow?	string
parameters.description?	string
parameters.draft?	boolean
parameters.id?	number
parameters.issueTypeMappings?	Record<string, string>
parameters.issueTypes?	Record<string, { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>
parameters.lastModified?	string
parameters.lastModifiedUser?	{ active?: boolean; applicationRoles?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }
parameters.lastModifiedUser.active?	boolean
parameters.lastModifiedUser.applicationRoles?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }
parameters.lastModifiedUser.applicationRoles.callback?	Record<string, never>
parameters.lastModifiedUser.applicationRoles.maxResults?	number
parameters.lastModifiedUser.applicationRoles.pagingCallback?	Record<string, never>
parameters.lastModifiedUser.applicationRoles.size?	number
parameters.lastModifiedUser.avatarUrls?	Record<string, string>
parameters.lastModifiedUser.deleted?	boolean
parameters.lastModifiedUser.displayName?	string
parameters.lastModifiedUser.emailAddress?	string
parameters.lastModifiedUser.expand?	string
parameters.lastModifiedUser.groups?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }
parameters.lastModifiedUser.groups.callback?	Record<string, never>
parameters.lastModifiedUser.groups.maxResults?	number
parameters.lastModifiedUser.groups.pagingCallback?	Record<string, never>
parameters.lastModifiedUser.groups.size?	number
parameters.lastModifiedUser.key?	string
parameters.lastModifiedUser.lastLoginTime?	string
parameters.lastModifiedUser.locale?	string
parameters.lastModifiedUser.name?	string
parameters.lastModifiedUser.self?	string
parameters.lastModifiedUser.timeZone?	string
parameters.name?	string
parameters.originalDefaultWorkflow?	string
parameters.originalIssueTypeMappings?	Record<string, string>
parameters.self?	string
parameters.updateDraftIfNeeded?	boolean
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }>