1. APIs
  2. Attributes

Contents

Summary

Contains methods for working with custom attributes.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/attributes/{id}/choices Copy URL

Gets the choices for the specified custom attribute.

Parameters

Returns

The choices for the custom attribute. (TeamDynamix.Api.CustomAttributes.CustomAttributeChoice[])

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

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/attributes/{id}/choices/{choiceId} Copy URL

Removes the specified choice from the custom attribute.

Parameters

Returns

A response message indicating whether or not the choice was successfully removed from the custom attribute.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

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

Remarks

When custom forms are supported, a choice cannot be removed while it is used as a default value in a custom form.

PUT https://services.dartmouth.edu/TDWebApi/api/attributes/{id}/choices/{choiceId} Copy URL

Edits an existing choice associated with the specified custom attribute.

Parameters

Returns

The updated choice if the operation was successful.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

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/attributes/{id}/choices?copyFromChoiceId={copyFromChoiceId} Copy URL

Adds a new choice to the specified custom attribute.

Parameters

Returns

The created choice if the operation was successful.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

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/attributes/custom?componentId={componentId}&associatedTypeId={associatedTypeId}&appId={appId} Copy URL

Gets the custom attributes for the specified component.

Parameters

Returns

The active custom attributes for the component. Protected and/or inactive custom attributes will be excluded. (TeamDynamix.Api.CustomAttributes.CustomAttribute[])

Rate/Submission Limitations

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