Get workflow transition rule configurations

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.

{"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\" }","disabled":false},"transition":{"id":1,"name":"Open"}}],"conditions":[{"id":"d663bd873d93-59f5-11e9-8647-b4d6cbdc","key":"condition-key","configuration":{"value":"{ \"size\": \"medium\" }","disabled":false},"transition":{"id":1,"name":"Open"}}],"validators":[{"id":"11e9-59f5-b4d6cbdc-8647-d663bd873d93","key":"validator-key","configuration":{"value":"\"{ \\\"shape\\\": \\\"square\\\" }\"","disabled":false},"transition":{"id":1,"name":"Open"}}]}]}

Request

Query Params

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

types

array[string]

required

The types of the transition rules to return.

keys

array[string]

optional

The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.

workflowNames

array[string]

optional

EXPERIMENTAL: The list of workflow names to filter by.

withTags

array[string]

optional

EXPERIMENTAL: The list of tags to filter by.

draft

string

optional

EXPERIMENTAL: Whether draft or published workflows are returned. If not provided, both workflow types are returned.

expand

string

optional

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

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (WorkflowTransitionRules) {4}]

read-onlyoptional

The list of items.

conditions

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of conditions within the workflow.

postFunctions

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of post functions within the workflow.

validators

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of validators within the workflow.

workflowId

object (WorkflowId)

required

Properties that identify a workflow.

🟠400Returned if the request is invalid.

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

🟠404Returned if any transition rule type is not supported.