1. APIs
  2. Configuration Relationship Types

Contents

Summary

Contains methods for working with configuration relationship types.

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}/cmdb/relationshiptypes Copy URL

Gets a list of all active relationship types.

Returns

A list of all active relationship types. (TeamDynamix.Api.Cmdb.ConfigurationRelationshipType[])

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}/cmdb/relationshiptypes Copy URL

Creates a configuration relationship type.

Parameters

Returns

The created relationship type 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}/cmdb/relationshiptypes/{id} Copy URL

Gets a relationship type.

Parameters

Returns

The relationship type if it was found. (TeamDynamix.Api.Cmdb.ConfigurationRelationshipType)

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

Edits an existing configuration relationship type.

Parameters

Returns

The updated relationship type if the operation was successful. (TeamDynamix.Api.Cmdb.ConfigurationRelationshipType)

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}/cmdb/relationshiptypes/search Copy URL

Gets a list of configuration relationship types.

Parameters

Returns

A list of relationship types matching the specified criteria. (TeamDynamix.Api.Cmdb.ConfigurationRelationshipType[])

Rate/Submission Limitations

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