GET api/KnowledgeBase/GetArticle/{id}

Gets article by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

article id

integer

Required

Body Parameters

None.

Response Information

Resource Description

GetKnowledgeBaseArticleDetailResult
NameDescriptionTypeAdditional information
Title

The title

string

None.

Text

Text as html

string

None.

PlainText

Text as plain text

string

None.

AuthorFullName

Author full name

string

None.

LastUpdate

When the article was last updated

date

None.

Attachments

Attachments

Collection of KnowledgeBaseArticleAttachment

None.

Articles

Associated articles

Collection of GetKnowledgeBaseArticleResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Title": "Cache",
  "Text": "<strong>You must remove cache</strong>",
  "PlainText": "You must remove cache",
  "AuthorFullName": "John Doe",
  "LastUpdate": null,
  "Attachments": null,
  "Articles": [
    {
      "Id": 1,
      "Name": "Help with api",
      "DateLastUpdateUTC": "2024-05-16T01:00:21.1877134Z"
    }
  ]
}

application/xml, text/xml

Sample:
<GetKnowledgeBaseArticleDetailResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Articles>
    <GetKnowledgeBaseArticleResult>
      <DateLastUpdateUTC>2024-05-16T01:00:21.1877134Z</DateLastUpdateUTC>
      <Id>1</Id>
      <Name>Help with api</Name>
    </GetKnowledgeBaseArticleResult>
  </Articles>
  <Attachments i:nil="true" />
  <AuthorFullName>John Doe</AuthorFullName>
  <LastUpdate i:nil="true" />
  <PlainText>You must remove cache</PlainText>
  <Text>&lt;strong&gt;You must remove cache&lt;/strong&gt;</Text>
  <Title>Cache</Title>
</GetKnowledgeBaseArticleDetailResult>