Get Run Item Keyframes

Description

The 'Get Run Item Keyframes' 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. 

The complete logging of a flow run 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. 

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

Request URL

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

Input parameters

Examples

Curl

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

PowerShell 

$headers = @{}

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

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/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.

Response object

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)