CounterSoft
Gemini Issue Tracker

Gemini API: REST Web Services

Gemini v3.6.5 Build 2638  -  Refreshed: 24th March 2010
 
Overview
Introduction
Authentication
Response Formats
.NET Client API
Downloads
Schema Reference
API Index
Administration
Alerts
Custom Fields
Groups
Issues
Projects
Users

API > Groups API

User Group related entities can be created, manipulated and retreived.

 

Group membership can also be manipulated to add and remove users from Groups.

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 a 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.

 





© Copyright 2010, CounterSoft& Limited.

 

Gemini is a leading .NET based, web-based, issue tracker, bug tracker, help desk software for software development teams and organizations.

Full integration with Microsoft Visual Studio, Microsoft Outlook, Windows Live Messenger, TechSmith SnagIt.

Web, Windows, offline working mode, full REST API supporting XML and JSON formats.

See our public instance here: http://gemini.countersoft.com

http://www.countersoft.com   |   http://gemini.countersoft.com   |   http://twitter.com/countersoft