jira.js
    Preparing search index...

    Function searchWorkflows

    • Returns a paginated list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned.

      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
      • Optionalparameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "values.transitions")[];
            isActive?: boolean;
            maxResults?: number;
            orderBy?:
                | "name"
                | string & {}
                | "created"
                | "updated"
                | "-created"
                | "+created"
                | "-name"
                | "+name"
                | "-updated"
                | "+updated";
            projectId?: number;
            queryString?: string;
            scope?: string;
            startAt?: number;
        }
        • Optionalexpand?: string | string[] | string & {} | (string & {} | "values.transitions")[]

          Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

          • values.transitions Returns the transitions that each workflow is associated with.
        • OptionalisActive?: boolean

          Filters active and inactive workflows.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalorderBy?:
              | "name"
              | string & {}
              | "created"
              | "updated"
              | "-created"
              | "+created"
              | "-name"
              | "+name"
              | "-updated"
              | "+updated"

          Order the results by a field:

          • name Sorts by workflow name.
          • created Sorts by create time.
          • updated Sorts by update time.
        • OptionalprojectId?: number

          The ID of the project to filter the workflows by. Only workflows associated with the given project are returned.

        • OptionalqueryString?: string

          String used to perform a case-insensitive partial match with workflow name.

        • Optionalscope?: string

          The scope of the workflow. Global for company-managed projects and Project for team-managed projects.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast?: boolean;
              maxResults?: number;
              nextPage?: string;
              self?: string;
              startAt?: number;
              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;
              }[];
              total?: number;
              values?: {
                  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