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


Administration API

admin
api

Issue Type

Get Issue Types

REST End-point GET /api/admin.ashx/issuetypes
Client API Method AdminService.GetIssueType
Request Body

Returns an array of all IssueTypeEN objects.

 

Get Issue Type

REST End-point GET /api/admin.ashx/issuetypes/{issueTypeId}
Client API Method AdminService.GetIssueType
Request Body

Returns IssueTypeEN based upon provided Issue Type Id.

 

Create Issue Type

REST End-point POST /api/admin.ashx/issuetypes
Client API Method AdminService.CreateIssueType
Request Body IssueTypeEN

Creates new Issue Type based upon provided IssueTypeEN object.

Returns a IssueTypeEN object that will contain new Issue Type Id.

 

Update Issue Type

REST End-point PUT /api/admin.ashx/issuetypes/{issueTypeId}
Client API Method AdminService.UpdateIssueType
Request Body IssueTypeEN

Updates an existing IssueTypeEN object.

Returns the updated IssueTypeEN object.

 

Delete Issue Type

REST End-point DELETE /api/admin.ashx/issuetypes/{issueTypeId}
Client API Method AdminService.DeleteIssueType
Request Body

Deletes an existing IssueTypeEN object.

 

Get Issue Type Schemes

REST End-point GET /api/admin.ashx/issuetypechemes
Client API Method AdminService.GetIssueTypeScheme
Request Body

Returns an array of all IssueTypeSchemeEN objects.

 

Get Issue Type Scheme

REST End-point GET /api/admin.ashx/issuetypechemes/{schemeId}
Client API Method AdminService.GetIssueTypeScheme
Request Body

Returns IssueTypeSchemeEN based upon provided Scheme Id.

 

Issue Priority

Get Issue Priorities

REST End-point GET /api/admin.ashx/issuepriorities
Client API Method AdminService.GetIssuePriority
Request Body

Returns an array of all IssuePriorityEN objects.

 

Get Issue Priority

REST End-point GET /api/admin.ashx/issuepriorities/{issuePriorityId}
Client API Method AdminService.GetIssuePriority
Request Body

Returns IssuePriorityEN based upon provided Issue Priority Id.

 

Create Issue Priority

REST End-point POST /api/admin.ashx/issuepriorities
Client API Method AdminService.CreateIssuePriority
Request Body IssuePriorityEN

Creates new Issue Priority based upon provided IssuePriorityEN object.

Returns a IssuePriorityEN object that will contain new Issue Priority Id.

 

Update Issue Priority

REST End-point PUT /api/admin.ashx/issuepriorities/{issuePriorityId}
Client API Method AdminService.UpdateIssuePriority
Request Body IssuePriorityEN

Updates an existing IssuePriorityEN object.

Returns the updated IssuePriorityEN object.

 

Delete Issue Priority

REST End-point DELETE /api/admin.ashx/issuepriorities/{issuePriorityId}
Client API Method AdminService.DeleteIssuePriority
Request Body

Deletes an existing IssuePriorityEN object.

 

Get Issue Priority Schemes

REST End-point GET /api/admin.ashx/issuepriorityschemes
Client API Method AdminService.GetIssuePriorityScheme
Request Body

Returns an array of all IssuePrioritySchemeEN objects.

 

Get Issue Priority Scheme

REST End-point GET /api/admin.ashx/issuepriorityschemes/{schemeId}
Client API Method AdminService.GetIssuePriorityScheme
Request Body

Returns IssuePrioritySchemeEN based upon provided Scheme Id.

 

Issue Severity

Get Issue Severities

REST End-point GET /api/admin.ashx/issueseverities
Client API Method AdminService.GetIssueSeverity
Request Body

Returns an array of all IssueSeverityEN objects.

 

Get Issue Severity

REST End-point GET /api/admin.ashx/issueseverities/{issuePriorityId}
Client API Method AdminService.GetIssueSeverity
Request Body

Returns IssueSeverityEN based upon provided Issue Severity Id.

 

Create Issue Severity

