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 Custom Fields 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.


Custom Fields API

custom-fields
items
api

Custom Fields

Get Custom Fields

REST End-point GET/api/customfields.ashx/customfields
Client API Method CustomFieldsService.GetCustomFields
Request Body

Return all Custom Fields defined within Gemini.

Returns an array of CustomFieldEN objects.

 

Get Custom Field

REST End-point GET/api/customfields.ashx/customfields/{customFieldId}
Client API Method CustomFieldsService.GetCustomField
Request Body

Returns CustomFieldEN object for the specified Custom Field.

 

Create Custom Field

REST End-point POST/api/customfields.ashx/customfields
Client API Method CustomFieldsService.CreateCustomField
Request Body CustomFieldEN

Creates new Custom Field based upon provided CustomFieldEN object.

Returns a CustomFieldEN object that will contain new Custom Field Id.

 

Update Custom Field

REST End-point PUT/api/customfields.ashx/customfields/{customFieldId}
Client API Method CustomFieldsService.UpdateCustomField
Request Body CustomFieldEN

Updates an existing CustomFieldEN object using the specified CustomFieldEN object.

Returns the updated CustomFieldEN object.

 

Delete Custom Field

REST End-point DELETE/api/customfields.ashx/customfields/{customFieldId}
Client API Method CustomFieldsService.DeleteCustomField
Request Body

Deletes an existing CustomFieldEN object.

 

Link Custom Field to Project

REST End-point POST/api/customfields.ashx/customfieldsusage
Client API Method CustomFieldsService.CreateCustomFieldUsage
Request Body CustomFieldUsageEN

Creates a relationship between the Custom Field and the Project.

Returns an integer.

 

Save Custom Field Data

REST End-point PUT/api/customfields.ashx/customfielddata
Client API Method CustomFieldsService.SaveCustomFieldData
Request Body CustomFieldDataEN

Saves custom field data to an existing Issue using the specified CustomFieldDataEN object.

Returns an IssueEN object that includes it's updated custom field data.

 

Custom Field Lookup Tables

Create Custom Field SQL Lookup Table

REST End-point POST/api/customfields.ashx/customfieldlookups
Client API Method CustomFieldsService.CreateCustomFieldLookup
Request Body CustomFieldLookupEN

Creates a new SQL table for Custom Field usage. This table will contain data rows that will be used by lookup-driven Custom Fields. The structure of the SQL table is defined by the CustomFieldLookupEN object.

Returns the CustomFieldLookupEN object that contains the Lookup Table Id for the new SQL table.

 

Populate Custom Field SQL Lookup Table

REST End-point POST/api/customfields.ashx/customfieldlookupspopulate/{lookupTableId}
Client API Method CustomFieldsService.CreateCustomFieldLookupData
Request Body CustomFieldLookupPopulateEN

Creates a new data row as detailed in the CustomFieldLookupPopulateEN object in the specified SQL Lookup Table.

Returns the CustomFieldLookupPopulateEN object that represents the newly created data row.

 

Does SQL Lookup Table Exist?

REST End-point GET/api/customfields.ashx/customfieldlookups/{lookupname}
Client API Method CustomFieldsService.CheckCustomFieldLookup
Request Body

Returns TRUE/FALSE to indicate whether specified SQL table exists in the Gemini SQL Server database.

 


Previous  |  Next