Welcome to the 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 Items API
Previous  |  Next

 1      Getting Started
 2      Installing
 2.1        Requirements
 2.2        Automated Installer
 2.3        Microsoft Web Platform
 2.4        Zip File
 2.5        Scheduler Service
 3      Upgrading
 3.1        Upgrading Existing Installations
 3.2        Upgrading 4.1.x to 4.2
 3.3        Upgrading 4.0.x to 4.2
 3.4        Upgrading 3.7.x to 4.2
 3.5        Upgrading 3.6.x to 4.2
 3.6        Upgrading 3.5.x to 4.2
 3.7        Upgrading 3.1.x to 4.2
 3.8        Upgrading 3.0.x to 4.2
 3.9        Upgrading 3.0.0 to 4.2
 3.10         Upgrading 2.2 to 4.2
 3.11         Upgrading 2.1.x to 4.2
 3.12         Upgrading 2.0.x to 4.2
 3.13         Upgrading 1.9.1 to 4.2
 3.14         Upgrading 1.9/1.9a/1.9b to 4.2
 3.15         Upgrading 1.8.x to 4.2
 3.16         Upgrading 1.7 to 4.2
 3.17         Upgrading 1.6.3 to 4.2
 4      Projects
 4.1        Project Concepts
 4.1.1          Grouping Projects
 4.1.2          Components
 4.1.3          Versions
 4.1.4          Roadmap
 4.1.5          Change Log
 4.1.6          Dashboard
 4.2        Project Customization
 4.2.1          Project Settings
 4.2.2          Single, Multiple Item Options
 4.2.3          Item Type, Priority, Severity Options
 4.2.4          Default Values
 4.2.5          Components
 4.2.6          Versions
 4.2.7          Project Attributes
 4.2.8          Which Fields Are Displayed?
 5      Item Management
 5.1        Overview
 5.2        Creating
 5.3        Editing
 5.4        Viewing
 5.5        Visibility
 5.6        Custom Fields
 5.7        Comments
 5.8        Hierarchy
 5.9        Links
 5.10         Recurrence
 5.11         Estimates & Time Logs
 5.12         Source Control Links
 5.13         Audit Trails
 5.14         Workflow
 5.15         Filter Items
 5.15.1           Using the Filter
 5.15.2           Saving and Reusing Filters
 5.15.3           Cross Project Roll-ups
 5.16         Patterns
 6      Planning Board
 7      Time Management
 7.1        Time Reports
 7.2        Recording Time
 8      Notifications
 8.1        Project Alerts
 8.2        Item Watchers
 9      Test Management
 9.1        Approach
 9.2        Plans
 9.3        Cases
 9.4        Runs
 9.5        Traceability
 9.6        Filtering
 10       Management
 10.1         Administration
 10.1.1           General Configuration
 10.1.2           SMTP and Notifications
 10.1.3           Projects
 10.1.4           Custom Fields
 10.1.5           Item Management
 10.1.6           Test Management
 10.1.7           Licensing
 10.2         Users & Security
 10.2.1           User Management
 10.2.2           Global and Project Groups
 10.2.3           Working with Global Groups
 10.2.4           Working with Project Groups
 10.2.5           Available Permissions
 10.2.6           Project Resources
 10.2.7           Assigning Permissions to Projects
 10.2.8           Windows Authentication
 10.2.9           Active Directory Integration
 11       Using Add-on Products
 11.1         Visual Studio 2008/2010
 11.2         Gemini Desktop
 11.3         Microsoft Outlook
 11.4         Converse
 11.4.1           Installation
 11.4.2           Core Mailbox Setup
 11.4.3           Selecting Emails to Process
 11.4.4           Manipulating Email Content
 11.4.5           Outbound Notifications
 11.4.6           Project Mapping
 11.5         SimplyFi
 11.5.1           Introduction
 11.5.2           Key Features
 11.5.3           Licensing
 11.5.4           SimplyFi Concepts
 11.5.5           Clients
 11.5.6           Contacts
 11.5.7           Documents
 11.5.8           Payments
 11.5.9           Stock Items
 11.5.10            Payment Terms
 11.5.11            Document Templates
 11.5.12            Email Templates
 11.5.13            Reminders
 11.5.14            Resource Costs
 11.5.15            Project Costs
 11.5.16            Initial Configuration
 11.5.17            Administration
 11.5.18            General
 11.5.19            Stock Items
 11.5.20            Cost Categories
 11.5.21            Resource Costs
 11.5.22            Project Costs
 11.5.23            Document Templates
 11.5.24            Statement Templates
 11.5.25            Email Templates
 11.5.26            Reminders
 11.5.27            Currencies
 11.5.28            FX Rates (Foreign Exchange)
 11.5.29            Tax Codes
 11.5.30            Payment Terms
 11.5.31            Client Custom Fields
 11.5.32            Localisation
 11.5.33            Clients and Contacts
 11.5.34            Clients
 11.5.35            Contacts
 11.5.36            Searching Clients
 11.5.37            Adding a Client
 11.5.38            Editing a Client
 11.5.39            Deleting a Client
 11.5.40            Searching Contacts
 11.5.41            Adding a Contact to an Existing Client
 11.5.42            Editing an Existing Contact
 11.5.43            Deleting an existing Contact
 11.5.44            Contact Groups
 11.5.45            Documents
 11.5.46            Invoices
 11.5.47            Searching Invoices
 11.5.48            Quotes
 11.5.49            Creating and Editing Invoices
 11.5.50            Searching Quotes
 11.5.51            Credit Notes
 11.5.52            Creating and Editing Quotes
 11.5.53            Searching Credit Notes
 11.5.54            Recurring Invoices
 11.5.55            Creating and Editing Credit Notes
 11.5.56            Searching Recurring Invoices
 11.5.57            Creating and Editing Recurring Invoices
 11.5.58            Document Numbers
 11.5.59            Payments
 11.5.60            Searching Payments
 11.5.61            Logging a new payment
 11.5.62            Editing Payments
 11.5.63            Reports
 11.5.64            Age Analysis
 11.5.65            Reconciliation Report (Recon Report)
 11.5.66            Debt Report
 11.5.67            Tax Report
 11.5.68            Finance Summary Panels
 11.5.69            Import
 11.5.70            Clients
 11.5.71            Invoices
 11.5.72            Payments
 11.5.73            Dashboard
 11.5.74            Support
 11.5.75            Reference
 11.5.76            Windows Localisation Codes
 11.5.77            Supported Currencies
 11.5.78            Icon Reference
 11.5.79            Additional Resources
 12       API
 12.1         Introduction
 12.2         Enabling API support
 12.3         Authentication
 12.4         Response Formats
 12.5         .NET Quick-start
 12.6         Schema Reference
 12.7         Administration API
 12.8         Alerts API
 12.9         Custom Fields API
 12.10          Groups API
 12.11          Items API
 12.12          Projects API
 12.13          Users API
 12.14          Testing API
 13       User Profile
