jira.js
    Preparing search index...

    Function getRequiredWorkflowSchemeMappings

    • Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.

      Permissions required:

      • Administer Jira permission to update all, including global-scoped, workflow schemes.
      • Administer projects project permission to update project-scoped workflow schemes.

      Parameters

      • client: Client
      • parameters: {
            defaultWorkflowId?: string | null;
            id: string;
            workflowsForIssueTypes: {
                issueTypeIds: string[];
                workflowId: string;
                [key: string]: unknown;
            }[];
        }
        • OptionaldefaultWorkflowId?: string | null

          The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira).

        • id: string

          The ID of the workflow scheme.

        • workflowsForIssueTypes: { issueTypeIds: string[]; workflowId: string; [key: string]: unknown }[]

          The new workflow to issue type mappings for this workflow scheme.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              statuses?: {
                  category?: string & {}
                  | "TODO"
                  | "IN_PROGRESS"
                  | "DONE";
                  id?: string;
                  name?: string;
                  [key: string]: unknown;
              }[];
              statusesPerWorkflow?: {
                  initialStatusId?: string;
                  statuses?: string[];
                  workflowId?: string;
                  [key: string]: unknown;
              }[];
              statusMappingsByIssueTypes?: {
                  issueTypeId?: string;
                  statusIds?: string[];
                  [key: string]: unknown;
              }[];
              statusMappingsByWorkflows?: {
                  sourceWorkflowId?: string;
                  statusIds?: string[];
                  targetWorkflowId?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility