jira.js
    Preparing search index...

    Function readWorkflowPreviews

    • Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details.

      Permissions required:

      • At least one of the Administer projects and View (read-only) workflow project permissions

      Parameters

      • client: Client
      • parameters: {
            issueTypeIds?: string[];
            projectId: string;
            workflowIds?: string[];
            workflowNames?: string[];
        }
        • OptionalissueTypeIds?: string[]

          The list of issue type IDs. At most 25 issue type IDs can be specified.

        • projectId: string

          The projectId parameter is required and will be used for permission checks. In addition, you must supply at least one of the following lookup terms: workflowNames, workflowIds, or issueTypeIds. The specified workflows must be associated with the given project.

        • OptionalworkflowIds?: string[]

          The list of workflow IDs to be returned. At most 25 workflow IDs can be specified.

        • OptionalworkflowNames?: string[]

          The list of workflow names to be returned. At most 25 workflow names can be specified.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              statuses?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  rawName?: 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?: {
                  description?: string;
                  id?: string;
                  loopedTransitionContainerLayout?: {
                      x?: number;
                      y?: number;
                      [key: string]: unknown;
                  };
                  name?: string;
                  queryContext?: {
                      issueTypes?: string[];
                      project?: string;
                      [key: string]: unknown;
                  }[];
                  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?: (...) | (...);
                          transitionApproved?: (...) | (...);
                          transitionRejected?: (...) | (...);
                          [key: string]: unknown;
                      };
                      deprecated?: boolean;
                      layout?: {
                          x?: (...)
                          | (...);
                          y?: (...) | (...);
                          [key: string]: unknown;
                      };
                      statusReference?: string;
                      [key: string]: unknown;
                  }[];
                  transitions?: {
                      actions?: {
                          id?: ...;
                          parameters?: ...;
                          ruleKey?: ...;
                          [key: ...]: ...;
                      }[];
                      conditions?: PreviewConditionGroupConfiguration;
                      customIssueEventId?: string;
                      description?: string;
                      id?: string;
                      links?: {
                          fromPort?: ...;
                          fromStatusReference?: ...;
                          toPort?: ...;
                          [key: ...]: ...;
                      }[];
                      name?: string;
                      toStatusReference?: string;
                      transitionScreen?: {
                          id?: (...)
                          | (...);
                          parameters?: (...) | (...);
                          ruleKey?: (...) | (...);
                          [key: string]: unknown;
                      };
                      triggers?: { id?: ...; ruleKey?: ...; [key: ...]: ... }[];
                      type?: string & {} | "GLOBAL" | "INITIAL" | "DIRECTED";
                      validators?: {
                          id?: ...;
                          parameters?: ...;
                          ruleKey?: ...;
                          [key: ...]: ...;
                      }[];
                      [key: string]: unknown;
                  }[];
                  version?: { id?: string; versionNumber?: number; [key: string]: unknown };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility