Api Home > Article > GetForGrid

POST api/V3/Article/GetForGrid Gets a list of knowledge articles for a grid datasource

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Returns a list of html KnowledgeArticle objects

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": "e2890ab5-fc47-4118-918a-1b7072306c7f",
    "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": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "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:05:02.882Z"
  },
  {
    "Id": "e2890ab5-fc47-4118-918a-1b7072306c7f",
    "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": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "2709514e-5b25-4f60-b1be-4e888484fe79",
      "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:05:02.882Z"
  }
]

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>2709514e-5b25-4f60-b1be-4e888484fe79</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>e2890ab5-fc47-4118-918a-1b7072306c7f</Id>
    <LastModifiedDate>2019-12-08T10:05:02.8823814+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>2709514e-5b25-4f60-b1be-4e888484fe79</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>2709514e-5b25-4f60-b1be-4e888484fe79</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>2709514e-5b25-4f60-b1be-4e888484fe79</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>e2890ab5-fc47-4118-918a-1b7072306c7f</Id>
    <LastModifiedDate>2019-12-08T10:05:02.8823814+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>2709514e-5b25-4f60-b1be-4e888484fe79</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>2709514e-5b25-4f60-b1be-4e888484fe79</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Type>
    <ViewCount>13</ViewCount>
  </KnowledgeArticle>
</ArrayOfKnowledgeArticle>