Contains information about an attribute field in layer and table search configurations.

Referenced by: search layer, search table

Properties

PropertyDetails
exactMatchDeprecated. Use searchMode instead. A Boolean defining whether or not the field is an exact match.
nameA string defining the field name.
searchModeA string defining the search mode for the field. This replaces exactMatch: simple is equivalent to exactMatch=true, and startsWith is equivalent to exactMatch=false. fullTextSimple and fullTextStartsWith are the full text equivalents of simple and startsWith. If a full text search mode is specified but the field does not have a full text index, clients should fall back to the corresponding non-full text search mode.
Valid values:
  • fullTextSimple
  • fullTextStartsWith
  • simple
  • startsWith
typeA string defining the field type.
Valid values: esriFieldTypeBigInteger, esriFieldTypeBlob, esriFieldTypeDate, esriFieldTypeDateOnly, esriFieldTypeDouble, esriFieldTypeGeometry, esriFieldTypeGlobalID, esriFieldTypeGUID, esriFieldTypeInteger, esriFieldTypeLong, esriFieldTypeOID, esriFieldTypeRaster, esriFieldTypeSingle, esriFieldTypeSmallInteger, esriFieldTypeString, esriFieldTypeTimeOnly, esriFieldTypeTimestampOffset, esriFieldTypeXML

search layer field Example

{
"name": "relationships/2/Postcode",
"type": "esriFieldTypeString",
"exactMatch": true
}