JIRA 7.6.1

Update workflow transition rule configurations

PUT

/rest/api/3/workflow/rule/config

Workflow transition rules

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

post functions

conditions

validators

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

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

Disable a rule.

Add a tag. Use this to filter rules in the Get workflow transition rule configurations.

Rules are enabled if the disabled parameter is not provided.

Permissions required: Only Connect apps can use this operation.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/workflow/rule/config' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflows": [
        {
            "conditions": [
                {
                    "configuration": {
                        "disabled": false,
                        "value": "{ \"size\": \"medium\" }"
                    },
                    "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc"
                }
            ],
            "postFunctions": [
                {
                    "configuration": {
                        "disabled": false,
                        "value": "{ \"color\": \"red\" }"
                    },
                    "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93"
                }
            ],
            "validators": [
                {
                    "configuration": {
                        "disabled": false,
                        "value": "{ \"shape\": \"square\" }"
                    },
                    "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
                }
            ],
            "workflowId": {
                "draft": false,
                "name": "My Workflow name"
            }
        }
    ]
}'

Response Example

200 - Success

{
  "updateResults": [
    {
      "workflowId": {
        "name": "Workflow with one rule not updated",
        "draft": false
      },
      "ruleUpdateErrors": {
        "example-rule-id": [
          "The rule with this id does not exist: example-rule-id"
        ]
      },
      "updateErrors": []
    },
    {
      "workflowId": {
        "name": "Workflow with all rules successfully updated",
        "draft": true
      },
      "ruleUpdateErrors": {},
      "updateErrors": []
    },
    {
      "workflowId": {
        "name": "Non-existing workflow",
        "draft": false
      },
      "ruleUpdateErrors": {},
      "updateErrors": [
        "Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"
      ]
    }
  ]
}

Request

Body Params application/json

Details about a workflow configuration update request.

workflows

array[object (WorkflowTransitionRules) {4}]

required

The list of workflows with transition rules to update.

conditions

array[object (AppWorkflowTransitionRule) {2}]

optional

The list of conditions within the workflow.

postFunctions

array[object (AppWorkflowTransitionRule) {2}]

optional

The list of post functions within the workflow.

validators

array[object (AppWorkflowTransitionRule) {2}]

optional

The list of validators within the workflow.

workflowId

object (WorkflowId)

required

Properties that identify a workflow.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of any errors encountered while updating workflow transition rules.

updateResults

array[object (WorkflowTransitionRulesUpdateErrorDetails) {3}]

required

A list of workflows.

ruleUpdateErrors

object

required

A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.

updateErrors

array[string]

required

The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.

workflowId

object (WorkflowId)

required

Properties that identify a workflow.

🟠400Returned if the request is invalid.

🟠403Returned if the caller is not a Connect app.

Modified at 2023-07-13 03:27:27

Get workflow transition rule configurations

Delete workflow transition rule configurations