POST api/KnowledgeBase/SearchForArticles

Gets a list of Articles where the searched text is found.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Text	Search text	string	None.
CategoryId	(Optional) The category where to search in.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Text": "Search string",
  "CategoryId": null
}

application/xml, text/xml

Sample:

<SearchForArticlesPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <CategoryId i:nil="true" />
  <Text>Search string</Text>
</SearchForArticlesPost>

Response Information

Resource Description

The method returns max 100 articles.

SearchForArticlesResult

Name	Description	Type	Additional information
Articles	Articles	Collection of SearchForArticleResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Articles": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Categories": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Total": 3
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Total": 3
        }
      ],
      "PlainText": "sample string 3",
      "LastUpdateDate": "2024-12-22T11:19:20.2162305+01:00"
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Categories": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Total": 3
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Total": 3
        }
      ],
      "PlainText": "sample string 3",
      "LastUpdateDate": "2024-12-22T11:19:20.2162305+01:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchForArticlesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Articles>
    <SearchForArticleResult>
      <Categories>
        <GetKnowledgeBaseCategoryResult>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Total>3</Total>
        </GetKnowledgeBaseCategoryResult>
        <GetKnowledgeBaseCategoryResult>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Total>3</Total>
        </GetKnowledgeBaseCategoryResult>
      </Categories>
      <Id>1</Id>
      <LastUpdateDate>2024-12-22T11:19:20.2162305+01:00</LastUpdateDate>
      <PlainText>sample string 3</PlainText>
      <Title>sample string 2</Title>
    </SearchForArticleResult>
    <SearchForArticleResult>
      <Categories>
        <GetKnowledgeBaseCategoryResult>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Total>3</Total>
        </GetKnowledgeBaseCategoryResult>
        <GetKnowledgeBaseCategoryResult>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Total>3</Total>
        </GetKnowledgeBaseCategoryResult>
      </Categories>
      <Id>1</Id>
      <LastUpdateDate>2024-12-22T11:19:20.2162305+01:00</LastUpdateDate>
      <PlainText>sample string 3</PlainText>
      <Title>sample string 2</Title>
    </SearchForArticleResult>
  </Articles>
</SearchForArticlesResult>