Skip to main content

Update Recording Metadata

This command updates the metadata assigned to the specified recording (the contents of either the title, description, or createdby field). 

Authorizations: All

Requests

updateMetadata recordingId title|description|createdby value

Parameters

NameDescription

recordingId

The ID of a HMP recording.

fieldName

The metadata field to update, either title, description or createdby.

Note

"createdby" is the display name on the Edit User page (

Options Menu
 > Administration > Access Controls > Users). createdby is also the creator in the "Created M/D/YYYY by [creator]" status displayed in the Videos or Session player window

value

The contents of the metadata field.

Result

Success

OK

Error

ErrorDescription
ERROR|010003|Expected 3 parameter(s).
Got Y parameter(s)

Calling updateMetadata requires 3 parameters.

ERROR|010001|'Y' is not a UUID

The recordingId provided must be a UUID.

ERROR|040002|Recording not found

A recording with UUID 'recordingId' was not found.

ERROR|070017|Failed to update a recording

An internal error occurred while updating the metadata. Please see calypso.log for details.

ERROR|010001|'Z' is an invalid field name

The fieldName provided is invalid

ERROR|040012|No results

The list of metadata was not returned from the server.

Example

updateMetadata f678f415-0665-48cd-b141-1e95283469f1 title Test2
OK

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.