GET /rest/api/2/workflow/rule/config
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.
Servers
- https://your-domain.atlassian.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
draft |
Boolean | No |
Whether draft or published workflows are returned. If not provided, both workflow types are returned. |
startAt |
Integer | No |
The index of the first item to return in a page of results (page offset). Default value: 0 |
maxResults |
Integer | No |
The maximum number of items to return per page. Default value: 10 |
types[] |
Array | Yes |
The types of the transition rules to return. |
workflowNames[] |
Array | No |
The list of workflow names to filter by. |
expand |
String | No |
Use expand to include additional information in the response. This parameter accepts |
withTags[] |
Array | No |
The list of |
keys[] |
Array | No |
The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return. |
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.