Article Extended Attributes in REST

Extended Attributes can be set and retrieved in REST as in any other of Verint Community's API spaces.

General Notes on Extended Attributes

Extended Attributes should not be used to store sensitive or personally identifiable information. These fields are stored and returned in plain text in Get and List calls for any Content Type that supports them. There should be no expectation of security or encryption for any information stored in Extended Attributes.

Extended Attributes are extensible, meaning they are perfectly upgrade safe in terms of storage/retrieval syntax. There are no plans to deprecate or obsolete them. However, it is strongly recommended that any robust custom functionality implementation (e.g., anything that requires filtering or searching) should consider using a custom data store and access methods instead of relying on Extended Attributes.

Using Extended Attributes in REST

When building your REST request, you can include as many Extended Attributes as you desire in the form with the following syntax:


Note the following related bahaviors:

  • Providing a <FieldName> that does not exist will create a new Extended Attribute with the given <FieldValue>.
  • Setting <FieldValue> to an empty string ("") for an existing <FieldName> will delete the matching Extended Attribute.
  • Providing a different <FieldValue> for an existing <FieldName> will overwrite the existing Extended Attribute.