Blog
Read the latest blogs
Find tutorials, guides and use case examples in the
Learning center'Get Run Ids by Schedule Id' returns a list of all the runs of a schedule, specified by the ScheduleId. The runs are returned as a list of RunIds, which can be used to pull detail information about an individual run of a schedule.
http://{controllerMachine}:{controllerPort}/api/v3/schedules/{scheduleId}/runIds
Field | Type | Description | Comment |
---|---|---|---|
scheduleId | string | Unique identifier for Schedule | scheduleId can be fetched from the response body of Get Schedule |
curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/schedules/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runIds'
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/schedules/99b7c050-02bd-4a37-b1d5-8f69ed42ab96/runIds" -ContentType "application/json" -Headers $headers -Method GET
Returns list of runIds
{ "$id": "1", "runIds": [ "f082a297-3ec0-4310-b46e-38bf422efe43", "ba68f389-a324-4a21-b567-d0f00dd30911" ] } |
Field | Type | Description | Comment |
---|---|---|---|
$id | string | ID of internal object | |
runIds | Array[string] | Array of runIds | The runId is a unique Id for the individual run instance of a schedule |
200 (OK)
404 (Not Found)
401 (Unauthorized)
400 (Bad Request)
405 (Method Not Allowed)
500 (Internal Server Error)
©2024, Leapwork. All rights reserved.