The modify API is used to modify the question and answer section of a knowledge base article.
UI Reference: The API is called when the ''Edit'' button is clicked on the Knowledge Base page.
URI: webapp-api-findanswer?api=modify
Access Rights Required:
Name |
Type |
Description |
---|---|---|
articleID |
String |
The ID of the article. |
details |
Object |
This returns all details of the object of interaction. |
details[].subject |
String |
This represents the subject of the email. |
details[].questionHtml |
String |
This returns a question which has been mentioned in mail. |
details[].answerHtml |
String |
This returns a answer which has been mentioned in mail. |
details[].topicID |
String |
This has the value of topic id in which interaction belongs to. |
details[].isPublic |
Boolean |
Shows if an article is public. |
details[].properties |
Array |
property details. see property values. |
details[].propertiesEdit |
Array |
|
details[].attachments |
Array |
This has all the attachments which are added in interaction. |
pageAction |
String |
This parameter represents the action name which was performed. |
{ |
Name |
Type |
Description |
---|---|---|
error |
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. |
details |
Object |
Object that contains all the details needed to create the agent email. |
details[].id |
String |
This returns the id of the interaction. |
details[].subject |
String |
The subject line of the agent email created for forwarding. |
details[].name |
String |
Shows the name of an article. |
details[].questionHtml |
String |
This returns a question which has been maintained in mail. |
details[].answerHtml |
String |
This returns an answer which has been maintained in mail. |
details[].topicID |
String |
The topic ID of the interaction. |
details[].isPublic |
String |
Shows if an article is public. |
details[].creatorName |
String |
Shows name of the creator of the article. |
details[].rating |
String |
|
details[].viewCount |
String |
This has a total view count of interaction. |
details[].attachments |
Array |
An array of attachments included within the agent email. |
details[].properties |
Array |
Properties associated with the topic are submitted in special format.see properties that may be edited. |
details[].propertiesEdit |
Array |
|
details[].isSubscribed |
String |
Shows subscribers to an article. |
{ "errors": [ |