1. APIs
  2. Plans

Contents

Summary

Contains methods for working with project plans.

Access Restrictions

This section requires access to the TDProjects application.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/boards/{boardId}/lists Copy URL

Gets the lists available to a cardwall board.

Parameters

Returns

The collection of available lists for the specified cardwal board. (TeamDynamix.Api.Boards.ListSummary[])

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 the following requirements to retrieve cardwall board lists:
  1. Have access to both the TDNext and TDProjects applications.
  2. The specified project must be open and active (not closed).
  3. The caller must be a project member or admin service account.

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

Creates a waterfall project plan or board (card wall). Plans/boards will not be checked out after creation.

Parameters

Returns

The created plan or board 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}/plans/{planID} Copy URL

Gets a plan, including the Tasks, their resources and relationships.

Parameters

Returns

A TeamDynamix.Api.Plans.Plan object. (TeamDynamix.Api.Plans.Plan)

Rate/Submission Limitations

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

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/plans/{planId}/checkedOutTo Copy URL

Gets the resource for the user that has checked out the plan. This can be useful when the user is not a resource on the plan (which can happen with working with plans on requests and templates).

Parameters

Returns

The resource. (TeamDynamix.Api.Projects.Resource)

Rate/Submission Limitations

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

POST https://services.dartmouth.edu/TDWebApi/api/projects/{projectID}/plans/{planID}/drafts/{draftID} Copy URL

Edit a plan name and description

Parameters

Returns

A TeamDynamix.Api.Plans.Plan object. (TeamDynamix.Api.PlanUpdates)

Rate/Submission Limitations

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

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

Gets the feed entries for a plan.

Parameters

Returns

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

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 90 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.

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/plans/{planId}/tasks Copy URL

Gets the tasks for a plan.

Parameters

Returns

The plan's tasks. (TeamDynamix.Api.Plans.Task[])

Rate/Submission Limitations

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

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

Gets a list of plans.

Parameters

Returns

A collection of plans. (TeamDynamix.Api.Plans.Plan[])

Rate/Submission Limitations

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