PUT /rest/api/2/workflow/rule/config
Updates configuration of workflow transition rules. The following rule types are supported:
- post functions
- conditions
- validators
Only rules created by the calling Connect or Forge 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 or Forge apps can use this operation.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
workflows[] |
Array | Yes |
The list of workflows with transition rules to update. |
workflows[].validators[] |
Array | No |
The list of validators within the workflow. |
workflows[].validators[].id |
String | Yes |
The ID of the transition rule. |
workflows[].validators[].key |
String | Yes |
The key of the rule, as defined in the Connect or the Forge app descriptor. |
workflows[].validators[].configuration |
Object | Yes |
A rule configuration. |
workflows[].validators[].configuration.disabled |
Boolean | No |
Whether the rule is disabled. Default value: false |
workflows[].validators[].configuration.value |
String | Yes |
Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. |
workflows[].validators[].configuration.tag |
String | No |
A tag used to filter rules in Get workflow transition rule configurations. |
workflows[].conditions[] |
Array | No |
The list of conditions within the workflow. |
workflows[].conditions[].id |
String | Yes |
The ID of the transition rule. |
workflows[].conditions[].key |
String | Yes |
The key of the rule, as defined in the Connect or the Forge app descriptor. |
workflows[].conditions[].configuration |
Object | Yes |
A rule configuration. |
workflows[].conditions[].configuration.disabled |
Boolean | No |
Whether the rule is disabled. Default value: false |
workflows[].conditions[].configuration.value |
String | Yes |
Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. |
workflows[].conditions[].configuration.tag |
String | No |
A tag used to filter rules in Get workflow transition rule configurations. |
workflows[].workflowId |
Object | Yes |
Properties that identify a workflow. |
workflows[].workflowId.draft |
Boolean | Yes |
Whether the workflow is in the draft state. |
workflows[].workflowId.name |
String | Yes |
The name of the workflow. |
workflows[].postFunctions[] |
Array | No |
The list of post functions within the workflow. |
workflows[].postFunctions[].id |
String | Yes |
The ID of the transition rule. |
workflows[].postFunctions[].key |
String | Yes |
The key of the rule, as defined in the Connect or the Forge app descriptor. |
workflows[].postFunctions[].configuration |
Object | Yes |
A rule configuration. |
workflows[].postFunctions[].configuration.disabled |
Boolean | No |
Whether the rule is disabled. Default value: false |
workflows[].postFunctions[].configuration.value |
String | Yes |
Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. |
workflows[].postFunctions[].configuration.tag |
String | No |
A tag used to filter rules in Get workflow transition rule configurations. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.