addObjectToGroup

Adds an object of any supported type to a group.

To add projects, codes, subcodes, subsubcodes, and users to groups you should use one of the class-specific methods addProjectToGroup, addCodeToGroup, addSubcodeToGroup, addSubsubcodeToGroup, and addUserToGroup, respectively. To add other object types to a group, use this method.

An exception will be raised if the group or object ID or name cannot be mapped to a single unique group or object. For example, if you try to add an object to the group "Test" and there is more than one group with that name, an exception will be raised. In this case, you should use the ID instead.

An exception will be raised if the object_class parameter does not name one of the supported classes. Use getGroupObjectClasses to obtain a list of acceptable values.

Arguments

Name Type Description
skey string

group_id_name string

The ID or pretty name of the group.
object_class string

The name of the class of object to add to the group.
object_id_name string

The ID or pretty name of the object to add to the group.

Return

The addObjectToGroup method returns zero if the object was successfully added to the group (an integer).