Skip to main content

Share a Recording with a Group

This command sets the access permission (either WATCH, EDIT, OWN, or custom permission ID) of the specified recording with the specified group.

Authorizations: All

Request

shareRecordingWithGroup groupname permissionId recordingId

Parameters

NameDescription

groupname

The name specified for the group. groupname is case-insensitive.

permissionId

The access permission to assign to this group:

  • WATCH: View this recording.
  • EDIT: View and edit this recording.
  • OWN: All capabilities, including deleting this recording.
  • <uuid> of admin-defined share permission.

recordingId

The ID of an HMP recording.

Result

Success

OK

Error

Make sure a role is assigned to the group

ErrorDescription
ERROR|010003|Expected 3 parameter(s). 
Got Y parameter(s)
Calling shareRecordingWithGroup requires 3 parameter.
ERROR|010001|'Y' is not a UUID
The recordingId provided must be a UUID.
ERROR|010001|Permission must be one of: 
WATCH, EDIT, OWN
Validation failed on 'permission'. Verify that it is set to WATCH, EDIT, or OWN.
ERROR|070009|Error searching for a group
An internal error occurred while searching for group 'groupname'.
ERROR|040005|Group not found
A group with UUID 'groupname' was not found.
ERROR|060002|Group has no roles assigned
Make sure a role is assigned to the group.
ERROR|040002|Recording not found

A recording with UUID 'recordingId' was not found.

ERROR|030003|Cannot share

User is not allowed to share to this permission ID.

Ex.: User has the WATCH permission, but is trying to share to the OWN level.

Example

This example uses a default HMP access permission.

shareRecordingWithGroup Grp10 OWN f678f415-0665-48cd-b141-1e95283469f1
OK

This example uses a custom access permission.

shareRecordingWithGroup Grp10 12b0cc54-9018-42c2-9dfb3f7707a09829
f678f415-0665-48cd-b141-1e95283469f1
OK

JavaScript errors detected

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

If this problem persists, please contact our support.