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. |
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
|
||
10.12.9 | Custom Fields API |
custom-fields
items
api
|
||
10.12.10 | Groups API |
security
api
|
||
10.12.11 | Items API |
items
api
|
||
10.12.12 | Projects API |
projects
api
|
||
10.12.13 | Users API |
security
api
|
||
10.12.14 | Testing API |
testing
api
|
15 documents found.
REST End-point | GET /api/issues.ashx/issues/{issueId} |
Client API Method | IssuesService.GetIssue |
Request Body |
Returns IssueEN based upon provided Issue Id.
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.
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:
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId} |
Client API Method | IssuesService.DeleteIssue |
Request Body |
Deletes an existing IssueEN object.
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.
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.
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.
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.
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.
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.
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.
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.
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.
REST End-point | GET /api/issues.ashx/issues/{issueId}/comments |
Client API Method | IssuesService.GetComments |
Request Body |
Returns an array of IssueCommentEN objects.
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.
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/comments/{commentId} |
Client API Method | IssuesService.DeleteComment |
Request Body |
Deletes an existing IssueCommentEN object.
REST End-point | GET /api/issues.ashx/issues/{issueId}/time |
Client API Method | IssuesService.GetTimeLogged |
Request Body |
Returns an array of IssueTimeEntryEN objects.
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.
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/time/{timeEntryId} |
Client API Method | IssuesService.DeleteTimeLogged |
Request Body |
Deletes an existing IssueTimeEntryEN object.
REST End-point | GET /api/issues.ashx/issues/{issueId}/sourcecontrol |
Client API Method | IssuesService.GetSourceControlFiles |
Request Body |
Returns an array of SourceControlEN objects.
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.
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/sourcecontrol/{sourceControlFileId} |
Client API Method | IssuesService.DeleteSourceControlFile |
Request Body |
Deletes an existing SourceControlEN object.
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.
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.
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.
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/attachments/{fileId} |
Client API Method | IssuesService.DeleteAttachment |
Request Body |
Deletes an existing Issue Attachment.
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.
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.
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/links/{linkId} |
Client API Method | IssuesService.DeleteLink |
Request Body |
Deletes an existing IssueLinkEN object.
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.
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().
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.
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.
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.
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.
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.
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.
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.
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.
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" .
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.
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.
REST End-point | DELETE /api/issues.ashx/issues/{issueId}/watchers/{watcherId} |
Client API Method | IssuesService.DeleteWatcher |
Request Body |
Deletes an existing IssueWatcherEN object.
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.
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.