Get Run by Id

Description

'Get Run by Id' returns all information about a scheduled run identified by the RunId. 

Request URL

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

Input parameters

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.

Response object

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)