GET api/teams/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
Name | Description | Type | Additional 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
KnowledgeArticleGroupedViewModelName | Description | Type | Additional information |
---|---|---|---|
Articles | Collection of KnowledgeArticleGrouped |
None. |
|
CurrentMiniCrumb | Collection of DisplayEnumeration |
None. |
Response Formats
application/json, text/json
Sample:
{ "Articles": [ { "Article": { "Id": "6b2d8812-9ef9-4057-96b6-9540f16ba12e", "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": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Status": { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "StatusString": "sample string 12", "ViewCount": 13, "CommentCount": 14, "AverageRating": 15.0, "LastModifiedDate": "2024-04-25T14:26:18.807Z" }, "ContextCrumbs": [ { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ] }, { "Article": { "Id": "6b2d8812-9ef9-4057-96b6-9540f16ba12e", "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": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Status": { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "StatusString": "sample string 12", "ViewCount": 13, "CommentCount": 14, "AverageRating": 15.0, "LastModifiedDate": "2024-04-25T14:26:18.807Z" }, "ContextCrumbs": [ { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ] } ], "CurrentMiniCrumb": [ { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "ab40c111-eb9e-4f14-b930-f1293af486db", "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>ab40c111-eb9e-4f14-b930-f1293af486db</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>6b2d8812-9ef9-4057-96b6-9540f16ba12e</Id> <LastModifiedDate>2024-04-25T14:26:18.8072845+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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>6b2d8812-9ef9-4057-96b6-9540f16ba12e</Id> <LastModifiedDate>2024-04-25T14:26:18.8072845+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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</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>ab40c111-eb9e-4f14-b930-f1293af486db</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> </CurrentMiniCrumb> </KnowledgeArticleGroupedViewModel>