Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > History

Set an interaction property (api=propertyset)

Scroll Prev Top Next More

Purpose

 

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.

 

 

Request

 

 

Request Parameters

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.

 

 

 

Request Payload Example

{
  "interactionID": "44119",
  "values": [],
  "caseValues": [
    {
      "propertyID": "11",
      "propertyName": "Account Number",
      "values": [
        {
          "value": "123"
        }
      ]
    }
  ],
  "_pageAction": "PropertySet",
  "_pageName": "messagequeue#/my-message-inbox"
}

 

 

 

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.

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

{
  "errors": [],
  "errorDetails": [],
  "id": "44119",
  "interactionProperties": [],
  "caseProperties": [
    {
      "name": "e-shop",
      "properties": [
        {
          "propertyID": "11",
          "name": "Account Number",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [
            {
              "description": null,
              "value": "123",
              "valueDateUtc": null,
              "valueDatetimeUtc": null,
              "valueInt": null,
              "valueNumber": null
            }
          ],
          "valueChoices": [],
          "descriptionChoices": []
        }
      ],
      "logins": null,
      "canModifyLogins": false
    }
  ]
}

 

 

 

 

© 2008 - 2022 One-to-One Service.com, Inc. All rights reserved.