getFieldDefs

Retrieves a list of field definitions supported by the system for use with SmartDirectories.

Request

GET /rest/refdata/field-defs

Parameters

None.

Response

200 OK

[
  {
    "fieldDefId": 33,
    "fieldDefTableName": "CONTACT",
    "fieldDefColumnName": "CONTACT_PHOTO",
    "fieldDefHibernateName": "contactPhoto",
    "fieldDefJsonName": "contactPhoto",
    "fieldDefFieldName": "photo",
    "fieldDefDesc": "Photo",
    "fieldDefMaxLength": 255,
    "fieldDefType": "text",
    "isAddressField": "N"
  }
]

Field	Type	Description
fieldDefId	integer	Primary key
fieldDefTableName	string	Database table name
fieldDefColumnName	string	Database column name
fieldDefHibernateName	string	Hibernate entity property name
fieldDefJsonName	string	JSON serialisation key
fieldDefFieldName	string	Logical field name
fieldDefDesc	string	Human-readable description
fieldDefMaxLength	integer	Maximum field length
fieldDefType	string	Data type (e.g. text)
isAddressField	string	Y or N — whether this field is part of an address

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching field definitions