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
-
Configuration Items
Contents
Summary
Contains methods for working with
configuration items
and their relationships.
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}/cmdb
Copy URL
Creates a configuration item.
Returns
The created configuration item 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/{id}
Copy URL
Gets a configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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}/cmdb/{id}
Copy URL
Edits the specified configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item ID.
-
-
Parameter Name
-
Request Body
(Validated as "item")
-
Type
-
TeamDynamix.Api.Cmdb.ConfigurationItem
-
Source
-
Request Body
-
Description
-
The configuration item 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}/cmdb/{id}/articles
Copy URL
Gets a list of the knowledge base articles associated with the specified configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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}/cmdb/{id}/articles/{articleId}
Copy URL
Removes a relationship between a configuration item and a knowledge base article.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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}/cmdb/{id}/articles/{articleId}
Copy URL
Adds an article relationship to the specified configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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.
POST
https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/{id}/attachments?showViewLink={showViewLink}
Copy URL
Uploads an attachment to a configuration item. The file should be included
as part of the submission's form data.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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.
Remarks
This operation is only supported for configuration items that are not system maintained.
Configuration items that are backed by other items in TeamDynamix cannot have attachments added through this
endpoint.
GET
https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/{id}/feed
Copy URL
Gets the feed entries for a configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item 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}/cmdb/{id}/feed
Copy URL
Posts a comment to the configuration item's feed.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item ID.
-
-
Parameter Name
-
Request Body
(Validated as "update")
-
Type
-
TeamDynamix.Api.Feed.ItemUpdate
-
Source
-
Request Body
-
Description
-
The update.
Returns
A copy of the feed entry with the ID property updated to reflect its assigned ID.
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/{id}/relationships
Copy URL
Gets a configuration item's relationships.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item ID.
Access Restrictions
This action requires access to the TDNext application.
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}/cmdb/{id}/relationships/{relationshipId}
Copy URL
Removes a relationship from a configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item ID.
-
-
Parameter Name
-
relationshipId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the relationship to remove.
Returns
A response message indicating if the operation
was successful or not.
Access Restrictions
This action requires access to the TDNext application.
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/{id}/relationships?typeId={typeId}&otherItemId={otherItemId}&isParent={isParent}&removeExisting={removeExisting}
Copy URL
Adds a relationship between the specified configuration item and another item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The configuration item ID.
-
-
Parameter Name
-
typeId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the associated
relationship type.
-
-
Parameter Name
-
otherItemId
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the other configuration item.
-
-
Parameter Name
-
isParent
-
Type
-
Boolean
-
Source
-
URI
-
Description
-
If
true, indicates that the configuration item identified
by id will be the parent; otherwise, indicates that the configuration
item specified by otherItemId will be the parent.
-
-
Parameter Name
-
removeExisting
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
False.
-
Description
-
If
true, will remove existing relationships
for the item that match the typeId/isParent
combination.
Returns
The created relationship if it was successfully added.
Access Restrictions
This action requires access to the TDNext application.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The system-defined relationship type cannot be used to add relationships.
GET
https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/{id}/tickets
Copy URL
Gets the tickets related to a configuration item.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The ID of the configuration item to retrieve related tickets for.
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/forms
Copy URL
Gets all active configuration item 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}/cmdb/search
Copy URL
Gets a list of configuration items. Will not return full configuration item 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 a configuration item individually.