TeamDynamix Web API: Briefcase Files

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
Access Restrictions
Methods
- GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectID}/files/{id}
  Gets a briefcase file.
- GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectID}/files/{id}/content
  Gets the contents of a briefcase file.

Summary

Contains methods for working with briefcase files.

Access Restrictions

This section requires access to the TDProjects application.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/projects/{projectID}/files/{id} Copy URL

Gets a briefcase file.

Parameters

Parameter Name

projectID

Type

Int32

Source

URI

Description

The project ID.
Parameter Name

id

Type

Guid

Source

URI

Description

The file ID.

Returns

The briefcase file. (TeamDynamix.Api.Briefcase.File)

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}/files/{id}/content Copy URL

Gets the contents of a briefcase file.

Parameters

Parameter Name

projectID

Type

Int32

Source

URI

Description

The project ID.
Parameter Name

id

Type

Guid

Source

URI

Description

The file ID.

Returns

The contents of the briefcase file.

Rate/Submission Limitations

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