Documentation

Find tutorials, guides and use case examples in the

Learning center

Get Run Item Video

Description

The 'Get Run Item Video' endpoint returns a video file, identified by the RunItemId. 

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

Note: If video recordings are enabled ('Enabled' is the default setting), each execution of a flow will have an associated video recording of the flow run.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/runItems/{runitemId}/video 

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 the Response Body of the Get Run Items Id by Run Id endpoint

 

Examples

Curl

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

PowerShell 

$headers = @{}

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

$headers.Add("Accept","application/octet-stream")

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

Response Body

A link to the video is returned, this can be clicked to download the video. 

Video.mp4

Response Code

 

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)