POST api/V3/KnowledgeBase/SearchArticles?searchfilter={searchfilter}&userId={userId} (Deprecated) Returns a list of RTF articles using search filters provided.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchfilter |
The text to search on |
string |
Required |
userId |
The user Id |
globally unique identifier |
Required |
Body Parameters
None.Response Information
Resource Description
Collection of KnowledgeArticleName | Description | Type | Additional 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": "c39fba93-cb75-4c09-99b3-ae2089065428", "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": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": { "Id": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Status": { "Id": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "StatusString": "sample string 12", "ViewCount": 13, "CommentCount": 14, "AverageRating": 15.0, "LastModifiedDate": "2024-03-28T13:30:26.372Z" }, { "Id": "c39fba93-cb75-4c09-99b3-ae2089065428", "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": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": { "Id": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Status": { "Id": "c12ce555-2c2c-4328-aedb-1bafc788613f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "StatusString": "sample string 12", "ViewCount": 13, "CommentCount": 14, "AverageRating": 15.0, "LastModifiedDate": "2024-03-28T13:30:26.372Z" } ]
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>c12ce555-2c2c-4328-aedb-1bafc788613f</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>c39fba93-cb75-4c09-99b3-ae2089065428</Id> <LastModifiedDate>2024-03-28T13:30:26.3724734+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>c12ce555-2c2c-4328-aedb-1bafc788613f</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>c12ce555-2c2c-4328-aedb-1bafc788613f</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>c12ce555-2c2c-4328-aedb-1bafc788613f</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>c39fba93-cb75-4c09-99b3-ae2089065428</Id> <LastModifiedDate>2024-03-28T13:30:26.3724734+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>c12ce555-2c2c-4328-aedb-1bafc788613f</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>c12ce555-2c2c-4328-aedb-1bafc788613f</d3p1:Id> <d3p1:Name>sample string 1</d3p1:Name> </Type> <ViewCount>13</ViewCount> </KnowledgeArticle> </ArrayOfKnowledgeArticle>