Skip to main content

Set Recording Category

This command sets the value for a category assigned to the specified recording. You specify the category using the category ID.

Authorizations: All

Request

setCategory recordingId categoryId value [value...]

Parameters

NameDescription

recordingId

The ID of a HMP recording.

categoryId

The ID of the category to assign to the recording. See the Tip in Set Session Category to obtain the category ID.

value

The value defined for the category. Multiple values are separated by spaces.

Result

Success

OK

Error

ErrorsDescription
ERROR|010003|Expected at least 3 parameters. 
Got Y parameter(s)

Calling setCategory requires at least 3 parameters

ERROR|010001|'Y' is not a UUID

The recordingId and categoryId provided must be a UUID.

ERROR|010001|Values must be strings

Categories must be strings.

ERROR|010001|Please provide non-empty values

Categories cannot be empty.

ERROR|010001|Please remove any leading or
trailing spaces in the values

Categories cannot start or end with spaces.

ERROR|010001|Please verify that values
are unique

Category list passed in contains duplicate entries.

ERROR|040007|Category not found

A category with UUID 'categoryId' was not found.

ERROR|040002|Recording not found

A recording with UUID 'recordingId' was not found.

ERROR|040012|No results

The list of metadata was not returned from the server.

Example

setCategory f678f415-0665-48cd-b141-1e95283469f1 
692e9ab8-d446-4bfd-b64d-e39e8e57c4c5 HD
OK

JavaScript errors detected

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

If this problem persists, please contact our support.