1. APIs
  2. Risks

Contents

Summary

Contains methods for working with risks.

Access Restrictions

This section requires access to the TDProjects application.

API Methods

GET https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/{riskId} Copy URL

Gets a risk.

Parameters

Returns

The risk's details. (TeamDynamix.Api.Issues.Risk)

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}/risks/{riskId} Copy URL

Updates a risk.

Parameters

Returns

The risk'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://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/{riskId}/feed Copy URL

Gets the feed entries for a risk.

Parameters

Returns

The risk'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://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/{riskId}/feed Copy URL

Adds a comment on a risk.

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://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/categories Copy URL

Gets the risks categories for the specified project.

Parameters

Returns

The possible choices for risks 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://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/categories Copy URL

Creates a risk category for the specified project.

Parameters

Returns

A newly created risk.

Access Restrictions

This action requires the "Project: Manage Risk 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}/risks/categories/{riskCategoryId} Copy URL

Deletes a risk category for the specified project.

Parameters

Returns

The deleted risk.

Access Restrictions

This action requires the "Project: Manage Risk 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}/risks/categories/{riskCategoryId} Copy URL

Gets a risk category for the specified project.

Parameters

Returns

The risk 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://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/risks/categories/{riskCategoryId} Copy URL

Edits a risk category for the specified project.

Parameters

Returns

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

Access Restrictions

This action requires the "Project: Manage Risk Categories" permission.

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/risks/search Copy URL

Gets a list of risks. Will not return full risk information.

Parameters

Returns

A collection of risks. (TeamDynamix.Api.Issues.Risk[])

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 a risk individually.

GET https://solutions.teamdynamix.com/TDWebApi/api/projects/risks/statuses Copy URL

Gets the risk statuses for the BE.

Returns

The possible choices for risk 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://solutions.teamdynamix.com/TDWebApi/api/projects/risks?NotifyOnClosed={NotifyOnClosed} Copy URL

Creates a risk

Parameters

Returns

A newly created risk.

Access Restrictions

This action requires the "Risk: Add Risks" permission.

Rate/Submission Limitations

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