REST End-point POST /api/admin.ashx/issueseverities
Client API Method AdminService.CreateIssueSeverity
Request Body IssueSeverityEN

Creates new Issue Severity based upon provided IssueSeverityEN object.

Returns a IssueSeverityEN object that will contain new Issue Severity Id.

 

Update Issue Severity

REST End-point PUT /api/admin.ashx/issueseverities/{issuePriorityId}
Client API Method AdminService.UpdateIssueSeverity
Request Body IssueSeverityEN

Updates an existing IssueSeverityEN object.

Returns the updated IssueSeverityEN object.

 

Delete Issue Severity

REST End-point DELETE /api/admin.ashx/issueseverities/{issuePriorityId}
Client API Method AdminService.DeleteIssueSeverity
Request Body

Deletes an existing IssueSeverityEN object.

 

Get Issue Severity Schemes

REST End-point GET /api/admin.ashx/issueseverityschemes
Client API Method AdminService.GetIssueSeverityScheme
Request Body

Returns an array of all IssueSeveritySchemeEN objects.

 

Get Issue Severity Scheme

REST End-point GET /api/admin.ashx/issueseverityschemes/{schemeId}
Client API Method AdminService.GetIssueSeverityScheme
Request Body

Returns IssueSeveritySchemeEN based upon provided Scheme Id.

 

Issue Time Types

Get Issue Time Types

REST End-point GET /api/admin.ashx/issuetimetype
Client API Method AdminService.GetIssueTimeType
Request Body

Returns an array of all IssueTimeTypeEN objects.

 

Get Issue Time Type

REST End-point GET /api/admin.ashx/issuetimetype/{timeTypeId}
Client API Method AdminService.GetIssueTimeType
Request Body

Returns IssueTimeTypeEN based upon provided Issue Time Type Id.

 

Issue Risk

Get Issue Risks

REST End-point GET /api/admin.ashx/issuerisks
Client API Method AdminService.GetIssueRisk
Request Body

Returns an array of all IssueRiskEN objects.

 

Get Issue Risk

REST End-point GET /api/admin.ashx/issuerisks/{riskId}
Client API Method AdminService.GetIssueRisk
Request Body

Returns IssueRiskEN based upon provided Issue Risk Id.

 

Create Issue Risk

REST End-point POST /api/admin.ashx/issuerisks
Client API Method AdminService.CreateIssueRisk
Request Body IssueRiskEN

Creates new Issue Risk based upon provided IssueRiskEN object.

Returns a IssueRiskEN object that will contain new Issue Risk Id.

 

Update Issue Risk

REST End-point PUT /api/admin.ashx/issuerisks/{riskId}
Client API Method AdminService.UpdateIssueRisk
Request Body IssueRiskEN

Updates an existing IssueRiskEN object.

Returns the updated IssueRiskEN object.

 

Delete Issue Risk

REST End-point DELETE /api/admin.ashx/issuerisks/{riskId}
Client API Method AdminService.DeleteIssueRisk
Request Body

Deletes an existing IssueRiskEN object.

 

Get Issue Links

REST End-point GET /api/admin.ashx/issuelinks
Client API Method AdminService.GetIssueLinkType
Request Body

Returns an array of all IssueLinkTypeEN objects.

 

Get Issue Link

REST End-point GET /api/admin.ashx/issuelinks/{linkId}
Client API Method AdminService.GetIssueLinkType
Request Body

Returns IssueLinkTypeEN based upon provided Issue Link Id.

 

Create Issue Link

REST End-point POST /api/admin.ashx/issuelinks
Client API Method AdminService.CreateIssueLinkType
Request Body IssueLinkTypeEN

Creates new Issue Link based upon provided IssueLinkTypeEN object.

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

 

Update Issue Link

REST End-point PUT /api/admin.ashx/issuelinks/{linkId}
Client API Method AdminService.UpdateIssueLinkType
Request Body IssueLinkTypeEN

Updates an existing IssueLinkTypeEN object.

Returns the updated IssueLinkTypeEN object.

 

Delete Issue Link

REST End-point DELETE /api/admin.ashx/issuelinks/{linkId}
Client API Method AdminService.DeleteIssueLinkType
Request Body

