/
"COMMENTS" OBJECT CODE

"COMMENTS" OBJECT CODE

May 03, 2022

Introduced in API version 2.7.24

Object code format

parent_object.COMMENTS{selector}.property
Possible parent objectsExample

EVENT

EVENT{INACTIVITY_WARNING}.COMMENTS.TEXT

Returns information about the comments of an EVENT


Selector

The selector can be used to define which comment should be use to evaluate the OBJECT CODE. Possible values are:

  • null: An array with the requested properties of all comments of the EVENT will be returned
  • "FIRST": The requested property of the first comment will be returned. Example: EVENT{XXX}.COMMENTS{FIRST}.TEXT returns the text of the first comment of the EVENT
  • "LAST": The requested property of the last comment will be returned. Example: EVENT{XXX}.COMMENTS{LAST}.TEXT returns the text of the last comment of the EVENT
  • Numeric value: The requested property of the corresponding comment will be returned. Example: EVENT{XXX}.COMMENTS{2}.TEXT returns the text of the second comment of the EVENT

Context information

The context information is inherited from the parent OBJECT (an EVENT)

Properties

PROPERTYDESCRIPTION
COMMENTS.TEXTThis is the default property and can be omitted. Returns the text of the comment
COMMENTS.DATEDate of the comment (in the active session timezone)