View  |  Print  |  PDF

202 documents found.


Items API

items
api

Issues

Get Issue

REST End-point GET /api/issues.ashx/issues/{issueId}
Client API Method IssuesService.GetIssue
Request Body

Returns IssueEN based upon provided Issue Id.

 

Create Issue

REST End-point POST /api/issues.ashx/issues
Client API Method IssuesService.CreateIssue
Request Body IssueEN

Creates new Issue based upon provided IssueEN object.

Returns a IssueEN object that will contain new Issue Id.

 

Create Issue Partial

REST End-point POST /api/issues.ashx/issuespartial
Client API Method IssuesService.CreateIssue
Request Body IssueEN

Creates new Issue based upon provided IssueEN object

Note all fields in the Issue have to be set for the issue to be created. As a minimum, set:

  • ProjectID
  • IssueSummary
  • IssueLongDesc
  • ReportedBy
  • IssueTypeId (recommended)

Remaining missing attributes such as Component will be applied server-side using Project Default Values.

Returns a IssueEN object that will contain new Issue Id.

 

Delete Issue

REST End-point DELETE /api/issues.ashx/issues/{issueId}
Client API Method IssuesService.DeleteIssue
Request Body

Deletes an existing IssueEN object.

 

Update Issue

REST End-point PUT /api/issues.ashx/issues/{issueId}
Client API Method IssuesService.UpdateIssue
Request Body IssueEN

Updates an existing IssueEN object. Just issue attributes will be saved. No nested entities such as Resources, Comments, will be saved.

NOTE: this update will only take place if the underlying issue has not changed since it was last retrieved (Timestamp column used for comparison).

Returns the updated IssueEN object.

 

Update Issue Full

REST End-point PUT /api/issues.ashx/issues/issuesfull/{issueId}/force/{1|0}
Client API Method IssuesService.UpdateFullIssue
Request Body IssueEN

Updates an existing IssueEN object including nested entities as Resources, Comments.

NOTE: specifying a value of 1 for "force" will update the underlying issue regardless of whether it has been updated since last retrieved (Timestamp column used for comparison).

Returns the updated IssueEN object.

 

Copy Issue

