Purpose
The properties API is used to ____________.
UI Reference: The API is called when the ___ button is clicked on the ___ page.
URI: webapp-api-findanswer?api=properties
Access Rights Required:
Request
Request Parameters
Name |
Type |
Description |
|---|---|---|
topicID |
String |
This parameter represents the topic ID of the interaction. |
__TZO__ |
String |
Shows Time Zone Offset. |
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
Request Payload Example
{ "topicID": "", "__TZO__": "-08:00", "_pageAction": "FindAnswerTopicProperties" } |
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. |
properties |
Array |
properties associated with the topic are submitted in a special format.see property values. |
caseProperties |
Array |
This array all an array of case properties and their values if property values are set in the interaction. |
Response Example
{ "errors": [], "errorDetails": [], "properties": [], "caseProperties": [] } |
