1. APIs
  2. Knowledge Base

Contents

Summary

Contains methods for working with Knowledge Base articles and categories.

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

Creates a Knowledge Base article.

Parameters

Returns

The created article 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

It is not possible to change the public status or other permissions for the article through this method. The permissions will be automatically inherited from the parent category (or, in the case of a root-level article, will be defaulted to public).

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id} Copy URL

Deletes a knowledge base article. This cannot be undone.

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.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id} Copy URL

Gets a Knowledge Base article.

Parameters

Returns

The current revision of the article. (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.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id} Copy URL

Edits an existing article.

Parameters

Returns

The updated article. (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.

Remarks

This will not update the article's permission options (such as that of permission inheritance, public status, or whitelist/blacklist options). Published status, however, can still be modified through this method.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id}/assetscis Copy URL

Gets a list of assets and configuration items associated with the specified article.

Parameters

Returns

The associated assets and 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.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id}/attachments?showViewLink={showViewLink} Copy URL

Adds an attachment to an article.

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 created 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.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id}/related Copy URL

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

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://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id}/related/{relatedArticleId} Copy URL

Removes a relationship between two knowledge base articles.

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://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/{id}/related/{relatedArticleId} Copy URL

Adds a relationship between two knowledge base articles.

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.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/categories Copy URL

Gets the categories for the service context.

Returns

A hierarchical list of article categories. (TeamDynamix.Api.KnowledgeBase.ArticleCategory[])

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}/knowledgebase/categories Copy URL

Creates a knowledge base category.

Parameters

Returns

The created category, 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

It is not possible to change the public status or other permissions for the category through this method. The permissions will be automatically inherited from the parent category (or, in the case of a root-level category, will be defaulted to public).

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/categories/{id} Copy URL

Deletes the specified category. This cannot be undone.

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.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/categories/{id} Copy URL

Gets the specified category.

Parameters

Returns

The specified category, if the operation was successful. (TeamDynamix.Api.KnowledgeBase.ArticleCategory)

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

Edits the specified category.

Parameters

Returns

The updated category. (TeamDynamix.Api.KnowledgeBase.ArticleCategory)

Rate/Submission Limitations

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

Remarks

This will not update the category's permission options (such as that of permission inheritance, public status, or whitelist/blacklist options).

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/knowledgebase/search Copy URL

Gets a list of Knowledge Base articles. Will not return full article information.

Parameters

Returns

A list of articles matching the specified criteria. (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.

Remarks

Certain searching parameters can only be used by individuals with the "View All Articles" permission. For example, searching on the basis of status or published status can only be performed by these individuals.

The following properties will not be included in the results:
  • Attachments
  • Attributes
  • Tags
To retrieve such information, you must load an article individually.