Book demo
Start trial
Book demo
Start trial

Get Run Item Screenshot By

ScreenshotId

Description

Get Run Item Screenshot By ScreenshotId endpoint returns an image captured as a screenshot (Log Screenshot) in a flow identified by the RunItemId. Screenshots can be added at multiple points within a flow. Each screenshot has a ScreenshotId associated which can be fetched from the Response Body of the Get Run Item Keyframes endpoint. 

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}/screenshot/{screenshotId}

Input parameters

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

 

Examples

Curl

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

PowerShell 

$headers = @{}

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

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

Response Body

A link to screenshot image is returned which can be clicked to access/download the image. 

Image.jpg

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)