Get All Run Ids by Flow Id
Description
Get All Run Ids by Flow Id returns a list of all RunItemId of a flow execution specified by the FlowId.
RunItemId is a unique Id for the individual run instance of a flow.
Request URL
http://{controllerMachine}:{controllerPort}/api/v4/flows/flowid/runItems/all
Input parameters
| Field |
Type |
Description |
Comment |
| flowId |
string |
Unique identifier for Flow |
FlowId can be fetched by right clicking the flow in editor and choosing the Get Id option or from Get Run Item by Id |
Examples
Curl
curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v4/flows/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runItems/all'
PowerShell
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "'http://{controllerMachine}:{controllerPort}/api/v4/flows/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runItems/all" -ContentType "application/json" -Headers $headers -Method GET
Response
Returns a list of runItemIds:
|
{
"$id": "1",
"RunItemId ": [ "f082a297-3ec0-4310-b46e-38bf422efe43" ]
}
|
Response object
| Field |
Type |
Description |
Comment |
| $id |
string |
ID of the internal object |
|
| RunItemId |
list |
RunItemId is a unique Id for the individual run instance of a flow |
|
Response Code
List of response codes:
200 (OK)
404 (Not Found)
401 (Unauthorized)
400 (Bad Request)
405 (Method Not Allowed)
500 (Internal Server Error)
.svg "Leapwork")
