In this article you will learn how to retrieve, create, update, and delete Knowledge articles (aka KB articles) using the REST API.
- KBArticles
To retrieve existing KB articles information, specify the following information in Swagger:
- Click GET or Expand Operations to retrieve information.
- Specify the following details in the Parameters section.:
- ISM application URL
- User authtoken
- Slice token
- Web service user name and password - Click Try it out.
POST - KBArticles
To create a new KB article, specify the following information:
- Click POST to create information.
- Specify the following details in the Parameters section.:
- ISM application URL
- User authtoken
- Slice token
- Web service user name and password - Click the Example Value text box. The operations displayed in the text box will be copied to the KBArticles text box.
- Click Try it out.
The following information is displayed in the Example Value box.
Code Block - KB Articles {
"ActionId": "string",
"ApprovalList": "string",
"ApprovedTimestamp": "string",
"ApprovedUserName": "string",
"AssignedCaseID": "string",
"AssignedID": "string",
"AttachmentLogoID": "string",
"AverageRating": "string",
"CategorizationCategory": "string",
"CategorizationClass": "string",
"CategorizationID": "string",
"CategorizationItem": "string",
"CategorizationItems": "string",
"CategorizationType": "string",
"CauseRichText": "string",
"ComplianceOwner": "string",
"ComplianceOwnerID": "string",
"ComplianceReviewProcess": "string",
"CreationExternalUserID": "string",
"CreationTimestamp": "string",
"CreationUserName": "string",
"CurrentDate": "string",
"CurrentUserRating": "string",
"ExpiryDate": "string",
"IsSaveNExit": "string",
"KBArticleCategory": "string",
"KBArticleCategoryAttachmentID": "string",
"KBArticleCategoryDefaultDisplay": "string",
"KBArticleCategoryID": "string",
"KBArticleFeedbackCount": "string",
"KBArticleIsNotUsefulCount": "string",
"KBArticleIsUsefulCount": "string",
"KBArticleState": "string",
"KBArticleViewCount": "string",
"KBOwner": "string",
"KBOwnerID": "string",
"LastModExternalUserID": "string",
"LastModTimestamp": "string",
"LastModUserName": "string",
"MaxExpiryDate": "string",
"MdrElementID": "string",
"NonTranslatedKBArticleCategory": "string",
"Resolution": "string",
"ResolutionRichText": "string",
"RootCause": "string",
"ShortSymptom": "string",
"StickyKBArticle": "string",
"SymptomDescription": "string",
"SymptomDetailRichText": "string",
"TenantId": "string",
"TicketType": "string",
"TicketTypeId": "string"
} |
|---|
PUT - KBArticles
PUT method is used when you want to edit an existing record.
- Click PUT to edit the existing information.
- Specify the following details in the Parameters section.:
- ISM application URL
- User authtoken
- Slice token
- Web service user name and password - Click the Example Value text box. The operations displayed in the text box will be copied to the KBArticles text box.
- Click Try it out.
The following information is displayed in the Example Value box.
Code Block - KB Article {
"ActionId": "string",
"ApprovalList": "string",
"ApprovedTimestamp": "string",
"ApprovedUserName": "string",
"AssignedCaseID": "string",
"AssignedID": "string",
"AttachmentLogoID": "string",
"AverageRating": "string",
"CategorizationCategory": "string",
"CategorizationClass": "string",
"CategorizationID": "string",
"CategorizationItem": "string",
"CategorizationItems": "string",
"CategorizationType": "string",
"CauseRichText": "string",
"ComplianceOwner": "string",
"ComplianceOwnerID": "string",
"ComplianceReviewProcess": "string",
"CreationExternalUserID": "string",
"CreationTimestamp": "string",
"CreationUserName": "string",
"CurrentDate": "string",
"CurrentUserRating": "string",
"ExpiryDate": "string",
"IsSaveNExit": "string",
"KBArticleCategory": "string",
"KBArticleCategoryAttachmentID": "string",
"KBArticleCategoryDefaultDisplay": "string",
"KBArticleCategoryID": "string",
"KBArticleFeedbackCount": "string",
"KBArticleIsNotUsefulCount": "string",
"KBArticleIsUsefulCount": "string",
"KBArticleState": "string",
"KBArticleViewCount": "string",
"KBOwner": "string",
"KBOwnerID": "string",
"LastModExternalUserID": "string",
"LastModTimestamp": "string",
"LastModUserName": "string",
"MaxExpiryDate": "string",
"MdrElementID": "string",
"NonTranslatedKBArticleCategory": "string",
"Resolution": "string",
"ResolutionRichText": "string",
"RootCause": "string",
"ShortSymptom": "string",
"StickyKBArticle": "string",
"SymptomDescription": "string",
"SymptomDetailRichText": "string",
"TenantId": "string",
"TicketType": "string",
"TicketTypeId": "string"
} |
|---|
DELETE - KBArticles
To delete a KB article, specify the following information:
- Click DELETE to create information.
- Specify the following details in the Parameters section.:
- ISM application URL
- User authtoken
- Slice token
- Web service user name and password
- Specify the KB article ID which you want to delete.
GET - KBArticles/{id}
You can use this method to retrieve a specific KB article details by specifying the ID. Specify the following details.:
- Click GET to retrieve a specific incident information.
- Specify the following details in the Parameters section.:
- ISM application URL
- User authtoken
- Slice token
- Web service user name and password
- Specify the KB article ID for which you want to retrieve information.
- Click Try it out.