Api Home > ArticleList > Get

GET api/V3/ArticleList/Get?searchText={searchText}&selectedCategories[0]={selectedCategories[0]}&selectedCategories[1]={selectedCategories[1]}&selectedTypes[0]={selectedTypes[0]}&selectedTypes[1]={selectedTypes[1]}&skipCount={skipCount}&takeCount={takeCount} Gets a list of knowledge articles filtered by text, categories, and types.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
searchText

Text being searched on. Required

string

Required

selectedCategories

List of article category ids. Optional

Collection of globally unique identifier

Required

selectedTypes

List of article type ids. Optional

Collection of globally unique identifier

Required

skipCount

Default to 0, calculated automatically based of results already returned

integer

Default value is 0

takeCount

For pagination / infinite-scroll. Integer number of results to return per page

integer

Default value is 0

Body Parameters

None.

Response Information

Returns a list of KnownledgeArticle objects filtered on search text, catagories, and types.

Resource Description

Collection of KnowledgeArticle
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

ArticleId

string

None.

Title

string

None.

Popularity

integer

None.

Description

string

None.

ExternalUrl

string

None.

EndUserContent

string

None.

AnalystContent

string

None.

HasEndUserContent

boolean

None.

HasAnalystContent

boolean

None.

HTMLKnowledgeId

string

None.

Type

DisplayEnumeration

None.

Category

DisplayEnumeration

None.

Status

DisplayEnumeration

None.

StatusString

string

None.

ViewCount

integer

None.

CommentCount

integer

None.

AverageRating

decimal number

None.

LastModifiedDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "807e6c7a-bab7-485c-b0dd-163c9495bfbd",
    "ArticleId": "sample string 2",
    "Title": "sample string 3",
    "Popularity": 4,
    "Description": "sample string 5",
    "ExternalUrl": "sample string 6",
    "EndUserContent": "sample string 7",
    "AnalystContent": "sample string 8",
    "HasEndUserContent": true,
    "HasAnalystContent": true,
    "HTMLKnowledgeId": "sample string 11",
    "Type": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "StatusString": "sample string 12",
    "ViewCount": 13,
    "CommentCount": 14,
    "AverageRating": 15.0,
    "LastModifiedDate": "2019-12-08T10:39:00.407Z"
  },
  {
    "Id": "807e6c7a-bab7-485c-b0dd-163c9495bfbd",
    "ArticleId": "sample string 2",
    "Title": "sample string 3",
    "Popularity": 4,
    "Description": "sample string 5",
    "ExternalUrl": "sample string 6",
    "EndUserContent": "sample string 7",
    "AnalystContent": "sample string 8",
    "HasEndUserContent": true,
    "HasAnalystContent": true,
    "HTMLKnowledgeId": "sample string 11",
    "Type": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "31b2febc-8681-4c52-97d0-04e817fad190",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "StatusString": "sample string 12",
    "ViewCount": 13,
    "CommentCount": 14,
    "AverageRating": 15.0,
    "LastModifiedDate": "2019-12-08T10:39:00.407Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfKnowledgeArticle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <KnowledgeArticle>
    <AnalystContent>sample string 8</AnalystContent>
    <ArticleId>sample string 2</ArticleId>
    <AverageRating>15</AverageRating>
    <Category xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Category>
    <CommentCount>14</CommentCount>
    <Description>sample string 5</Description>
    <EndUserContent>sample string 7</EndUserContent>
    <ExternalUrl>sample string 6</ExternalUrl>
    <HTMLKnowledgeId>sample string 11</HTMLKnowledgeId>
    <HasAnalystContent>true</HasAnalystContent>
    <HasEndUserContent>true</HasEndUserContent>
    <Id>807e6c7a-bab7-485c-b0dd-163c9495bfbd</Id>
    <LastModifiedDate>2019-12-08T10:39:00.4074607+00:00</LastModifiedDate>
    <Popularity>4</Popularity>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Status>
    <StatusString>sample string 12</StatusString>
    <Title>sample string 3</Title>
    <Type xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Type>
    <ViewCount>13</ViewCount>
  </KnowledgeArticle>
  <KnowledgeArticle>
    <AnalystContent>sample string 8</AnalystContent>
    <ArticleId>sample string 2</ArticleId>
    <AverageRating>15</AverageRating>
    <Category xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Category>
    <CommentCount>14</CommentCount>
    <Description>sample string 5</Description>
    <EndUserContent>sample string 7</EndUserContent>
    <ExternalUrl>sample string 6</ExternalUrl>
    <HTMLKnowledgeId>sample string 11</HTMLKnowledgeId>
    <HasAnalystContent>true</HasAnalystContent>
    <HasEndUserContent>true</HasEndUserContent>
    <Id>807e6c7a-bab7-485c-b0dd-163c9495bfbd</Id>
    <LastModifiedDate>2019-12-08T10:39:00.4074607+00:00</LastModifiedDate>
    <Popularity>4</Popularity>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Status>
    <StatusString>sample string 12</StatusString>
    <Title>sample string 3</Title>
    <Type xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>31b2febc-8681-4c52-97d0-04e817fad190</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Type>
    <ViewCount>13</ViewCount>
  </KnowledgeArticle>
</ArrayOfKnowledgeArticle>