The propertyset API is used to used to set property values in interaction.
UI Reference: The API is called when the Save button is used inside an interaction properties panel.
URI: webapp-api-History?api=propertyset
Access Rights Required: All agents. However, a special access right is required to set properties on interactions that are already resolved.
Name |
Type |
Description |
---|---|---|
interactionID |
String |
This parameter represents the id of interaction to get history details. |
values |
Array |
This parameter represents the value of Property. |
caseValues |
Array |
Property details with value. |
caseValues[].propertyID |
String |
This parameter represents the id of Property. |
casevalues[].propertyName |
String |
This parameter represents the name of Property. |
casevalues[].values |
Array |
This parameter represents the value of Property. |
casevalues[].values[].value |
String |
This parameter represents the single value of Property. |
pageAction |
String |
This parameter represents the action name which was performed. |
pageName |
String |
This parameter represents the page name. |
{ |
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. |
errorsDetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
id |
String |
This returns the id of interaction. |
interactionProperties |
Array |
This returns all properties and their values if property value set in interaction. |
caseProperties |
Array |
This returns all case properties and their values if property value set in interaction. |
caseProperties[].name |
String |
This represents the name of the property. |
caseProperties[].properties |
Array |
Array of Property details.see property data structure. |
caseProperties[].logins |
Number |
This property has a list of objects with login details including name and type of property value. |
caseProperties[].canModifyLogins |
Boolean |
This property represents rights of modification in logins. |
Response Example
{ |