Api Home > ArticleList > Get

GET api/V3/ArticleList/Get?categoryId={categoryId}&skipCount={skipCount}&takeCount={takeCount} Gets a list of articles grouped by the category passed as param. Also includes sub category articles.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryId

id of article category

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 list of articles with additional category data

Resource Description

KnowledgeArticleGroupedViewModel
NameDescriptionTypeAdditional information
Articles

Collection of KnowledgeArticleGrouped

None.

CurrentMiniCrumb

Collection of DisplayEnumeration

None.

Response Formats

application/json, text/json

Sample:
{
  "Articles": [
    {
      "Article": {
        "Id": "a3ef13e1-407c-426c-af53-09512d1c6e9e",
        "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": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "Category": {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "Status": {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "StatusString": "sample string 12",
        "ViewCount": 13,
        "CommentCount": 14,
        "AverageRating": 15.0,
        "LastModifiedDate": "2019-12-08T01:47:37.516Z"
      },
      "ContextCrumbs": [
        {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        }
      ]
    },
    {
      "Article": {
        "Id": "a3ef13e1-407c-426c-af53-09512d1c6e9e",
        "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": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "Category": {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "Status": {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        "StatusString": "sample string 12",
        "ViewCount": 13,
        "CommentCount": 14,
        "AverageRating": 15.0,
        "LastModifiedDate": "2019-12-08T01:47:37.516Z"
      },
      "ContextCrumbs": [
        {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        },
        {
          "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
          "Name": "sample string 1",
          "HierarchyLevel": 1,
          "HierarchyPath": "sample string 2"
        }
      ]
    }
  ],
  "CurrentMiniCrumb": [
    {
      "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    {
      "Id": "4954b6ef-a382-4b04-93ec-3c7ab160b4d3",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<KnowledgeArticleGroupedViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <Articles>
    <KnowledgeArticleGrouped>
      <Article>
        <AnalystContent>sample string 8</AnalystContent>
        <ArticleId>sample string 2</ArticleId>
        <AverageRating>15</AverageRating>
        <Category xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1: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>a3ef13e1-407c-426c-af53-09512d1c6e9e</Id>
        <LastModifiedDate>2019-12-08T01:47:37.5160554+00:00</LastModifiedDate>
        <Popularity>4</Popularity>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1:Name>
        </Status>
        <StatusString>sample string 12</StatusString>
        <Title>sample string 3</Title>
        <Type xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1:Name>
        </Type>
        <ViewCount>13</ViewCount>
      </Article>
      <ContextCrumbs xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
        <d4p1:DisplayEnumeration>
          <d4p1:HierarchyLevel>1</d4p1:HierarchyLevel>
          <d4p1:HierarchyPath>sample string 2</d4p1:HierarchyPath>
          <d4p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d4p1:Id>
          <d4p1:Name>sample string 1</d4p1:Name>
        </d4p1:DisplayEnumeration>
        <d4p1:DisplayEnumeration>
          <d4p1:HierarchyLevel>1</d4p1:HierarchyLevel>
          <d4p1:HierarchyPath>sample string 2</d4p1:HierarchyPath>
          <d4p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d4p1:Id>
          <d4p1:Name>sample string 1</d4p1:Name>
        </d4p1:DisplayEnumeration>
      </ContextCrumbs>
    </KnowledgeArticleGrouped>
    <KnowledgeArticleGrouped>
      <Article>
        <AnalystContent>sample string 8</AnalystContent>
        <ArticleId>sample string 2</ArticleId>
        <AverageRating>15</AverageRating>
        <Category xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1: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>a3ef13e1-407c-426c-af53-09512d1c6e9e</Id>
        <LastModifiedDate>2019-12-08T01:47:37.5160554+00:00</LastModifiedDate>
        <Popularity>4</Popularity>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1:Name>
        </Status>
        <StatusString>sample string 12</StatusString>
        <Title>sample string 3</Title>
        <Type xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
          <d5p1:HierarchyLevel>1</d5p1:HierarchyLevel>
          <d5p1:HierarchyPath>sample string 2</d5p1:HierarchyPath>
          <d5p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d5p1:Id>
          <d5p1:Name>sample string 1</d5p1:Name>
        </Type>
        <ViewCount>13</ViewCount>
      </Article>
      <ContextCrumbs xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
        <d4p1:DisplayEnumeration>
          <d4p1:HierarchyLevel>1</d4p1:HierarchyLevel>
          <d4p1:HierarchyPath>sample string 2</d4p1:HierarchyPath>
          <d4p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d4p1:Id>
          <d4p1:Name>sample string 1</d4p1:Name>
        </d4p1:DisplayEnumeration>
        <d4p1:DisplayEnumeration>
          <d4p1:HierarchyLevel>1</d4p1:HierarchyLevel>
          <d4p1:HierarchyPath>sample string 2</d4p1:HierarchyPath>
          <d4p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d4p1:Id>
          <d4p1:Name>sample string 1</d4p1:Name>
        </d4p1:DisplayEnumeration>
      </ContextCrumbs>
    </KnowledgeArticleGrouped>
  </Articles>
  <CurrentMiniCrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
    <d2p1:DisplayEnumeration>
      <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel>
      <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath>
      <d2p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:DisplayEnumeration>
    <d2p1:DisplayEnumeration>
      <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel>
      <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath>
      <d2p1:Id>4954b6ef-a382-4b04-93ec-3c7ab160b4d3</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:DisplayEnumeration>
  </CurrentMiniCrumb>
</KnowledgeArticleGroupedViewModel>