| Keywords: |
|
|
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. |
123 documents found.
Custom Fields 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.