1. APIs
  2. Tasks

Contents

Summary

Contains methods for working with project tasks.

Access Restrictions

This section requires access to the TDProjects application.

Remarks

All public methods in this controller are compatible with both waterfall project plans, as well as cardwalls. To work with cardwalls, replace references to planId values with cardwall board IDs and references to taskId values with card IDs.

API Methods

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

Gets details about a specific task.

Parameters

Returns

Details on the selected task. (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/{planId}/tasks/{taskId} Copy URL

Updates a task with new values.

Parameters

Returns

The updated task if the save was successful. (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.

Remarks

This endpoint requires waterfall plans to already be checked out to the caller via the web UI. Waterfall plans will not be checked out or in when using this endpoint.

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

Adds a comment on a task.

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.

POST https://services.dartmouth.edu/TDWebApi/api/projects/{projectId}/plans/{planId}/tasks/{taskId}/edit?notifyNewResources={notifyNewResources} Copy URL

Edits a waterfall plan task or cardwall card with new values.

Parameters

Returns

The updated task/card if the save was successful. (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.

Remarks

For waterfall project plans, this endpoint will attempt to check out the plan, edit the task, then check the plan back in. Regardless of plan type (waterfall or cardwall), setting positional properties like Outline Number, Work Breadown Structure (WBS), parent task or indent level are not supported. If the edit operation would move a cardwall card to a different list, list percent complete values will be applied if they exist.
The calling user must satisfy the following requirements to edit tasks or cards:
  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.
  4. If working with a waterfall plan, the user must have the permission to Edit Plans.
  5. The caller must have the permission to Edit Tasks.
  6. If working with a waterfall plan, the plan cannot be currently checked out to any other user.

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

Gets the feed entries for a task on the plan.

Parameters

Returns

The task'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.

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

Adds a comment on a task.

Parameters

Returns

The updated task if the operation was successful.

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}/tasks/insert Copy URL

Inserts a new task into a waterfall project plan or a new card into a cardwall board.

Parameters

Returns

A list of tasks that were changed from the operation. (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.

Remarks

For waterfall project plans, this endpoint will attempt to check out the plan, insert the task, then check the plan back in. Regardless of plan type (waterfall or cardwall), setting positional properties like Outline Number, Work Breadown Structure (WBS), parent task or indent level are not supported. All task/card creations will insert the item at the bottom of the plan/board list, and at the outermost indent level.
The calling user must satisfy the following requirements to create new tasks or cards:
  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.
  4. If working with a waterfall plan, the user must have the permission to Edit Plans.
  5. The caller must have the permission to Add Tasks.
  6. If working with a waterfall plan, the plan cannot be currently checked out to any other user.