Get Run by Id

Description

Returns all information about a scheduled run identified by the RunId

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/run/{runId}

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/run/884aa35d-2ff0-48c5-a056-be338d7c649c'

PowerShell 

$headers = @{}

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

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/run/884aa35d-2ff0-48c5-a056-be338d7c649c" -ContentType "application/json" -Headers $headers -Method GET

Response

A list of all Schedule items is returned in the JSON response.

{
    "$id": "1",
    "RunId": "fbaf84e1-aa24-49c7-9e36-f88cffb3ab08",
    "Schedule": {
        "$id": "2",
        "ScheduleId": "a24b6fac-a6b2-4b47-967c-20c996843efe",
        "ScheduleTitle": "Production"
     },
    "Status": "Finished",
    "Failed": 1,
    "Total": 1,
    "ExecutionTotalTime": "00:00:20.1867808",
    "ExecutionMilliseconds": 20186.7808,
    "ExecutionSeconds": 20.186780799999998
}

 

Response object

 

Field Type Description Values
$id string Internal ID of object.  
runId string Unique Id for an individual run instance of a schedule  
Schedule {} ScheduleIntegrationInfo    
ScheduleIntegrationInfo Object Object holds values for ScheduleId  
$id string Internal ID of object  
ScheduleId string ScheduleID  
ScheduleTitle string Title of the schedule  
Status string Status of the schedule "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.
Failed integer Failed count of flows  
Total integer Total count of flows  
ExecutionTotalTime  string Total time of flow execution  
ExecutionMilliseconds  number Total time of flow execution in milliseconds  
ExecutionSeconds number Total time of flow execution in seconds  

 

Response Code

 

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)