Knowledge Article Controller

Owned by priti.hota (Deactivated)
Last updated: Feb 14, 2019
2 min read

In this article you will learn how to retrieve, create, update, and delete Knowledge articles (aka KB articles) using the REST API.

GET - KBArticles

To retrieve existing KB articles information, specify the following information in Swagger:

  1. Click GET or Expand Operations to retrieve information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click Try it out.

POST - KBArticles

To create a new KB article, specify the following information:

  1. Click POST to create information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click the Example Value text box. The operations displayed in the text box will be copied to the KBArticles text box.
  4. 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. 

  1. Click PUT to edit the existing information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click the Example Value text box. The operations displayed in the text box will be copied to the KBArticles text box.
  4. 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:

  1. Click DELETE to create information.
  2. 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.:

  1. Click GET to retrieve a specific incident information.
  2. 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.
  3. Click Try it out. 

© 2019 Serviceaide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com