Create a HotMark on a Recording

POST /apis/recordings/:recordingId/hotmarks

{
"timestamp": 2000,
"title": "HotMark1",
"description": "Training Session"
}

{
"data": {
  "timestamp": 2000,
  "title": "HotMark1",
  "description": "Training Session",
  "id": "ed6397d0-e947-4604-84f2-96b9ca68d72a"
  "username":"jsmith",
  "userDisplayName":"John Smith"
}
}

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

404

{"code":"040001","name":"RecordingNotFound",
"message":"Active recording not found",
"httpStatusCode":404}

Recording with UUID recordingId not found.

400

{"code":"010001", "name":"InputValidation",
"message":<Error message>, "httpStatusCode":400}

Supplied data was insufficient or incorrect.

409

{"code":"060004", "name":"HotmarkAlreadyExists",
"message": "HotMark already exists at this time",
"httpStatusCode": 409}

HotMark already exists at this timestamp.

404

{"code":"010004", "name":"NoRecordingActive",
"message":"'Y' is not an active  recording",
"httpStatusCode": 404}

Active recording not found.