Knowledge base
Tips and tricks Best practice guides, FAQ & more
Find tutorials, guides and use case examples in the
Learning centerThe 'Get Run Item Ids by Run Id' endpoint returns a list of the IDs of the RunItems generated by a scheduled run. A RunItem contains all information about the execution of a flow as part of a schedule.
http://{controllerMachine}:{controllerPort}/api/v4/run/{runId}/runItemIds
Field | Type | Description | Comment |
---|---|---|---|
runId | string | The runId is a unique Id for the individual run instance of a schedule | The runId can be fetched from the Response Body of the Run Schedule Now endpoint. |
curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v4/run/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runItemIds'
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/run/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runItemIds" -ContentType "application/json" -Headers $headers -Method GET
Returns current status of a particular run
{ "$id": "1", "RunItemsIds": [ "f082a297-3ec0-4310-b46e-38bf422efe43", "ba68f389-a324-4a21-b567-d0f00dd30911" ] } |
Field | Type | Description | Comment |
---|---|---|---|
$id | string | ID of internal object | |
runItemsIds | Array[string] | Array of runItemsIds | runItemId is a unique Id for the individual run instance of a flow in a run |
200 (OK)
404 (Not Found)
401 (Unauthorized)
400 (Bad Request)
405 (Method Not Allowed)
500 (Internal Server Error)
©2024, Leapwork. All rights reserved.