1. APIs
  2. Ticket Searches/Reports

Contents

Summary

Contains methods for working with ticket saved searches in a ticketing application.

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

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

Gets a list of ticket saved searches that are visible to the user.

Returns

A list of ticket saved searches visible to the user. (TeamDynamix.Api.SavedSearches.SavedSearch[])

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/{appId}/tickets/searches/{searchId}/results Copy URL

Gets a page of tickets matching the provided saved search and pagination options.

Parameters

Returns

The resulting page of tickets. (TeamDynamix.Api.ResultPage<TeamDynamix.Api.Tickets.Ticket>)

Rate/Submission Limitations

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

Remarks

This endpoint will not return all ticket information. For example, the following collection properties will not be included in the results:
  • Attachments
  • Attributes
  • Description
  • Notify
  • Tasks
To retrieve such information, you must load a ticket individually.