jira.js
    Preparing search index...

    Function getWorkflowTransitionRuleConfigurations

    • Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

      • Of one or more transition rule types, such as workflow post functions.
      • Matching one or more transition rule keys.

      Only workflows containing transition rules created by the calling Connect or Forge app are returned.

      Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

      Permissions required: Only Connect or Forge apps can use this operation.

      Parameters

      • client: Client
      • parameters: {
            draft?: boolean;
            expand?: string | string[] | string & {} | ("transition" | string & {})[];
            keys?: string[];
            maxResults?: number;
            startAt?: number;
            types: (string & {} | "postfunction" | "condition" | "validator")[];
            withTags?: string[];
            workflowNames?: string[];
        }
        • Optionaldraft?: boolean

          Deprecated: Whether draft or published workflows are returned. If not provided, both workflow types are returned. The 'draft' parameter will be removed from this API on November 2, 2026.

        • Optionalexpand?: string | string[] | string & {} | ("transition" | string & {})[]

          Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to.

        • Optionalkeys?: string[]

          The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

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

        • types: (string & {} | "postfunction" | "condition" | "validator")[]

          The types of the transition rules to return.

        • OptionalwithTags?: string[]

          The list of tags to filter by.

        • OptionalworkflowNames?: string[]

          The list of workflow names to filter by.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  conditions?: {
                      configuration: {
                          disabled?: boolean;
                          tag?: string;
                          value: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      key: string;
                      transition?: { id: number; name: string; [key: string]: unknown };
                      [key: string]: unknown;
                  }[];
                  postFunctions?: {
                      configuration: {
                          disabled?: boolean;
                          tag?: string;
                          value: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      key: string;
                      transition?: { id: number; name: string; [key: string]: unknown };
                      [key: string]: unknown;
                  }[];
                  validators?: {
                      configuration: {
                          disabled?: boolean;
                          tag?: string;
                          value: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      key: string;
                      transition?: { id: number; name: string; [key: string]: unknown };
                      [key: string]: unknown;
                  }[];
                  workflowId: { draft?: boolean; name: string; [key: string]: unknown };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility