Manage KB Article

Gets and updates a KB article.

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • articleIdstringrequired

    Specifies the unique article identifier

Responses

  • idstring

  • subjectstringrequired

    Defines the subject of the knowledge base article.

  • contentstringrequired

    Defines the content of the article.

  • createdTimestring

  • updatedTimestring

  • createdByobject

  • updatedByobject

  • sharedboolean

  • categoryobject

    Name of the knowledge base category.

  • statestring

    Defines the published status of the article. Example: PUBLISH, DRAFT

  • attachmentsarray

  • expiryDatestring

    Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)

  • linkedArticlesarray

    Defines the list of linked articles of the article.

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • articleIdstringrequired

    Specifies the unique article identifier

Request Body

application/json

  • idstring

  • subjectstringrequired

    Defines the subject of the knowledge base article.

  • contentstringrequired

    Defines the content of the article.

  • createdTimestring

  • updatedTimestring

  • createdByobject

  • updatedByobject

  • sharedboolean

  • categoryobject

    Name of the knowledge base category.

  • statestring

    Defines the published status of the article. Example: PUBLISH, DRAFT

  • attachmentsarray

  • expiryDatestring

    Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)

  • linkedArticlesarray

    Defines the list of linked articles of the article.

Loading Examples...

Responses

  • idstring

  • subjectstringrequired

    Defines the subject of the knowledge base article.

  • contentstringrequired

    Defines the content of the article.

  • createdTimestring

  • updatedTimestring

  • createdByobject

  • updatedByobject

  • sharedboolean

  • categoryobject

    Name of the knowledge base category.

  • statestring

    Defines the published status of the article. Example: PUBLISH, DRAFT

  • attachmentsarray

  • expiryDatestring

    Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)

  • linkedArticlesarray

    Defines the list of linked articles of the article.

Loading Examples...