The articles API is used to display all KB articles in the database.
UI Reference: The API is called when the ''search selected topics'' button is clicked on the Knowledge Base page.
URI: webapp-api-findanswer?api=articles
Access Rights Required:
Name |
Type |
Description |
---|---|---|
topicID |
String |
This returns the id of the topic. |
pageNum |
Integer |
This parameter represents current page no. |
perPage |
Integer |
This parameter represents how many records we want in one page. |
recursive |
Boolean |
|
searchString |
String |
|
pageAction |
String |
This parameter represents the action name which was performed. |
{ |
Name |
Type |
Description |
---|---|---|
errors |
Array |
An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error. |
errorDetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
interactions |
Array |
This returns a list of objects with all interaction details. |
interactions[].id |
String |
This returns the id of interaction. |
interactions[].subject |
String |
This returns the subject of interaction. |
interactions[].date |
String |
This returns the date of interaction. |
interactions[].topicID |
String |
This has the value of topic id in which interaction belongs to. |
interactions[].topicName |
String |
This has the value of topic name in which interaction belongs to. |
interactions[].rating |
String |
|
interactions[].viewCount |
String |
This has the total view count of interaction. |
interactions[].properties |
Array |
Property details, see property values |
interactions[].public |
Array |
Shows if an article is public or not. |
{ |