1. APIs
  2. Product Models

Contents

Summary

Contains methods for working with asset product models.

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}/assets/models Copy URL

Gets a list of all active product models. Will not return full product model information.

Returns

A list of all active product models. (TeamDynamix.Api.Assets.ProductModel[])

Rate/Submission Limitations

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

Remarks

The Attributes property will not be included in the results. To retrieve such information, you must load a product model individually.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/assets/models Copy URL

Creates a new product model.

Parameters

Returns

The newly created product model, 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/models/{id} Copy URL

Gets the specified product model.

Parameters

Returns

The product model if it was found. (TeamDynamix.Api.Assets.ProductModel)

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

Edits the specified product model.

Parameters

Returns

The updated product model, if the operation was successful. (TeamDynamix.Api.Assets.ProductModel)

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/models/search Copy URL

Gets a list of product models. Will not return full product model information.

Parameters

Returns

A list of product models matching the specified criteria. (TeamDynamix.Api.Assets.ProductModel[])

Rate/Submission Limitations

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

Remarks

The Attributes property will not be included in the results. To retrieve such information, you must load a product model individually.