1. APIs
  2. 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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb Copy URL

Creates a configuration item.

Parameters

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.

DELETE https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id} Copy URL

Deletes the specified configuration item. This cannot be undone.

Parameters

Returns

A response message indicating if the operation was successful or not.

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id} Copy URL

Gets a configuration item.

Parameters

Returns

The configuration item if it was found. (TeamDynamix.Api.Cmdb.ConfigurationItem)

Rate/Submission Limitations

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

PUT https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id} Copy URL

Edits the specified configuration item.

Parameters

Returns

The updated configuration item. (TeamDynamix.Api.Cmdb.ConfigurationItem)

Rate/Submission Limitations

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

GET https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/articles Copy URL

Gets a list of the knowledge base articles associated with the specified configuration item.

Parameters

Returns

The associated knowledge base articles. (TeamDynamix.Api.KnowledgeBase.Article[])

Rate/Submission Limitations

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

DELETE https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/articles/{articleId} Copy URL

Removes a relationship between a configuration item and a knowledge base article.

Parameters

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/articles/{articleId} Copy URL

Adds an article relationship to the specified configuration item.

Parameters

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://helpdesk.grps.org/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

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/feed Copy URL

Gets the feed entries for a configuration item.

Parameters

Returns

The configuration item's feed entries. (TeamDynamix.Api.Feed.ItemUpdate[])

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/feed Copy URL

Posts a comment to the configuration item's feed.

Parameters

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/relationships Copy URL

Gets a configuration item's relationships.

Parameters

Returns

The configuration item's relationships. (TeamDynamix.Api.Cmdb.ConfigurationItemRelationship[])

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/relationships/{relationshipId} Copy URL

Removes a relationship from a configuration item.

Parameters

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://helpdesk.grps.org/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

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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/tickets Copy URL

Gets the tickets related to a configuration item.

Parameters

Returns

A collection of tickets related to a specified configuration ittem. (TeamDynamix.Api.Tickets.TicketListing[])

Rate/Submission Limitations

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

DELETE https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/tickets/{ticketId} Copy URL

Removes a CI from ticket.

Parameters

Returns

A response message indicating whether or not the deletion was successful.

Access Restrictions

This action requires access to the TDAssets 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://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/{id}/tickets/{ticketId} Copy URL

Adds a CI to ticket.

Parameters

Returns

A response message indicating whether or not the addition was successful.

Access Restrictions

This action requires access to the TDAssets application.

Rate/Submission Limitations

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

GET https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/forms Copy URL

Gets all active configuration item forms for the specified application.

Returns

The active configuration item forms for the specified application. (TeamDynamix.Api.Forms.Form[])

Rate/Submission Limitations

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

POST https://helpdesk.grps.org/TDWebApi/api/{appId}/cmdb/search Copy URL

Gets a list of configuration items. Will not return full configuration item information.

Parameters

Returns

A list of configuration items. (TeamDynamix.Api.Cmdb.ConfigurationItem[])

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:
  • Attachments
  • Attributes
To retrieve such information, you must load a configuration item individually.