jira.js
    Preparing search index...

    Function readWorkflows

    • Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

      Permissions required:

      • Administer Jira global permission to access all, including project-scoped, workflows
      • At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows

      Parameters

      • client: Client
      • parameters: {
            projectAndIssueTypes?: {
                issueTypeId: string;
                projectId: string;
                [key: string]: unknown;
            }[];
            workflowIds?: string[];
            workflowNames?: string[];
        }
        • OptionalprojectAndIssueTypes?: { issueTypeId: string; projectId: string; [key: string]: unknown }[]

          The list of projects and issue types to query.

        • OptionalworkflowIds?: string[]

          The list of workflow IDs to query.

        • OptionalworkflowNames?: string[]

          The list of workflow names to query.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              statuses?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  scope?: {
                      project?: { id: string; [key: string]: unknown };
                      type?: string & {} | "PROJECT" | "GLOBAL";
                      [key: string]: unknown;
                  };
                  statusCategory?: string & {}
                  | "TODO"
                  | "IN_PROGRESS"
                  | "DONE";
                  statusReference?: string;
                  [key: string]: unknown;
              }[];
              workflows?: {
                  created?: string
                  | null;
                  description?: string;
                  id?: string;
                  isEditable?: boolean;
                  loopedTransitionContainerLayout?: {
                      x?: number;
                      y?: number;
                      [key: string]: unknown;
                  };
                  name?: string;
                  scope?: {
                      project?: { id: string; [key: string]: unknown };
                      type?: string & {} | "PROJECT" | "GLOBAL";
                      [key: string]: unknown;
                  };
                  startPointLayout?: { x?: number; y?: number; [key: string]: unknown };
                  statuses?: {
                      approvalConfiguration?: {
                          active: (...) | (...) | (...);
                          conditionType: (...) | (...) | (...) | (...);
                          conditionValue: string;
                          exclude?: (...) | (...) | (...);
                          fieldId: string;
                          prePopulatedFieldId?: (...) | (...) | (...);
                          transitionApproved: string;
                          transitionRejected: string;
                          [key: string]: unknown;
                      };
                      deprecated?: boolean;
                      layout?: {
                          x?: (...)
                          | (...)
                          | (...);
                          y?: (...) | (...) | (...);
                          [key: string]: unknown;
                      };
                      properties?: Record<string, any>;
                      statusReference?: string;
                      [key: string]: unknown;
                  }[];
                  taskId?: string
                  | null;
                  transitions?: {
                      actions?: {
                          id?: ...;
                          parameters?: ...;
                          ruleKey: ...;
                          [key: ...]: ...;
                      }[];
                      conditions?: ConditionGroupConfiguration;
                      customIssueEventId?: string
                      | null;
                      description?: string;
                      id?: string;
                      links?: {
                          fromPort?: ...;
                          fromStatusReference?: ...;
                          toPort?: ...;
                          [key: ...]: ...;
                      }[];
                      name?: string;
                      properties?: Record<string, any>;
                      toStatusReference?: string;
                      transitionScreen?: {
                          id?: (...) | (...) | (...);
                          parameters?: (...) | (...);
                          ruleKey: string;
                          [key: string]: unknown;
                      };
                      triggers?: { id?: ...; parameters: ...; ruleKey: ...; [key: ...]: ... }[];
                      type?: string & {} | "GLOBAL" | "INITIAL" | "DIRECTED";
                      validators?: {
                          id?: ...;
                          parameters?: ...;
                          ruleKey: ...;
                          [key: ...]: ...;
                      }[];
                      [key: string]: unknown;
                  }[];
                  updated?: string
                  | null;
                  version?: { id?: string; versionNumber?: number; [key: string]: unknown };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility