Get Run Item By Id

Description

Returns detailed information about a run of a flow in a schedule. The run of the flow (RunItem) is identified by the Id of the run item.

Run Item ID can be fetched from Response Body of Get Run Items Id by Run Id endpoint.

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/runItems/{runItemId}

Input parameters

Field Type Description Comment
runItemId string The runItemId is a unique Id for the individual run instance of a flow in a run runItemId can be fetched from Response Body of Get Run Items Id by Run Id endpoint

Examples

Curl

curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/runItems/28519a47-7c28-425f-9d6f-5eeab722166e'

PowerShell 

$headers = @{}

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

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/runItems/28519a47-7c28-425f-9d6f-5eeab722166e" -ContentType "application/json" -Headers $headers -Method GET

Response

 

{
    "$id": "1",
    "runItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
    "RunId": "d457775d-c995-4b43-a029-82e43f876d3c",
    "FlowInfo": {
        "FlowId": "db61948b-3b88-4467-ba6d-e915e4a8c96f",
        "FlowTitle": "Reset Password",
        "Status": "Done"
    },
    "EnvironmentInfo": {
        "EnvironmentId": "1a0ad779-7657-48a4-bf16-76fe48e99f83",
        "EnvironmentTitle": "Remote Agent",
        "ConnectionType": "RemoteAgent"
    },
    "Keyframes": [
        {
        "$id": "2",
        "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
        "Timestamp": "2018-09-12T10:18:57+00:00",
        "Level": "Info",
        "Status": "Initializing",
        "LogMessage": "Scheduled run executed from schedule 'Production'",
        "Id": "14ab43ac-bb9e-428e-9e81-75eeeb2bfe19"
        },
        {
        "$id": "3",
        "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
        "Timestamp": "2018-09-12T10:18:57+00:00",
        "Level": "Info",
        "Status": "Connecting",
        "LogMessage": "Connecting to Remote Agent",
         "Id": "80deba29-5876-494e-ac0c-440e0677a97e"
         },
         {
        "$id": "4",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:57+00:00",
         "Elapsed": "00:00:00.0000004",
         "Level": "Info",
         "Status": "Connected",
         "LogMessage": "Connected to Remote Agent with size 800x600",
         "Id": "632484ed-14f4-4981-95ff-c202145c38b7"
        },
         {
        "$id": "5",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:57+00:00",
         "Elapsed": "00:00:00.0001166",
         "Level": "Info",
         "Status": "Running",
         "BlockId": "3bcb6ed3-1cac-4be9-a302-ac2a99637e85",
         "LogMessage": "Running",
         "Id": "9cee3f3d-b324-4794-bda7-9caad09108ca"
         },
         {
         "$id": "6",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:57+00:00",
         "Elapsed": "00:00:00.0008676",
         "Status": "Running",
         "BlockId": "3bcb6ed3-1cac-4be9-a302-ac2a99637e85",
         "LogMessage": "Block is executing.",
         "Id": "9809b762-3bd5-458f-adb8-4cfa7766349d"
         },
         {
         "$id": "7",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:57+00:00",
         "Elapsed": "00:00:00.4940312",
         "Status": "Running",
         "BlockId": "3bcb6ed3-1cac-4be9-a302-ac2a99637e85",
             "LogMessage": "Block is executed.",
         "Id": "58289553-4d88-4a6b-8bd6-36af56966d79"
         },
         {
         "$id": "8",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:57+00:00",
         "Elapsed": "00:00:00.4946056",
          "Status": "Running",
         "BlockId": "2a6180ad-e495-4fdb-9349-c12009befc7c",
         "LogMessage": "Block is executing.",
          "Id": "fba5130e-ee1e-4e15-80c7-d01ce9428b37"
         },
         {
          "$id": "9",
         "AutomationRunItemId": "f082a297-3ec0-4310-b46e-38bf422efe43",
         "Timestamp": "2018-09-12T10:18:58+00:00",
         "Elapsed": "00:00:01.5098238",
         "Level": "Info",
         "Status": "Done",
         "BlockId": "2a6180ad-e495-4fdb-9349-c12009befc7c",
         "LogMessage": "Case is stopped.",
         "Id": "83b00036-0f32-4af5-9f7b-ca10d1402279"
          }
      ],
          "Elapsed": "00:00:01.5098238",
          "ElapsedMilliseconds": 1509.8238000000001,
          "ElapsedSeconds": 1.5098238
}

 

Response object

 

Fields Type Description Values
$id string ID of internal object  
runItemId string ID of Run Item  
RunId string ID of Run  
FlowInfo FlowIntegrationInfo    
FlowIntegrationInfo Object Object holds values for FlowIntegrationInfo  
FlowId string Id of the flow  
FlowTitle string Title of the flow  
Status string Status of execution 'NoStatus', 'Initializing', 'Connecting', 'Connected', 'Running', 'Passed', 'Failed', 'Timeout', 'Inconclusive', 'Cancelled', 'Error', 'Done'
EnvironmentInfo EnvironmentIntegrationInfo    
EnvironmentIntegrationInfo Object Object holds values for EnvironmentIntegrationInfo  
EnvironmentId string Id of the execution environment  
EnvironmentTitle string Title of the execution environment  
ConnectionType string Type of the execution environment 'RemoteAgent', 'Local', 'SauceLabs', 'SeleniumGrid', 'BrowserStack'
Keyframes AutomationRunItemKeyframe    
AutomationRunItemKeyframe Object Object holds values for AutomationRunItemKeyframe  
AutomationRunItemId string ID of automation run item  
Timestamp integer    
Elapsed string The total time in seconds for running the automation flow  
Level string  Log level 'Trace', 'Info', 'Warning', 'Error'
Status string  Status of execution 'NoStatus', 'Initializing', 'Connecting', 'Connected', 'Running', 'Passed', 'Failed', 'Timeout', 'Inconclusive', 'Cancelled', 'Error', 'Done'
BlockId string Id of the building block  
ParentBlockId string Id of the parent building block  
LogMessage string Message logged by building block  
Id string ID of internal object  
Elapsed string Total time of flow execution  
ElapsedMilliseconds number Total time of flow execution in milliseconds  
ElapsedSeconds 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)