Get Run Status by Run Id

Description

Returns the run status of a specific scheduled run identified by the RunId

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/schedules/{runId}/status

Input parameters

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 response body of the Run Schedule Now endpoint.

Examples

Curl

curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb’  'http://{controllerMachine}:{controllerPort}/api/v3/schedules/39f2b3e3-fa24-43e7-a2d6-38815128ac6c/status' 

PowerShell 

$headers = @{}

$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/schedules/39f2b3e3-fa24-43e7-a2d6-38815128ac6c/status" -ContentType "application/json" -Headers $headers -Method GET

Response

Returns current status of a particular schedule.

{
    "$id": "1",
    "Status": "Executing"
}

 

Response object

Field Type Description Values
Status string Returns current status of a particular run. "Finished":
Finished is returned when all flows in schedule/run have finished their execution.

"Executing":
Executing is returned when the schedule/run is currently executing flow(s).

"Queued":
Queued is returned when all environments are busy. The schedule will run when one or more of the environments in the schedule becomes idle.

 

Response Code

 

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)