Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:
Calls using any other content type (ex: text/plain) are not supported.
-
APIs
-
Issues
Contents
Summary
Contains methods for working with issues.
Access Restrictions
This section requires access to the TDProjects application.
API Methods
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/{issueId}
Copy URL
Gets an issue.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/{issueId}
Copy URL
Updates an issue.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue ID.
-
-
Parameter Name
-
Request Body
(Validated as "issueUpdate")
-
Type
-
TeamDynamix.Api.Issues.IssueUpdate
-
Source
-
Request Body
-
Description
-
An update to apply to an issue.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/{issueId}/attachments?showViewLink={showViewLink}
Copy URL
Uploads an attachment to an issue. The file should be included
as part of the submission's form data.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue ID.
-
-
Parameter Name
-
showViewLink
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
null
.
-
Description
-
true
if the View link should be shown, otherwise false
. This
only applies to HTML files.
File Upload
This action accepts an uploaded file as part of the form's submission.
For information on how to structure calls with files, see the
Submitting Files page.
Returns
The generated attachment if the operation was successful.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed
Copy URL
Gets the feed entries for an issue.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The replies and
likes collections will
not be returned by this endpoint.
However, replies count,
likes count, and
"liked by me" flag values will be loaded.
To retrieve replies and likes, query the single feed entry retrieval endpoint
using the individual entry's URI.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed
Copy URL
Adds a comment on an issue.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issueId ID.
-
-
Parameter Name
-
Request Body
(Validated as "itemUpdate")
-
Type
-
TeamDynamix.Api.Feed.FeedEntry
-
Source
-
Request Body
-
Description
-
The new feed entry to add.
Returns
The generated item update if the operation was successful.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/categories
Copy URL
Gets the issue categories for the specified project.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/categories
Copy URL
Creates an issue category for the specified project.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
Request Body
(Validated as "issueCategory")
-
Type
-
TeamDynamix.Api.Issues.IssueOrRiskCategory
-
Source
-
Request Body
-
Description
-
The issue category to create.
Access Restrictions
This action requires the "Project: Manage Issue Categories" permission.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
DELETE
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
Copy URL
Deletes an issue category for the specified project.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueCategoryId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue category ID.
Access Restrictions
This action requires the "Project: Manage Issue Categories" permission.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
Copy URL
Gets an issue category for the specified project.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueCategoryId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The category ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
PUT
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
Copy URL
Edits an issue category for the specified project.
Parameters
-
-
Parameter Name
-
projectId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
issueCategoryId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The issue category ID.
-
-
Parameter Name
-
Request Body
(Validated as "issueCategory")
-
Type
-
TeamDynamix.Api.Issues.IssueOrRiskCategory
-
Source
-
Request Body
-
Description
-
The issue category to edit.
Access Restrictions
This action requires the "Project: Manage Issue Categories" permission.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues/priorities
Copy URL
Gets the risk priorities.
Returns
The possible choices for issue priority.
(Dictionary<String, Int32>)
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues/search
Copy URL
Gets a list of issues.
Will not return full issue information.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The
Attributes property will not be included in the results.
To retrieve such information, you must load an issue individually.
GET
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues/statuses
Copy URL
Gets the issue statuses for the BE.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues?NotifyOnClosed={NotifyOnClosed}
Copy URL
Creates an issue
Access Restrictions
This action requires the "Issue: Add Issues" permission.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.