Deletes an existing IssueLinkTypeEN object.

 

Issue Resolution

Get Issue Resolutions

REST End-point GET /api/admin.ashx/issueresolutions
Client API Method AdminService.GetIssueResolution
Request Body

Returns an array of all IssueResolutionEN objects.

 

Get Issue Resolution

REST End-point GET /api/admin.ashx/issueresolutions/{resolutionId}
Client API Method AdminService.GetIssueResolution
Request Body

Returns IssueResolutionEN based upon provided Issue Resolution Id.

 

Create Issue Resolution

REST End-point POST /api/admin.ashx/issueresolutions
Client API Method AdminService.CreateIssueResolution
Request Body IssueResolutionEN

Creates new Issue Resolution based upon provided IssueResolutionEN object.

Returns a IssueResolutionEN object that will contain new Issue Resolution Id.

 

Update Issue Resolution

REST End-point PUT /api/admin.ashx/issueresolutions/{resolutionId}
Client API Method AdminService.UpdateIssueResolution
Request Body IssueResolutionEN

Updates an existing IssueResolutionEN object.

Returns the updated IssueResolutionEN object.

 

Delete Issue Resolution

REST End-point DELETE /api/admin.ashx/issueresolutions/{resolutionId}
Client API Method AdminService.DeleteIssueResolution
Request Body

Deletes an existing IssueResolutionEN object.

 

Issue Status

Get All Issue Status

REST End-point GET /api/admin.ashx/issuestatus
Client API Method AdminService.GetIssueStatus
Request Body

Returns an array of all IssueStatusEN objects.

 

Get Issue Status

REST End-point GET /api/admin.ashx/issuestatus/{statusId}
Client API Method AdminService.GetIssueStatus
Request Body

Returns IssueStatusEN based upon provided Issue Status Id.

 

Create Issue Status

REST End-point POST /api/admin.ashx/issuestatus
Client API Method AdminService.CreateIssueStatus
Request Body IssueStatusEN

Creates new Issue Status based upon provided IssueStatusEN object.

Returns a IssueStatusEN object that will contain new Issue Status Id.

 

Update Issue Status

REST End-point PUT /api/admin.ashx/issuestatus/{statusId}
Client API Method AdminService.UpdateIssueStatus
Request Body IssueStatusEN

Updates an existing IssueStatusEN object.

Returns the updated IssueStatusEN object.

 

Delete Issue Status

REST End-point DELETE /api/admin.ashx/issuestatus/{statusId}
Client API Method AdminService.DeleteIssueStatus
Request Body

Deletes an existing IssueStatusEN object.

 

Issue Workflow

Get Workflows

REST End-point GET /api/admin.ashx/workflows
Client API Method AdminService.GetWorkflows
Request Body

Returns an array of all IssueWorkflowEN objects.

 

Get Workflow

REST End-point GET /api/admin.ashx/workflows/{workflowId}
Client API Method AdminService.GetWorkflow
Request Body

Returns IssueWorkflowEN based upon provided Issue Workflow Id.

 

Get Project Workflow

REST End-point GET /api/admin.ashx/workflows/{workflowId}
Client API Method AdminService.GetProjectWorkflow
Request Body

Returns IssueWorkflowEN based upon provided Issue Workflow Id.

 

Field Visibility Schemes

Get Create Stage Field Visibility Scheme

REST End-point GET /api/admin.ashx/createfieldvisibility/issuetype/{typeId}
Client API Method AdminService.GetCreateStageFieldVisibiltyScheme
Request Body

Returns FieldVisibilitySchemeEN for use when creating an Issue, for the given Issue Type.

 

Get Edit Stage Field Visibility Scheme

REST End-point GET /api/admin.ashx/editfieldvisibility/issuetype/{typeId}
Client API Method AdminService.GetEditStageFieldVisibiltyScheme
Request Body

Returns FieldVisibilitySchemeEN for use when editing an Issue, for the given Issue Type.

 

Get View Stage Field Visibility Scheme

