1. APIs
  2. Issues

Contents

Summary

Contains methods for working with issues.

Access Restrictions

This section requires access to the TDProjects application.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/issues/{issueId} Copy URL

Gets an issue.

Parameters

Returns

The issue's details. (TeamDynamix.Api.Issues.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://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/issues/{issueId} Copy URL

Updates an issue.

Parameters

Returns

The issue's details.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed Copy URL

Gets the feed entries for an issue.

Parameters

Returns

The issue's feed entries. (TeamDynamix.Api.Feed.ItemUpdate[])

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://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed Copy URL

Adds a comment on an issue.

Parameters

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://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/issues/categories Copy URL

Gets the issue categories for the specified project.

Parameters

Returns

The possible choices for issue categories. (TeamDynamix.Api.Issues.IssueOrRiskCategory[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/projects/issues/priorities Copy URL

Gets the issue 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://services.dartmouth.edu/TDWebApi/api/projects/issues/search Copy URL

Gets a list of issues. Will not return full issue information.

Parameters

Returns

A collection of issues. (TeamDynamix.Api.Issues.Issue[])

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://services.dartmouth.edu/TDWebApi/api/projects/issues/statuses Copy URL

Gets the issue statuses for the BE.

Returns

The possible choices for issue status. (TeamDynamix.Api.Issues.IssueStatus[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/projects/issues?NotifyOnClosed={NotifyOnClosed} Copy URL

Creates an issue

Parameters

Returns

A newly created 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.