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

KeyDatatypeRequiredDescription
startAtnumberThe index of the first item to return in a page of results (page offset).
maxResultsnumberThe maximum number of items to return per page.
typesstring(Required) The types of the transition rules to return.
keysstringThe transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
expandstringUse 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

{&quot;maxResults&quot;:10,&quot;startAt&quot;:0,&quot;total&quot;:1,&quot;isLast&quot;:true,&quot;values&quot;:[{&quot;workflowId&quot;:{&quot;name&quot;:&quot;My Workflow name&quot;,&quot;draft&quot;:false},&quot;postFunctions&quot;:[{&quot;id&quot;:&quot;b4d6cbdc-59f5-11e9-8647-d663bd873d93&quot;,&quot;key&quot;:&quot;postfunction-key&quot;,&quot;configuration&quot;:{&quot;value&quot;:&quot;{ \&quot;color\&quot;: \&quot;red\&quot; }&quot;},&quot;transition&quot;:{&quot;id&quot;:1,&quot;name&quot;:&quot;Open&quot;}}],&quot;conditions&quot;:[{&quot;id&quot;:&quot;d663bd873d93-59f5-11e9-8647-b4d6cbdc&quot;,&quot;key&quot;:&quot;condition-key&quot;,&quot;configuration&quot;:{&quot;value&quot;:&quot;{ \&quot;size\&quot;: \&quot;medium\&quot; }&quot;},&quot;transition&quot;:{&quot;id&quot;:1,&quot;name&quot;:&quot;Open&quot;}}],&quot;validators&quot;:[{&quot;id&quot;:&quot;11e9-59f5-b4d6cbdc-8647-d663bd873d93&quot;,&quot;key&quot;:&quot;validator-key&quot;,&quot;configuration&quot;:{&quot;value&quot;:&quot;\&quot;{ \\\&quot;shape\\\&quot;: \\\&quot;square\\\&quot; }\&quot;&quot;},&quot;transition&quot;:{&quot;id&quot;:1,&quot;name&quot;:&quot;Open&quot;}}]}]}