REST End-point PUT /api/issues.ashx/issues/{issueId}/linktype/{linkTypeId}/copyissue
Client API Method IssuesService.CopyIssue
Request Body IssueComponentEN

Creates a new IssueEN object based upon specified Issue Id.

Optionally specify Link Type Id > 0 in order to create Issue Link between original Issue and copied Issue./

Body of request must be array of type IssueComponentEN that will be attached to the copied Issue./

Returns the copied IssueEN object.

 

Move Issue

REST End-point PUT /api/issues.ashx/issues/{issueId}/project/{projectId}/resethistory/{1|0}/moveissue
Client API Method IssuesService.MoveIssue
Request Body IssueComponentEN

Moves an IssueEN object to the specified Project Id.

Specify a value of 1 for "resethistory" if you wish NOT to move Issue History./

Body of request must be array of type IssueComponentEN that will be attached to the copied Issue./

Returns the copied IssueEN object.

 

Filtered Issues

Get My Work

REST End-point GET /api/issues.ashx/issues/mywork
Client API Method IssuesService.GetMyWork
Request Body

Returns array of IssueEN objects representing current users My Work.

 

Get My Watched Issues

REST End-point GET /api/issues.ashx/issues/mywatched
Client API Method IssuesService.GetMyWatchedIssues
Request Body

Returns array of IssueEN objects representing current users My Work.

 

Get Filtered Issues (IssuesFilterEN)

REST End-point POST /api/issues.ashx/issues/filters
Client API Method IssuesService.GetFilteredIssues
Request Body IssuesFilterEN

Returns array of IssueEN objects filtered using the provided IssuesFilterEN.

 

Get Filtered Issues (Issue Filter Id)

REST End-point POST /api/issues.ashx/issues/filters/{filterId}
Client API Method IssuesService.GetFilteredIssues
Request Body

Returns array of IssueEN objects filtered using the provided Issues Filter Id.

 

Get Paged Filtered Issues (IssuesFilterEN)

REST End-point POST /api/issues.ashx/issues/startpage/{page number}/pagesize/{page size}/includeattachments/{1|0}/pagedissues
Client API Method IssuesService.PagedIssuesResultBag
Request Body IssuesFilterEN

Returns array of IssueEN objects for a specific page number.

 

Issue Comments

Get Issue Comments

REST End-point GET /api/issues.ashx/issues/{issueId}/comments
Client API Method IssuesService.GetComments
Request Body

Returns an array of IssueCommentEN objects.

 

Get Issue Comment

REST End-point GET /api/issues.ashx/issues/{issueId}/comments/{commentId}
Client API Method IssuesService.GetComment
Request Body

Returns IssueCommentEN based upon provided Issue Id.

 

Create Issue Comment

REST End-point POST /api/issues.ashx/issues/{issueId}/comments
Client API Method IssuesService.CreateComment
Request Body IssueCommentEN

Creates new Issue Comment based upon provided IssueCommentEN object.

Returns a IssueCommentEN object that will contain new Issue Comment Id.

 

Update Issue Comment

REST End-point PUT /api/issues.ashx/issues/{issueId}/comments/{commentId}
Client API Method IssuesService.UpdateComment
Request Body IssueCommentEN

Updates an existing IssueCommentEN object.

Returns the updated IssueCommentEN object.

 

Delete Issue Comment

REST End-point DELETE /api/issues.ashx/issues/{issueId}/comments/{commentId}
Client API Method IssuesService.DeleteComment
Request Body

Deletes an existing IssueCommentEN object.

 

Issue Time

Get Issue Time Entries

REST End-point GET /api/issues.ashx/issues/{issueId}/time
Client API Method IssuesService.GetTimeLogged
Request Body

Returns an array of IssueTimeEntryEN objects.

 

Get Issue Time Entry

REST End-point GET /api/issues.ashx/issues/{issueId}/time/{timeEntryId}
Client API Method IssuesService.GetTimeLogged
Request Body

Returns IssueTimeEntryEN based upon provided Issue Time Log Id.

 

Create Issue Time Entry

REST End-point POST /api/issues.ashx/issues/{issueId}/time
Client API Method IssuesService.CreateTimeLog
Request Body IssueTimeEntryEN

Creates new Issue Time Log based upon provided IssueTimeEntryEN object.

Returns a IssueTimeEntryEN object that will have new Issue Time Log Id.

 

Update Issue Time Entry

REST End-point PUT /api/issues.ashx/issues/{issueId}/time/{timeEntryId}
Client API Method IssuesService.UpdateTimeLog
Request Body IssueTimeEntryEN

