1. APIs
  2. Links

Contents

Summary

Contains methods for working with links.

API Methods

POST https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/links Copy URL

Creates a link.

Parameters

Returns

A newly created link.

Access Restrictions

This action requires access to the TDProjects application.

Rate/Submission Limitations

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

Remarks

The calling user must satisfy all of the following requirements to create a link:
  1. Be able to access the project in one of the following ways:
    • Be an admin service account.
    • Be a project member with access to the TDNext and TDProjects applications.
  2. The project must be open (not closed/cancelled).
  3. Template projects and private team projects are not supported.

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

Gets a link.

Parameters

Returns

The link's details. (TeamDynamix.Api.Links.Link)

Rate/Submission Limitations

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

Remarks

The calling user must satisfy all of the following requirements to view a link:
  1. Be able to access the project in one of the following ways:
    • Be an admin service account.
    • Be a project member with access to the TDNext and TDProjects applications.
    • Have the TDNext and Workspaces applications and can view the project (as a work item) in one of their workspaces.
    • Have the TDAnalysis application.
  2. Template projects and private team projects are not supported.

PUT https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/links/{linkId} Copy URL

Edits an existing link.

Parameters

Returns

The updated link. (TeamDynamix.Api.Links.Link)

Access Restrictions

This action requires access to the TDProjects application.

Rate/Submission Limitations

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

Remarks

The calling user must satisfy all of the following requirements to edit a link:
  1. Be able to access the project in one of the following ways:
    • Be an admin service account.
    • Be a project member with access to the TDNext and TDProjects applications.
  2. The project must be open (not closed/cancelled).
  3. Template projects and private team projects are not supported.

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

Gets the feed entries for a link.

Parameters

Returns

The feed for the link specified link. (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}/links/{linkId}/feed Copy URL

Adds a comment on a link.

Parameters

Returns

The generated item update if the operation was successful. (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.

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

Gets the link categories for the specified project.

Parameters

Returns

The possible choices for link categories. (TeamDynamix.Api.Links.LinkCategory[])

Rate/Submission Limitations

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

Remarks

The calling user must satisfy all of the following requirements to view link categories:
  1. Be able to access the project in one of the following ways:
    • Be an admin service account.
    • Be a project member with access to the TDNext and TDProjects applications.
    • Have the TDNext and Workspaces applications and can view the project (as a work item) in one of their workspaces.
    • Have the TDAnalysis application.
  2. Template projects and private team projects are not supported.

POST https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/links/search Copy URL

Gets a list of links. Will not return full link information.

Parameters

Returns

A collection of links. (TeamDynamix.Api.Links.Link[])

Rate/Submission Limitations

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

Remarks

The following properties will not be included in the results. To retrieve such information, you must load a link individually.
  1. FlaggedDate
  2. Description
The calling user must satisfy all of the following requirements to search links:
  1. Be able to access the project in one of the following ways:
    • Be an admin service account.
    • Be a project member with access to the TDNext and TDProjects applications.
    • Have the TDNext and Workspaces applications and can view the project (as a work item) in one of their workspaces.
    • Have the TDAnalysis application.
  2. Template projects and private team projects are not supported.