jira.js
    Preparing search index...

    Function getWorkflowScheme

    • Returns a workflow scheme.

      Permissions required: Administer Jira global permission.

      Parameters

      • client: Client
      • parameters: { id: number; returnDraftIfExists?: boolean }
        • id: number

          The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

        • OptionalreturnDraftIfExists?: boolean

          Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              defaultWorkflow?: string;
              description?: string;
              draft?: boolean;
              id?: number;
              issueTypeMappings?: Record<string, any>;
              issueTypes?: Record<string, any>;
              lastModified?: string;
              lastModifiedUser?: {
                  accountId?: string;
                  accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              name?: string;
              originalDefaultWorkflow?: string;
              originalIssueTypeMappings?: Record<string, any>;
              self?: string;
              updateDraftIfNeeded?: boolean;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility