|
Issues and associated entities can be created, manipulated and retreived.
Issues
Get Issue
Returns IssueEN based upon provided Issue Id.
Create Issue
Creates new Issue based upon provided IssueEN object.
Returns a IssueEN object that will contain new Issue Id.
Create Issue Partial
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:
- ProjectId
- IssueSummary
- IssueLongDesc
- ReportedBy
- IssueTypeId (recommended)
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.
Delete Issue
Deletes an existing IssueEN object.
Update Issue
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.
Update Issue Full
Updates an existing IssueEN object including nested entities as Resources, Comments.
NOTE: speciying a value of 1 for "force" will update the underying issue regardless of whether it has been updated since last retreived (Timestamp column used for comparison).
Returns the updated IssueEN object.
Copy Issue
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.
Move Issue
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.
Filtered Issues
Get My Work
Returns array of IssueEN objects representing current users My Work.
Get My Watched Issues
Returns array of IssueEN objects representing current users My Work.
Get Filtered Issues (IssuesFilterEN)
Returns array of IssueEN objects filtered using the provided IssuesFilterEN.
Get Filtered Issues (Issue Filter Id)
Returns array of IssueEN objects filtered using the provided Issues Filter Id.
Get Paged Filtered Issues (IssuesFilterEN)
Returns array of IssueEN objects for a specific page number.
Get Issue Comments
Returns an array of IssueCommentEN objects.
Get Issue Comment
Returns IssueCommentEN based upon provided Issue Id.
Create Issue Comment
Creates new Issue Comment based upon provided IssueCommentEN object.
Returns a IssueCommentEN object that will contain new Issue Comment Id.
Update Issue Comment
Updates an existing IssueCommentEN object.
Returns the updated IssueCommentEN object.
Delete Issue Comment
Deletes an existing IssueCommentEN object.
Issue Time
Get Issue Time Entries
Returns an array of IssueTimeEntryEN objects.
Get Issue Time Entry
Returns IssueTimeEntryEN based upon provided Issue Time Log Id.
Create Issue Time Entry
Creates new Issue Time Log based upon provided IssueTimeEntryEN object.
Returns a IssueTimeEntryEN object that will have new Issue Time Log Id.
Update Issue Time Entry
Updates an existing IssueTimeEntryEN object.
Returns the updated IssueTimeEntryEN object.
Delete Issue Time Entry
Deletes an existing IssueTimeEntryEN object.
Source Control
Get Source Control Files
Returns an array of SourceControlEN objects.
Get Source Control File
Returns SourceControlEN based upon provided Source Control File Id.
Create Source Control File
Creates new ource Control File based upon provided SourceControlEN object.
Returns a SourceControlEN object that will have the Source Control File Id.
Update Source Control File
Updates an existing SourceControlEN object.
Returns the updated SourceControlEN object.
Delete Source Control File
Deletes an existing SourceControlEN object.
Attachments
Get Issue Attachments
Returns an array of FileEN objects representing all Issue Attachments.
Get Issue Attachment
Returns Issue Attachment based upon provided File Id.
Get Comment Attachment
Returns Issue Attachment for specified Comment.
Create Issue Attachment
Creates new Issue Attachment based upon provided FileEN object.
Returns a FileEN object that will have the File Id.
Update Issue Attachment
Updates an existing Issue Attachment object.
Returns the updated Issue Attachment object.
Delete Issue Attachment
Deletes an existing Issue Attachment.
Issue Links
Get Issue Links
Returns an array of IssueLinkEN objects representing all Issue Links associated with specified Issue.
Get Issue Link
Returns IssueLinkEN based upon provided Link Id.
Create Issue Link
Creates new Issue Link based upon provided IssueLinkEN object.
Returns a IssueLinkEN object that will contain new Issue Link Id.
Update Issue Link
Updates an existing IssueLinkEN object.
Returns the updated IssueLinkEN object.
Delete Issue Link
Deletes an existing IssueLinkEN object.
Sub Issues
Get Sub Issues
Returns an array of IssueEN objects representing all Sub Issues for specified Issue.
Get Sub Issue
Returns IssueEN based upon provided Issue Id.
This method is identical to calling GetIssue().
Create Sub Issue
Makes specified IssueEN object a Sub Issue for the specified Issue Id.
Returns IssueEN representing Issue Id.
Update Sub Issue
Updates an existing IssueEN object.
Returns the updated IssueEN object.
Delete Sub Issue
Deletes Sub Issue association from specified Issue Id.
Issue History
Get Issue History Items
Returns an array of IssueExtraEN objects representing all Issue History items.
Get Issue History Item
Returns IssueExtraEN based upon provided Issue Id.
Create Issue History Item
Creates new Issue History entry based upon provided IssueExtraEN object.
Returns a IssueExtraEN object that will contain new Issue History Id.
Alerts
Get Issue History Items
Returns an array of IssueWatcherEN objects representing Users who will receive email alerts when the specified Issue is changed.
Watchers
Get Issue Watchers
Returns an array of IssueWatcherEN objects representing all Users who have chosen to watch this Issue.
Get Issue Watchers
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" .
Get Issue Watcher
Returns IssueWatcherEN based upon specified Watch Id for specified Issue.
Create Issue Watcher
Registers specified user inside IssueWatcherEN as Issue Watcher for specified Issue.
Returns a IssueWatcherEN object that will contain new Issue Watcher Id.
Delete Issue Watcher
Deletes an existing IssueWatcherEN object.
Reporters
Get Issue Reporters
Returns an array of GenericEN objects representing Users who have reported Issues.
Get Project Issue Reporters
Returns an array of GenericEN objects representing Users who have reported Issues for the specified Project.
Issues Custom Field Data
Get Issue Custom Field Data
Returns an array of CustomFieldDataEN objects representing Custom Field data for the specified Issue.
|