Get Workflow Transition Rule Configurations
GET {{baseUrl}}/rest/api/3/workflow/rule/config?startAt=0&maxResults=10&types=<string>&keys=<string>&expand=<string>
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 app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow.
Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.
Permissions required: Only Connect apps can use this operation.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startAt | number | The index of the first item to return in a page of results (page offset). | |
maxResults | number | The maximum number of items to return per page. | |
types | string | (Required) The types of the transition rules to return. | |
keys | string | The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return. | |
expand | 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. |
RESPONSES
status: OK
{"maxResults":10,"startAt":0,"total":1,"isLast":true,"values":[{"workflowId":{"name":"My Workflow name","draft":false},"postFunctions":[{"id":"b4d6cbdc-59f5-11e9-8647-d663bd873d93","key":"postfunction-key","configuration":{"value":"{ \"color\": \"red\" }"},"transition":{"id":1,"name":"Open"}}],"conditions":[{"id":"d663bd873d93-59f5-11e9-8647-b4d6cbdc","key":"condition-key","configuration":{"value":"{ \"size\": \"medium\" }"},"transition":{"id":1,"name":"Open"}}],"validators":[{"id":"11e9-59f5-b4d6cbdc-8647-d663bd873d93","key":"validator-key","configuration":{"value":"\"{ \\\"shape\\\": \\\"square\\\" }\""},"transition":{"id":1,"name":"Open"}}]}]}