Updates an existing IssueTimeEntryEN object.

Returns the updated IssueTimeEntryEN object.

 

Delete Issue Time Entry

REST End-point DELETE /api/issues.ashx/issues/{issueId}/time/{timeEntryId}
Client API Method IssuesService.DeleteTimeLogged
Request Body

Deletes an existing IssueTimeEntryEN object.

 

Source Control

Get Source Control Files

REST End-point GET /api/issues.ashx/issues/{issueId}/sourcecontrol
Client API Method IssuesService.GetSourceControlFiles
Request Body

Returns an array of SourceControlEN objects.

 

Get Source Control File

REST End-point GET /api/issues.ashx/issues/{issueId}/sourcecontrol/{sourceControlFileId}
Client API Method IssuesService.GetSourceControlFile
Request Body

Returns SourceControlEN based upon provided Source Control File Id.

 

Create Source Control File

REST End-point POST /api/issues.ashx/issues/{issueId}/sourcecontrol
Client API Method IssuesService.CreateSourceControlFile
Request Body SourceControlEN

Creates new ource Control File based upon provided SourceControlEN object.

Returns a SourceControlEN object that will have the Source Control File Id.

 

Update Source Control File

REST End-point PUT /api/issues.ashx/issues/{issueId}/sourcecontrol/{sourceControlFileId}
Client API Method IssuesService.UpdateSourceControlFile
Request Body SourceControlEN

Updates an existing SourceControlEN object.

Returns the updated SourceControlEN object.

 

Delete Source Control File

REST End-point DELETE /api/issues.ashx/issues/{issueId}/sourcecontrol/{sourceControlFileId}
Client API Method IssuesService.DeleteSourceControlFile
Request Body

Deletes an existing SourceControlEN object.

 

Attachments

Get Issue Attachments

REST End-point GET /api/issues.ashx/issues/{issueId}/attachments
Client API Method IssuesService.GetAttachments
Request Body

Returns an array of FileEN objects representing all Issue Attachments.

 

Get Issue Attachment

REST End-point GET /api/issues.ashx/issues/{issueId}/attachments/{fileId}
Client API Method IssuesService.GetAttachment
Request Body

Returns Issue Attachment based upon provided File Id.

 

Get Comment Attachment

REST End-point GET /api/issues.ashx/issues/{issueId}/comments/{commentId}/attachments
Client API Method IssuesService.GetCommentAttachment
Request Body

Returns Issue Attachment for specified Comment.

 

Create Issue Attachment

REST End-point POST /api/issues.ashx/issues/{issueId}/attachments
Client API Method IssuesService.CreateAttachment
Request Body FileEN

Creates new Issue Attachment based upon provided FileEN object.

Returns a FileEN object that will have the File Id.

 

Update Issue Attachment

REST End-point PUT /api/issues.ashx/issues/{issueId}/attachments/{fileId}
Client API Method IssuesService.UpdateAttachment
Request Body FileEN

Updates an existing Issue Attachment object.

Returns the updated Issue Attachment object.

 

Delete Issue Attachment

REST End-point DELETE /api/issues.ashx/issues/{issueId}/attachments/{fileId}
Client API Method IssuesService.DeleteAttachment
Request Body

Deletes an existing Issue Attachment.

 

Issue Links

Get Issue Links

REST End-point GET /api/issues.ashx/issues/{issueId}/links
Client API Method IssuesService.GetLinks
Request Body

Returns an array of IssueLinkEN objects representing all Issue Links associated with specified Issue.

 

Get Issue Link

REST End-point GET /api/issues.ashx/issues/{issueId}/links/{linkId}
Client API Method IssuesService.GetLink
Request Body

Returns IssueLinkEN based upon provided Link Id.

 

Create Issue Link

REST End-point POST /api/issues.ashx/issues/{issueId}/links
Client API Method IssuesService.CreateLink
Request Body IssueLinkEN

Creates new Issue Link based upon provided IssueLinkEN object.

Returns a IssueLinkEN object that will contain new Issue Link Id.

 

Update Issue Link

REST End-point PUT /api/issues.ashx/issues/{issueId}/links/{linkId}
Client API Method IssuesService.UpdateLink
Request Body IssueLinkEN

Updates an existing IssueLinkEN object.

Returns the updated IssueLinkEN object.

 

Delete Issue Link

REST End-point DELETE /api/issues.ashx/issues/{issueId}/links/{linkId}
Client API Method IssuesService.DeleteLink
Request Body

Deletes an existing IssueLinkEN object.

 

Sub Issues

Get Sub Issues

