Get Flow Titles by RunList Step ID
Description
'Get Flow Titles by RunList Step ID' returns a list of flow titles associated with a specific step in a run list, specified by the runListStepId. This lightweight endpoint is typically used to confirm which flows are linked to a step without requiring full metadata or execution.
Request URL
http://{controllerMachine}:{controllerPort}/api/v4/steps/{runListStepId}/flowTitles
Input parameters
| Field |
Type |
Description |
Comment |
| runListStepId |
string |
Unique identifier for a step in a run list |
Can be retrieved via the /schedules/run/{runId} response |
| accessKey |
string |
Access token required for authentication |
Must be included as a request header |
Examples
Curl
curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v4/steps/93c075c-74f6-451e-bed5-abeed95d6372/flowTitles'
PowerShell
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/steps/93c075c-74f6-451e-bed5-abeed95d6372/flowTitles" -ContentType "application/json" -Headers $headers -Method GET
Response
Returns a list of flow titles associated with the specified run list step:
{
"$id": "1",
"RunListStepId": "93c075c-74f6-451e-bed5-abeed95d6372",
"Titles": [
"LWW-1343",
"LWW-1168",
"LWW-3970",
"LWW-4359; LWW-4356"
]
} |
Response object
| Field |
Type |
Description |
Comment |
| $id |
string |
Internal identifier for the response object |
|
| RunListStepId |
string |
The run list step ID used in the request |
Confirms the scope of the returned flow titles |
| Titles |
Array[string] |
List of flow titles associated with the step |
May contain grouped titles as semicolon-separated strings |
Response Code
200 (OK)
404 (Not Found)
401 (Unauthorized)
400 (Bad Request)
500 (Internal Server Error)
.svg "Leapwork")
