Get Run Item Keyframes

Description

The complete logging of running a flow consists of a number of keyframes. Each keyframe contains information about a specific point in time in the execution of the flow, i.e. starting an application, clicking a button etc. 

This endpoint returns a list of keyframes of a run of a flow identified by the RunItemId, with the option of specifying a number of keyframes to offset the list with. 

RunItemID can be fetched from the Response Body of the Get Run Items Id by Run Id endpoint.

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/runItems/{runitemId}/keyframe/{offset} 

Input parameters

Field Type Description Comment
runitemId string The runitemId is a unique Id for the individual run instance of a flow in a test run runitemId can be fetched from Response Body of Get Run Items Id by Run Id endpoint
offset integer Number of keyframes to offset. A keyframe is block execution information with log message and timestamp.  

 

Examples

Curl

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

PowerShell 

$headers = @{}

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

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

Response

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

[
    {
     "$id": "1",
     "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": "2",
     "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": "3",
     "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": "4",
     "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": "5",
     "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": "6",
     "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": "7",
     "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"
    }

]

 

Response object

 

Field Type Description Values
AutomationRunItemId string ID of automation run item  
Timestamp integer    
Elapsed string The total of flow execution in seconds  
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  

 

Response Code

 

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)