Gemini Community Support Site

This Gemini community support site can be used to find solutions to product issues. You can log in using Open Id, Google Profile and even Facebook. Feel free to ask a question or browse FAQs and documentation. Product tour videos are also available along with how-to videos demonstrating key Gemini capabilities.




Index Groups API
Previous  |  Next

 10.12          API
 10.12.1            Introduction
 10.12.2            Enabling API support
 10.12.3            Authentication
 10.12.4            Response Formats
 10.12.5            .NET Quick-start
 10.12.6            Schema Reference
 10.12.7            Administration API
 10.12.8            Alerts API
 10.12.9            Custom Fields API
 10.12.10             Groups API
 10.12.11             Items API
 10.12.12             Projects API
 10.12.13             Users API
 10.12.14             Testing API
View  |  Print  |  PDF

15 documents found.


Groups API

api
security

Global Groups

Get Global Groups

REST End-point GET /api/groups.ashx/globalgroups
Client API Method GroupsService.GetGlobalGroup
Request Body

Returns an array of GlobalGroupEN objects.

 

Get Global Group

REST End-point GET /api/groups.ashx/globalgroups/{groupId}
Client API Method GroupsService.GetGlobalGroup
Request Body

Returns GlobalGroupEN based upon provided Group Id.

 

Create Global Group

REST End-point POST /api/groups.ashx/globalgroups/{groupId}
Client API Method GroupsService.CreateGlobalGroup
Request Body GlobalGroupEN

Creates new Global Group based upon provided GlobalGroupEN object.

Returns a GlobalGroupEN object that will contain new Group Id.

 

Update Global Group

REST End-point PUT /api/groups.ashx/globalgroups/{groupId}
Client API Method GroupsService.UpdateGlobalGroup
Request Body GlobalGroupEN

Updates an existing GlobalGroupEN object.

Returns the updated GlobalGroupEN object.

 

Delete Global Group

REST End-point DELETE /api/groups.ashx/globalgroups/{groupId}
Client API Method GroupsService.DeleteGlobalGroup
Request Body

Deletes an existing GlobalGroupEN object.

 

Add Global Group Membership

REST End-point POST /api/groups.ashx/globalgroups/{groupId}/users/{userId}/membership
Client API Method GroupsService.AddGlobalGroupMembership
Request Body

Adds specified User to the specified Global Group.

Returns a GlobalGroupMembershipEN object that will contain new Group Membership Id.

 

Remove Global Group Membership

REST End-point DELETE /api/groups.ashx/globalgroups/{groupId}/users/{userId}/membership
Client API Method GroupsService.RemoveGlobalGroupMembership
Request Body

Removes Global Group membership for the specified User.

 

Get Global Group Members

REST End-point GET /api/groups.ashx/globalgroups/{groupId}/members
Client API Method GroupsService.GetGlobalGroupMembers
Request Body

Returns an array of UserEN objects representing the Users that are part of the specified Global Group.

 

Get Global Group Non-Members

REST End-point GET /api/groups.ashx/globalgroups/{groupId}/nonmembers
Client API Method GroupsService.GetGlobalGroupNonMembers
Request Body

Returns an array of UserEN objects representing the Users that are NOT part of the specified Global Group.

 

Project Groups

Get Project Groups

REST End-point GET /api/groups.ashx/projectgroups
Client API Method GroupsService.GetProjectGroup
Request Body

Returns an array of ProjectGroupEN objects.

 

Get Project Group

REST End-point GET /api/groups.ashx/projectgroups/{groupId}
Client API Method GroupsService.GetProjectGroup
Request Body

Returns ProjectGroupEN based upon provided Group Id.

 

Create Project Group

REST End-point POST /api/groups.ashx/projectgroups/{groupId}
Client API Method GroupsService.CreateProjectGroup
Request Body ProjectGroupEN

Creates new Project Group based upon provided ProjectGroupEN object.

Returns a ProjectGroupEN object that will contain new Group Id.

 

Update Project Group

REST End-point PUT /api/groups.ashx/projectgroups/{groupId}
Client API Method GroupsService.UpdateProjectGroup
Request Body ProjectGroupEN

Updates an existing ProjectGroupEN object.

Returns the updated ProjectGroupEN object.

 

Delete Project Group

REST End-point DELETE /api/groups.ashx/projectgroups/{groupId}
Client API Method GroupsService.DeleteProjectGroup
Request Body

Deletes an existing ProjectGroupEN object.

 

Add Project Group Membership

REST End-point POST /api/groups.ashx/projectgroups/{groupId}/projects/{projectId}/users/{userId}/membership
Client API Method GroupsService.AddProjectGroupMembership
Request Body

Adds specified user to the specified Project Group for the specified Project.

Returns ProjectGroupMembershipEN object that will contain new Group Membership Id.

 

Remove Project Group Membership

REST End-point DELETE /api/groups.ashx/projectgroups/{groupId}/projects/{projectId}/users/{userId}/membership
Client API Method GroupsService.RemoveProjectGroupMembership
Request Body

Removes Project Group membership for the specified User, for the specified Project.

 

Get Project Group Members

REST End-point GET /api/groups.ashx/projectgroups/{groupId}/projects/{projectId}/members
Client API Method GroupsService.GetProjectGroupMembers
Request Body

Returns an array of UserEN objects representing the Users that are part of the specified Project Group for the specified Project.

 

Get Project Group Non-Members

REST End-point GET /api/groups.ashx/projectgroups/{groupId}/projects/{projectId}/nonmembers
Client API Method GroupsService.GetProjectGroupNonMembers
Request Body

Returns an array of UserEN objects representing the Users that are NOT part of the specified Project Group for the specified Project.

 


Previous  |  Next