Knowledge base
Tips and tricks Best practice guides, FAQ & more
Find tutorials, guides and use case examples in the
Learning center'Get Run Item Video Subtitles' endpoint returns a subtitle 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 (default is enabled) each execution of a flow will have an associated video recording of the flow run. The flow settings should Video + subtitles for the logs in order to generate the subtitles with the video.
http://{controllerMachine}:{controllerPort}/api/v3/runItems/{runitemId}/subtitles
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 |
curl -X GET --header 'Accept: application/octet-stream' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/runItems/28519a47-7c28-425f-9d6f-5eeab722166e/subtitles'
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
$headers.Add("Accept","application/octet-stream")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/runItems/28519a47-7c28-425f-9d6f-5eeab722166e/subtitles" -ContentType "application/octet-stream" -Headers $headers -Method GET
An octet stream is returned which can be converted to a subtitle file.
28519a47-7c28-425f-9d6f-5eeab722166e.srt
200 (OK)
404 (Not Found)
401 (Unauthorized)
400 (Bad Request)
405 (Method Not Allowed)
500 (Internal Server Error)
©2024, Leapwork. All rights reserved.