TeamDynamix Web API: Issues

Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:

application/json

Calls using any other content type (ex: text/plain) are not supported.

Summary
Access Restrictions
Methods
- GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}
  Gets an issue.
- POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}
  Updates an issue.
- POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/attachments?showViewLink={showViewLink}
  Uploads an attachment to an issue. The file should be included as part of the submission's form data.
- GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed
  Gets the feed entries for an issue.
- POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed
  Adds a comment on an issue.
- GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories
  Gets the issue categories for the specified project.
- POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories
  Creates an issue category for the specified project.
- DELETE https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
  Deletes an issue category for the specified project.
- GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
  Gets an issue category for the specified project.
- PUT https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId}
  Edits an issue category for the specified project.
- GET https://help.ohio.edu/TDWebApi/api/projects/issues/priorities
  Gets the risk priorities.
- POST https://help.ohio.edu/TDWebApi/api/projects/issues/search
  Gets a list of issues. Will not return full issue information.
- GET https://help.ohio.edu/TDWebApi/api/projects/issues/statuses
  Gets the issue statuses for the BE.
- POST https://help.ohio.edu/TDWebApi/api/projects/issues?NotifyOnClosed={NotifyOnClosed}
  Creates an issue

Summary

Contains methods for working with issues.

Access Restrictions

This section requires access to the TDProjects application.

API Methods

GET https://help.ohio.edu/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.

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://help.ohio.edu/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.

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.

POST https://help.ohio.edu/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://help.ohio.edu/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.

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://help.ohio.edu/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://help.ohio.edu/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.

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.

POST https://help.ohio.edu/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.

Returns

A newly created risk.

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://help.ohio.edu/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.

Returns

The deleted issue.

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://help.ohio.edu/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.

Returns

The issue category. (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.

PUT https://help.ohio.edu/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.

Returns

The modified issue. (TeamDynamix.Api.Issues.IssueOrRiskCategory)

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://help.ohio.edu/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://help.ohio.edu/TDWebApi/api/projects/issues/search Copy URL

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

Parameters

Parameter Name

Request Body (Validated as "search")

Type

TeamDynamix.Api.Issues.IssueSearch

Source

Request Body

Description

The searching parameters to use.

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://help.ohio.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://help.ohio.edu/TDWebApi/api/projects/issues?NotifyOnClosed={NotifyOnClosed} Copy URL

Creates an issue

Parameters

Parameter Name

options

Type

TeamDynamix.Api.Issues.IssueRiskCreateOptions

Source

URI

Description

The options to use when creating issues.
Parameter Name

Request Body (Validated as "issue")

Type

TeamDynamix.Api.Issues.Issue

Source

Request Body

Description

The issue to create.

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.

Contents

Summary

Access Restrictions

API Methods

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

Parameters

projectId

issueId

Returns

Rate/Submission Limitations

POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId} Copy URL

Parameters

projectId

issueId

Request Body (Validated as "issueUpdate")

Returns

Rate/Submission Limitations

POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/attachments?showViewLink={showViewLink} Copy URL

Parameters

projectId

issueId

showViewLink

File Upload

Returns

Rate/Submission Limitations

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

Parameters

projectId

issueId

Returns

Rate/Submission Limitations

Remarks

POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/{issueId}/feed Copy URL

Parameters

projectId

issueId

Request Body (Validated as "itemUpdate")

Returns

Rate/Submission Limitations

GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories Copy URL

Parameters

projectId

Returns

Rate/Submission Limitations

POST https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories Copy URL

Parameters

projectId

Request Body (Validated as "issueCategory")

Returns

Access Restrictions

Rate/Submission Limitations

DELETE https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId} Copy URL

Parameters

projectId

issueCategoryId

Returns

Access Restrictions

Rate/Submission Limitations

GET https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId} Copy URL

Parameters

projectId

issueCategoryId

Returns

Rate/Submission Limitations

PUT https://help.ohio.edu/TDWebApi/api/projects/{projectId}/issues/categories/{issueCategoryId} Copy URL

Parameters

projectId

issueCategoryId

Request Body (Validated as "issueCategory")

Returns

Access Restrictions

Rate/Submission Limitations

GET https://help.ohio.edu/TDWebApi/api/projects/issues/priorities Copy URL

Returns

Rate/Submission Limitations

POST https://help.ohio.edu/TDWebApi/api/projects/issues/search Copy URL

Parameters

Request Body (Validated as "search")

Returns

Rate/Submission Limitations