Create a HotMark on a Recording
Creates a new HotMark on the specified recording.
Authorizations: Recordings - EDIT
Requests
POST /apis/recordings/:recordingId/hotmarks { |
Response
Success
{ |
Parameters
Property | JSON Type | Property Type | Description |
---|---|---|---|
id | String | Immutable | Identifies the HotMark. Generated by HMP. |
timestamp | Number | Required for videos. Optional (for POST) for active recordings. | Time in milliseconds to which the HotMark is set. Defaults to current timestamp for active recordings. Note HotMark timestamps have a one-second resolution. |
title | String | Required | Title of the HotMark. |
description | String | Optional | Description of the HotMark. |
username | String | Immutable | The user's login name, e.g., bsmith |
userDisplayName | String | Ignored | The user’s friendly name, e.g., Bob Smith |
Error
Code | Payload | Description |
---|---|---|
404 | {"code":"040001","name":"RecordingNotFound", | Recording with UUID |
400 | {"code":"010001", "name":"InputValidation", | Supplied data was insufficient or incorrect. |
409 | {"code":"060004", "name":"HotmarkAlreadyExists", | HotMark already exists at this timestamp. |
404 | {"code":"010004", "name":"NoRecordingActive", | Active recording not found. |