jira.js
    Preparing search index...

    Function updateWorkflowScheme

    • 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

      • 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;
                        [key: string]: unknown;
                    },
                >;
                lastModified?: string;
                lastModifiedUser?: {
                    active?: boolean;
                    applicationRoles?: {
                        callback?: { [key: string]: unknown };
                        maxResults?: number;
                        pagingCallback?: { [key: string]: unknown };
                        size?: number;
                        [key: string]: unknown;
                    };
                    avatarUrls?: Record<string, string>;
                    deleted?: boolean;
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: { [key: string]: unknown };
                        maxResults?: number;
                        pagingCallback?: { [key: string]: unknown };
                        size?: number;
                        [key: string]: unknown;
                    };
                    key?: string;
                    lastLoginTime?: string;
                    locale?: string;
                    name?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                name?: string;
                originalDefaultWorkflow?: string;
                originalIssueTypeMappings?: Record<string, string>;
                self?: string;
                updateDraftIfNeeded?: boolean;
                [key: string]: unknown;
            };
            id: number;
        }
        • 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;
                      [key: string]: unknown;
                  },
              >;
              lastModified?: string;
              lastModifiedUser?: {
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  avatarUrls?: Record<string, string>;
                  deleted?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  key?: string;
                  lastLoginTime?: string;
                  locale?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              name?: string;
              originalDefaultWorkflow?: string;
              originalIssueTypeMappings?: Record<string, string>;
              self?: string;
              updateDraftIfNeeded?: boolean;
              [key: string]: unknown;
          }
        • id: number

          The id of the scheme.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              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;
                      [key: string]: unknown;
                  },
              >;
              lastModified?: string;
              lastModifiedUser?: {
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  avatarUrls?: Record<string, string>;
                  deleted?: boolean;
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      maxResults?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  key?: string;
                  lastLoginTime?: string;
                  locale?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              name?: string;
              originalDefaultWorkflow?: string;
              originalIssueTypeMappings?: Record<string, string>;
              self?: string;
              updateDraftIfNeeded?: boolean;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility