jira.js
    Preparing search index...

    Function updateWorkflowTransitionRuleConfigurations

    • Updates configuration of workflow transition rules. The following rule types are supported:

      Only rules created by the calling Connect or Forge app can be updated.

      To assist with app migration, this operation can be used to:

      Rules are enabled if the disabled parameter is not provided.

      Note: The draft parameter in the request body WorkflowId is deprecated and will be removed from this API on November 2, 2026.

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

      Parameters

      • client: Client
      • parameters: {
            workflows: {
                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;
            }[];
        }
        • workflows: {
              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;
          }[]

          The list of workflows with transition rules to update.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              updateResults: {
                  ruleUpdateErrors: Record<string, any>;
                  updateErrors: string[];
                  workflowId: { draft?: boolean; name: string; [key: string]: unknown };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >