TeamDynamix Web API: Reports

Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:

application/json

Calls using any other content type (ex: text/plain) are not supported.

Contents

Summary
Methods
- GET https://services.dartmouth.edu/TDWebApi/api/reports
  Gets a list of all Report Builder reports visible to the user.
- GET https://services.dartmouth.edu/TDWebApi/api/reports/{id}?withData={withData}&dataSortExpression={dataSortExpression}
  Gets information about a report, optionally including data.
- POST https://services.dartmouth.edu/TDWebApi/api/reports/search
  Gets a list of Report Builder reports visible to the user that match the provided search criteria.

Summary

Contains methods for working with Report Builder reports.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/reports Copy URL

Gets a list of all Report Builder reports visible to the user.

Returns

The Report Builder reports visible to the user. (TeamDynamix.Api.Reporting.ReportInfo[])

Rate/Submission Limitations

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

GET https://services.dartmouth.edu/TDWebApi/api/reports/{id}?withData={withData}&dataSortExpression={dataSortExpression} Copy URL

Gets information about a report, optionally including data.

Parameters

Parameter Name

id

Type

Int32

Source

URI

Description

The report ID.
Parameter Name

withData

Type

Boolean

Source

URI

Default

This parameter is optional, with a default value of False.

Description

If true, will populate the returned report's collection of rows.
Parameter Name

dataSortExpression

Type

String

Source

URI

Default

This parameter is optional, with a default value of ''.

Description

The sorting expression to use for the report's data. Only applicable when data is being retrieved. When not provided, will fall back to the default used for the report.

Returns

The indicated report. (TeamDynamix.Api.Reporting.Report)

Rate/Submission Limitations

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

POST https://services.dartmouth.edu/TDWebApi/api/reports/search Copy URL

Gets a list of Report Builder reports visible to the user that match the provided search criteria.

Parameters

Parameter Name

Request Body (Validated as "search")

Type

TeamDynamix.Api.Reporting.ReportSearch

Source

Request Body

Description

The searching parameters to use.

Returns

The Report Builder reports visible to the user. (TeamDynamix.Api.Reporting.ReportInfo[])

Rate/Submission Limitations

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