1. APIs
  2. Ticket Tasks

Contents

Summary

Contains methods for working with ticket tasks.

Application Identifier Use

This set of APIs uses a application identifier parameter, named appId and of type Int32, which specifies the corresponding application in which actions should be performed.

For the sake of brevity, it is omitted from the parameter list of the API methods below, but still needs to be included whenever there is an {appId} placeholder in the URL for the API method.

API Methods

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/tickets/{ticketId}/tasks Copy URL

Creates a new ticket task on a ticket.

Parameters

Returns

The created ticket task, if it was successfully created.

Rate/Submission Limitations

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

Remarks

Only standard ticket tasks may be added to a ticket in this manner. Workflow tasks and maintenance activities cannot be added to a ticket using this method.

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/tickets/{ticketId}/tasks/{id} Copy URL

Removes a ticket task from a ticket.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

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

Remarks

This cannot be used to remove maintenance activities or workflow tasks from a ticket. Only standard ticket tasks may be removed using this method.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/tickets/{ticketId}/tasks/{id} Copy URL

Gets an individual ticket task on a ticket.

Parameters

Returns

The ticket task, if found on the specified ticket. (TeamDynamix.Api.Tickets.TicketTask)

Rate/Submission Limitations

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

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/tickets/{ticketId}/tasks/{id} Copy URL

Updates a ticket task with a set of new values.

Parameters

Returns

The modified ticket task, if the operation was successful. (TeamDynamix.Api.Tickets.TicketTask)

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/{appId}/tickets/{ticketId}/tasks/{id}/feed Copy URL

Gets the feed entries for a ticket task.

Parameters

Returns

The ticket task'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://services.dartmouth.edu/TDWebApi/api/{appId}/tickets/{ticketId}/tasks/{id}/feed Copy URL

Updates a ticket task.

Parameters

Returns

The feed entry generated, 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/{appId}/tickets/{ticketId}/tasks?isEligiblePredecessor={isEligiblePredecessor} Copy URL

Gets a list of tasks currently on a ticket.

Parameters

Returns

A list of ticket tasks currently on the specified ticket. (TeamDynamix.Api.Tickets.TicketTask[])

Rate/Submission Limitations

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