REST End-point GET /api/issues.ashx/issues/{issueId}/subissues
Client API Method IssuesService.GetSubIssues
Request Body

Returns an array of IssueEN objects representing all Sub Issues for specified Issue.

 

Get Sub Issue

REST End-point GET /api/issues.ashx/issues/{issueId}/subissues/{issueId}
Client API Method IssuesService.GetSubIssue
Request Body

Returns IssueEN based upon provided Issue Id.

This method is identical to calling GetIssue().

 

Create Sub Issue

REST End-point POST /api/issues.ashx/issues/{issueId}/subissues
Client API Method IssuesService.CreateSubIssue
Request Body IssueEN

Makes specified IssueEN object a Sub Issue for the specified Issue Id.

Returns IssueEN representing Issue Id.

 

Update Sub Issue

REST End-point PUT /api/issues.ashx/issues/{issueId}/subissues/{issueId}
Client API Method IssuesService.UpdateSubIssue
Request Body IssueEN

Updates an existing IssueEN object.

Returns the updated IssueEN object.

 

Delete Sub Issue

REST End-point DELETE /api/issues.ashx/issues/{issueId}/subissues/{issueId}
Client API Method IssuesService.DeleteSubIssue
Request Body

Deletes Sub Issue association from specified Issue Id.

 

Issue History

Get Issue History Items

REST End-point GET /api/issues.ashx/issues/{issueId}/history
Client API Method IssuesService.GetIssueHistory
Request Body

Returns an array of IssueExtraEN objects representing all Issue History items.

 

Get Issue History Item

REST End-point GET /api/issues.ashx/issues/{issueId}/history/{historyId}
Client API Method IssuesService.GetIssueHistory
Request Body

Returns IssueExtraEN based upon provided Issue Id.

 

Create Issue History Item

REST End-point POST /api/issues.ashx/issues/{issueId}/history
Client API Method IssuesService.CreateIssueHistory
Request Body IssueExtraEN

Creates new Issue History entry based upon provided IssueExtraEN object.

Returns a IssueExtraEN object that will contain new Issue History Id.

 

Alerts

Get Issue History Items

REST End-point GET /api/issues.ashx/issues/{issueId}/alerts
Client API Method IssuesService.GetIssueAlertRecepients
Request Body

Returns an array of IssueWatcherEN objects representing Users who will receive email alerts when the specified Issue is changed.

 

Watchers

Get Issue Watchers

REST End-point GET /api/issues.ashx/issues/{issueId}/watchers
Client API Method IssuesService.GetWatchers
Request Body

Returns an array of IssueWatcherEN objects representing all Users who have chosen to watch this Issue.

 

Get Issue Watchers

REST End-point GET /api/issues.ashx/issues/{issueId}/watchers/{fromDate}
Client API Method IssuesService.GetWatchers
Request Body

Returns an array of IssueWatcherEN objects representing all Users who have chosen to watch this Issue since the specified date.

"fromDate" format to be specified as "yyyy-MM-dd" .

 

Get Issue Watcher

REST End-point GET /api/issues.ashx/issues/{issueId}/watchers/{watcherId}
Client API Method IssuesService.GetWatcher
Request Body

Returns IssueWatcherEN based upon specified Watch Id for specified Issue.

 

Create Issue Watcher

REST End-point POST /api/issues.ashx/issues/{issueId}/watchers
Client API Method IssuesService.CreateWatcher
Request Body IssueWatcherEN

Registers specified user inside IssueWatcherEN as Issue Watcher for specified Issue.

Returns a IssueWatcherEN object that will contain new Issue Watcher Id.

 

Delete Issue Watcher

REST End-point DELETE /api/issues.ashx/issues/{issueId}/watchers/{watcherId}
Client API Method IssuesService.DeleteWatcher
Request Body

Deletes an existing IssueWatcherEN object.

 

Reporters

Get Issue Reporters

REST End-point GET /api/issues.ashx/reporters
Client API Method IssuesService.GetReporters
Request Body

Returns an array of GenericEN objects representing Users who have reported Issues.

 

Get Project Issue Reporters

REST End-point GET /api/issues.ashx/projects/{projectId}/reporters
Client API Method IssuesService.GetProjectReporters
Request Body

Returns an array of GenericEN objects representing Users who have reported Issues for the specified Project.

 

Issues Custom Field Data

Get Issue Custom Field Data

REST End-point GET /api/issues.ashx/issues/{issueId}/customfields
Client API Method IssuesService.GetCustomFieldData
Request Body

Returns an array of CustomFieldDataEN objects representing Custom Field data for the specified Issue.

 


Previous  |  Next