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
-
Assets
Contents
Summary
Contains methods for working with
assets.
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
Copy URL
Creates an asset.
Returns
The created asset 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.
DELETE
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/{assetId}/users/{resourceID}
Copy URL
Removes a resource from an asset.
Parameters
-
-
Parameter Name
-
assetId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
resourceID
-
Type
-
String
-
Source
-
URI
-
Description
-
The resource ID.
Returns
A response message indicating whether or not the resource was
successfully removed from the asset.
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/{id}
Copy URL
Gets an asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
PATCH
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/{id}
Copy URL
Patches an existing asset.
This only supports patching the asset itself and custom attributes. Other collections on
the asset are not supported.
About PATCH Support
For information on how to structure HTTP PATCH calls, see the
HTTP PATCH Support page.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
Request Body
(Validated as "patch")
-
Type
-
PatchDocument<TeamDynamix.Api.Assets.Asset>
-
Source
-
Request Body
-
Description
-
The patch document containing changes to apply to the asset.
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/{id}
Copy URL
Edits an existing asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
Request Body
(Validated as "asset")
-
Type
-
TeamDynamix.Api.Assets.Asset
-
Source
-
Request Body
-
Description
-
The asset 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/{id}/articles
Copy URL
Gets a list of the knowledge base articles associated with the specified asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset 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/{id}/articles/{articleId}
Copy URL
Removes a relationship between an asset and a knowledge base article.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
articleId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the related article to remove.
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/{id}/articles/{articleId}
Copy URL
Adds an article relationship to the specified asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
articleId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the article to associate.
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.
GET
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/{id}/associatedcontracts
Copy URL
Gets a list of contracts associated to an asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset 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/{id}/associatedcontracts/{contractId}
Copy URL
Removes a contract from an asset. This requires the permission to modify assets.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
contractId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the contract to remove from this asset.
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/{id}/associatedcontracts/{contractId}
Copy URL
Associates a contract to an asset. This requires the permission to modify assets.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
contractId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the contract to associate to this asset.
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/{id}/associatedcontracts/{contractId}
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 asset ID.
-
-
Parameter Name
-
contractId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the contract to edit asset-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/{id}/attachments?showViewLink={showViewLink}
Copy URL
Uploads an attachment to an asset. The file should be included
as part of the submission's form data.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset 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 generated 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.
GET
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/{id}/feed
Copy URL
Gets the feed entries for an asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
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}/assets/{id}/feed
Copy URL
Add a comment to an asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
Request Body
(Validated as "itemUpdate")
-
Type
-
TeamDynamix.Api.Feed.FeedEntry
-
Source
-
Request Body
-
Description
-
The item update containing the comment.
Returns
The created comment 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/{id}/tickets/{ticketId}
Copy URL
Adds an asset to a ticket.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
ticketId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ticket ID. This must belong to an application
that the user can access.
Returns
A response message indicating whether or not the addition was sucessful.
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/{id}/tickets/{ticketID}
Copy URL
Removes a ticket from an asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
ticketID
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ticket ID. This must belong to an application
that the user can access.
Returns
A response message indicating whether or not the deletion was sucessful.
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/{id}/users
Copy URL
Gets the asset resources.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The id.
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/{id}/users/{resourceID}
Copy URL
Adds a resource to asset.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The asset ID.
-
-
Parameter Name
-
resourceID
-
Type
-
String
-
Source
-
URI
-
Description
-
The resource ID.
Returns
A response message indicating whether or not the resource was
successfully added to the asset.
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/feed?DateFrom={DateFrom}&DateTo={DateTo}&ReplyCount={ReplyCount}&ReturnCount={ReturnCount}
Copy URL
Gets feed items for an asset application feed matching the
specified search.
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/forms
Copy URL
Gets all active asset forms for the specified application.
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/import
Copy URL
Performs a bulk insert/update of assets in the system.
Returns
A collection of results for each individual item. These results will be in the same order
that the items have been provided, so the first result will correspond with the result for the
first provided item.
(
TeamDynamix.Api.BulkOperations.ItemResult[])
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
5 calls
per IP address
every 60 seconds.
This method accepts a list of items. However, depending on your environment,
there may be a restriction on the number of items provided with a single call.
By default, this method is capped at 1000 items.
POST
https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/search
Copy URL
Gets a list of assets. Will not return full asset information.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The following properties will not be included in the results:
To retrieve such information, you must load an asset individually.