Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Properties definition has following attributes.

nameStringName of property
displayNameStringDisplay name of property
dataTypeStringData type for property
subDataTypeStringSub-Data type for property
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active
defaultValueStringDefault value for property
scopeStringScope of the property
listDataList<String>Possible string values for the property, if property is type enum
isDefaultValueExpressionBooleanWhether value is expression or literal by default
isMultiSelectBooleanWhether multiple values are allowed

Response Codes

200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error