Purpose
The articles API is used to ____________.
UI Reference: The API is called when the ___ button is clicked on the ___ page.
URI: webapp-api-findanswer?api=articles
Access Rights Required:
Request
Request Parameters
Name |
Type |
Description |
|---|---|---|
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
Request Payload Example
{ "_pageAction": "ListArticles" } |
Response
Response Parameters
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 the topic name in which interaction belongs to. |
interactions[].rating |
String |
|
interactions[].viewCount |
String |
This has a total view count of interaction. |
interactions[].properties |
Array |
See property value |
interactions[].public |
String |
Response Example
{ "errors": [], "errorDetails": [], "interactions": [ { "id": "1332", "subject": "Zoom", "date": "2009-01-21T05:23:29.8570000Z", "topicID": "37", "topicName": "Cameras", "rating": "5.0", "viewCount": "415", "properties": [], "public": "public" } ] } |
