- Object types
GetFlowRequest
A GetFlowRequest Object contains the parameters required for the Orchestrator to select the best Flow to be processed during the POST request to the Flows Resource. The following properties are available:
| Name | Type | Description |
|---|---|---|
queue_name | String | case sensitive name of the queue created for a given agent group (e.g. "flow-all") |
pattern | String | Optionally, a pattern defines regular expression pattern for a given queue that allows the Orchestrator to select a Flow post message that only matches this pattern with its channel. Used to restrict flows to specific regions, for example. |
Values of the flow post message channel
Possible values are the following:
/flows/save/insert/<job or target scope>/flows/save/insert/<job or target scope>[/<sub scope 1>[/<sub scope 2>...]]: possible future extension
If you have suggestions for improving this article, let us know!