Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:
Calls using any other content type (ex: text/plain) are not supported.
-
APIs
-
Contracts
Contents
Summary
Contains methods for working with
contracts.
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}/assets/contracts
Copy URL
Creates a contract. This operation requires the permission to add and modify contracts.
Returns
The created contract 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}/assets/contracts/{id}
Copy URL
Gets a contract.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
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}/assets/contracts/{id}
Copy URL
Edits an existing contract. This operation requires the permission add and modify contracts.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
-
-
Parameter Name
-
Request Body
(Validated as "contract")
-
Type
-
TeamDynamix.Api.Assets.Contract
-
Source
-
Request Body
-
Description
-
The contract with updated values.
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}/assets/contracts/{id}/associatedassets
Copy URL
Gets a list of assets associated to a contract.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
DELETE
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/contracts/{id}/associatedassets/{assetId}
Copy URL
Removes an asset from a contract. This requires the permission to modify assets.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
-
-
Parameter Name
-
assetId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the asset to remove from this contract.
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.
POST
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/contracts/{id}/associatedassets/{assetId}
Copy URL
Associates an asset to a contract. This requires the permission to modify assets.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
-
-
Parameter Name
-
assetId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the asset to associate to this contract.
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.
PUT
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/contracts/{id}/associatedassets/{assetId}
Copy URL
Edits an asset's contract dates for the specified asset-contract
association. This requires the permission to modify assets.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
-
-
Parameter Name
-
assetId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the asset to edit contract dates for.
-
-
Parameter Name
-
Request Body
(Validated as "assetContract")
-
Type
-
TeamDynamix.Api.Assets.AssetContract
-
Source
-
Request Body
-
Description
-
The asset-contract object with edited dates for a
Sliding
date model contract.
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
Editing an asset's contract dates is only allowed for contracts with a
Sliding date model.
POST
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/contracts/{id}/attachments?showViewLink={showViewLink}
Copy URL
Adds an attachment to a contract. This operation requires the permission to add and modify contracts.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The contract ID.
-
-
Parameter Name
-
showViewLink
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
-
Description
-
true if the View link should be shown, otherwise false. This
only applies to HTML files.
File Upload
This action accepts an uploaded file as part of the form's submission.
For information on how to structure calls with files, see the
Submitting Files page.
Returns
The created attachment, 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/{appId}/assets/contracts/search
Copy URL
Gets a list of contracts.
Will not return full contract information.
Parameters
-
-
Parameter Name
-
Request Body
(Validated as "search")
-
Type
-
TeamDynamix.Api.Assets.ContractSearch
-
Source
-
Request Body
-
Description
-
The searching parameters to use. Note that this is in addition to the
standard visibility restrictions enforced for the user.
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 contract information.
For example, the following properties will not be included in the results:
To retrieve such information, you must load a contract individually.