REST End-point GET /api/admin.ashx/viewfieldvisibility/issuetype/{typeId}
Client API Method AdminService.GetViewStageFieldVisibiltyScheme
Request Body

Returns FieldVisibilitySchemeEN for use when viewing an Issue, for the given Issue Type.

 

Get Field Visibility Scheme

REST End-point GET /api/admin.ashx/fieldvisibility/{schemeId}
Client API Method AdminService.GetFieldVisibiltyScheme
Request Body

Returns FieldVisibilitySchemeEN based upon provided Field Visibility Scheme Id.

 

Get Field Visibility Schemes

REST End-point GET /api/admin.ashx/fieldvisibility
Client API Method AdminService.GetFieldVisibiltySchemes
Request Body

Returns an array of all FieldVisibilitySchemeEN objects.

 

Security Schemes

Get Security Schemes

REST End-point GET /api/admin.ashx/securityschemes
Client API Method AdminService.GetSecuritySchemes
Request Body

Returns an array of all GlobalSecuritySchemeEN objects.

 

Get Security Scheme

REST End-point GET /api/admin.ashx/securityschemes/{schemeId}
Client API Method AdminService.GetSecurityScheme
Request Body

Returns GlobalSecuritySchemeEN based upon provided Security Scheme Id.

 

Create Security Scheme

REST End-point POST /api/admin.ashx/securityschemes
Client API Method AdminService.CreateSecurityScheme
Request Body GlobalSecuritySchemeEN

Creates new Security Scheme based upon provided GlobalSecuritySchemeEN object.

Returns a GlobalSecuritySchemeEN object that will contain new Security Scheme Id.

 

Update Security Scheme

REST End-point PUT /api/admin.ashx/securityschemes/{schemeId}
Client API Method AdminService.UpdateSecurityScheme
Request Body GlobalSecuritySchemeEN

Updates an existing GlobalSecuritySchemeEN object.

Returns the updated GlobalSecuritySchemeEN object.

 

Delete Security Scheme

REST End-point DELETE /api/admin.ashx/securityschemes/{schemeId}
Client API Method AdminService.DeleteSecurityScheme
Request Body

Deletes an existing GlobalSecuritySchemeEN object.

 

Configuration

Get Gemini Configuration

REST End-point GET /api/admin.ashx/configuration
Client API Method AdminService.GetConfiguration
Request Body

Returns GeminiConfigurationEN object containing global Gemini configuration information.

 

Get Gemini Product Version

REST End-point GET /api/admin.ashx/information
Client API Method AdminService.GetProductInformation
Request Body

Returns ProductInformation object containing Gemini installation version information.

 

Localization

Get Language Resource File

REST End-point GET /api/admin.ashx/language/{languageCode}
Client API Method AdminService.GetXmlLanguageFile
Request Body

Returns requested language XML resource file as a string.

Example language codes: en-GB, en-Us, nl-NL, de-DE, etc.

 

Mailbox

Get All Mailbox

REST End-point GET /api/admin.ashx/mailbox
Client API Method AdminService.GetMailbox
Request Body

Returns an array of all MailboxEN objects.

 

Get Mailbox

REST End-point GET /api/admin.ashx/mailbox/{mailboxId}
Client API Method AdminService.GetMailbox
Request Body

Returns MailboxEN based upon provided Mailbox Id.

 

Create Mailbox

REST End-point POST /api/admin.ashx/mailbox
Client API Method AdminService.CreateMailbox
Request Body MailboxEN

Creates new Mailbox based upon provided MailboxEN object.

Returns a MailboxEN object that will contain new Mailbox Id.

 

Update Mailbox

REST End-point PUT /api/admin.ashx/mailbox/{mailboxId}
Client API Method AdminService.UpdateMailbox
Request Body MailboxEN

Updates an existing MailboxEN object.

Returns the updated MailboxEN object.

 

Delete Mailbox

REST End-point DELETE /api/admin.ashx/mailbox/{mailboxId}
Client API Method AdminService.DeleteMailbox
Request Body

Deletes an existing MailboxEN object.

 


Previous  |  Next