Function: updateWorkflowScheme()

function updateWorkflowScheme(
   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:87

Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by a project). Values not appearing the body will not be touched.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body: { 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; }; id: number; }	-
parameters.body	{ 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.body.defaultWorkflow?	string	-
parameters.body.description?	string	-
parameters.body.draft?	boolean	-
parameters.body.id?	number	-
parameters.body.issueTypeMappings?	Record<string, string>	-
parameters.body.issueTypes?	Record<string, { avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>	-
parameters.body.lastModified?	string	-
parameters.body.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.body.lastModifiedUser.active?	boolean	-
parameters.body.lastModifiedUser.applicationRoles?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.lastModifiedUser.applicationRoles.callback?	Record<string, never>	-
parameters.body.lastModifiedUser.applicationRoles.maxResults?	number	-
parameters.body.lastModifiedUser.applicationRoles.pagingCallback?	Record<string, never>	-
parameters.body.lastModifiedUser.applicationRoles.size?	number	-
parameters.body.lastModifiedUser.avatarUrls?	Record<string, string>	-
parameters.body.lastModifiedUser.deleted?	boolean	-
parameters.body.lastModifiedUser.displayName?	string	-
parameters.body.lastModifiedUser.emailAddress?	string	-
parameters.body.lastModifiedUser.expand?	string	-
parameters.body.lastModifiedUser.groups?	{ callback?: Record<string, never>; maxResults?: number; pagingCallback?: Record<string, never>; size?: number; }	-
parameters.body.lastModifiedUser.groups.callback?	Record<string, never>	-
parameters.body.lastModifiedUser.groups.maxResults?	number	-
parameters.body.lastModifiedUser.groups.pagingCallback?	Record<string, never>	-
parameters.body.lastModifiedUser.groups.size?	number	-
parameters.body.lastModifiedUser.key?	string	-
parameters.body.lastModifiedUser.lastLoginTime?	string	-
parameters.body.lastModifiedUser.locale?	string	-
parameters.body.lastModifiedUser.name?	string	-
parameters.body.lastModifiedUser.self?	string	-
parameters.body.lastModifiedUser.timeZone?	string	-
parameters.body.name?	string	-
parameters.body.originalDefaultWorkflow?	string	-
parameters.body.originalIssueTypeMappings?	Record<string, string>	-
parameters.body.self?	string	-
parameters.body.updateDraftIfNeeded?	boolean	-
parameters.id?	number	The id of the scheme.
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; }>