Home Home
  login

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

 10       Gemini 4
usage
 10.1         Getting Started
install
usage
 10.2         Installing
install
 10.2.1           Requirements
install
 10.2.2           Automated Installer
install
 10.2.3           Microsoft Web Platform
install
 10.2.4           Zip File
install
 10.2.5           Scheduler Service
install
emails
 10.3         Upgrading
install
migration
 10.3.1           Upgrading Existing Installations
install
migration
 10.3.2           Upgrading 4.1.x to 4.2
install
migration
 10.3.3           Upgrading 4.0.x to 4.2
install
migration
 10.3.4           Upgrading 3.7.x to 4.2
install
migration
 10.3.5           Upgrading 3.6.x to 4.2
install
migration
 10.3.6           Upgrading 3.5.x to 4.2
install
migration
 10.3.7           Upgrading 3.1.x to 4.2
install
migration
 10.3.8           Upgrading 3.0.x to 4.2
install
migration
 10.3.9           Upgrading 3.0.0 to 4.2
install
migration
 10.3.10            Upgrading 2.2 to 4.2
install
migration
 10.3.11            Upgrading 2.1.x to 4.2
install
migration
 10.3.12            Upgrading 2.0.x to 4.2
install
migration
 10.3.13            Upgrading 1.9.1 to 4.2
install
migration
 10.3.14            Upgrading 1.9/1.9a/1.9b to 4.2
install
migration
 10.3.15            Upgrading 1.8.x to 4.2
install
migration
 10.3.16            Upgrading 1.7 to 4.2
install
migration
 10.3.17            Upgrading 1.6.3 to 4.2
install
migration
 10.4         Projects
projects
 10.4.1           Project Concepts
projects
 10.4.1.1             Grouping Projects
projects
 10.4.1.2             Components
projects
 10.4.1.3             Versions
projects
 10.4.1.4             Roadmap
projects
 10.4.1.5             Change Log
projects
 10.4.1.6             Dashboard
projects
 10.4.2           Project Customization
projects
 10.4.2.1             Project Settings
projects
 10.4.2.2             Single, Multiple Item Options
projects
 10.4.2.3             Item Type, Priority, Severity Options
projects
 10.4.2.4             Default Values
projects
 10.4.2.5             Components
projects
 10.4.2.6             Versions
projects
 10.4.2.7             Project Attributes
projects
 10.4.2.8             Which Fields Are Displayed?
projects
custom-fields
 10.5         Item Management
 10.5.1           Overview
 10.5.2           Creating
 10.5.3           Editing
 10.5.4           Viewing
 10.5.5           Visibility
 10.5.6           Custom Fields
custom-fields
 10.5.7           Comments
 10.5.8           Hierarchy
 10.5.9           Links
 10.5.10            Recurrence
 10.5.11            Estimates & Time Logs
time
 10.5.12            Source Control Links
 10.5.13            Audit Trails
 10.5.14            Workflow
 10.5.15            Filter Items
find-filter
 10.5.15.1              Using the Filter
find-filter
 10.5.15.2              Saving and Reusing Filters
find-filter
 10.5.15.3              Cross Project Roll-ups
find-filter
 10.5.16            Patterns
usage
projects
 10.6         Planning Board
usage
 10.7         Time Management
time
 10.7.1           Time Reports
time
 10.7.2           Recording Time
usage
 10.8         Notifications
usage
emails
 10.8.1           Project Alerts
emails
usage
 10.8.2           Item Watchers
emails
usage
 10.9         Test Management
testing
 10.9.1           Approach
testing
 10.9.2           Plans
testing
 10.9.3           Cases
testing
 10.9.4           Runs
testing
 10.9.5           Traceability
testing
 10.9.6           Filtering
testing
 10.10          Management
admin
 10.10.1            Administration
admin
 10.10.1.1              General Configuration
admin
 10.10.1.2              SMTP and Notifications
admin
emails
 10.10.1.3              Projects
admin
 10.10.1.4              Custom Fields
admin
 10.10.1.5              Item Management
admin
 10.10.1.6              Test Management
admin
testing
 10.10.1.7              Licensing
install
admin
 10.10.2            Users & Security
admin
security
 10.10.2.1              User Management
admin
security
 10.10.2.2              Global and Project Groups
admin
security
 10.10.2.3              Working with Global Groups
admin
security
 10.10.2.4              Working with Project Groups
admin
security
 10.10.2.5              Available Permissions
admin
security
 10.10.2.6              Project Resources
admin
security
 10.10.2.7              Assigning Permissions to Projects
security
admin
 10.10.2.8              Windows Authentication
security
admin
 10.10.2.9              Active Directory Integration
admin
security
 10.11          Using Add-on Products
usage
add-ons
 10.11.1            Visual Studio 2008/2010
usage
add-ons
visual-studio
 10.11.2            Gemini Desktop
usage
add-ons
desktop
 10.11.3            Microsoft Outlook
admin
add-ons
ms-outlook
usage
 10.11.4            Converse
converse
 10.11.4.1              Installation
converse
 10.11.4.2              Core Mailbox Setup
converse
 10.11.4.3              Selecting Emails to Process
converse
 10.11.4.4              Manipulating Email Content
converse
 10.11.4.5              Outbound Notifications
emails
converse
 10.11.4.6              Project Mapping
emails
converse
 10.12          API
api
 10.12.1            Introduction
api
 10.12.2            Enabling API support
install
api
 10.12.3            Authentication
api
 10.12.4            Response Formats
api
 10.12.5            .NET Quick-start
api
 10.12.6            Schema Reference
api
 10.12.7            Administration API
admin
api
 10.12.8            Alerts API
api
emails
 10.12.9            Custom Fields API
custom-fields
api
 10.12.10             Groups API
security
api
 10.12.11             Items API
api
 10.12.12             Projects API
projects
api
 10.12.13             Users API
security
api
 10.12.14             Testing API
testing
api
 10.13          User Profile
usage
View  |  Print  |  PDF

123 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