Contact Us
APIs

Device Smart Search

Searchable/Non-searchable fields:

FieldExtensionSearchable without Field NameKeywordIndexed (Searchable)Case InsensitiveComment
accountId✕✕✓✓✕
id✕✓✓✓✕Device Id shall be used as document Id to uniquely identify a document in ES.
Searchable without the property name.
mdn✕✓✓✓✓Searchable without the property name
externalId✕✓✓✓✓
ipAddress✕✓✓✓✕
shipDate✕✕✓✓✕yyyy-MM-dd'T'HH:mm:ss.SSSZ
activationDate✕✕✓✓✕yyyy-MM-dd'T'HH:mm:ss.SSSZ
deviceConfigurationId✕✕✓✓✕
name✕✕✓✓✓Searchable without the property name
pegBehaviorId✕✕✓✓✕
provisionStatus✕✕✓✓✕
status✕✕✓✓✕
serialNumber✕✓✓✓✓Searchable without the property name
typeId✕✕✓✓✕This is DeviceType Id field
typeName✕✕✓✓✕This is DeviceType Name field
category✕✕✓✓✕
createdOn✕✕✓✓✕yyyy-MM-dd'T'HH:mm:ss.SSSZ
lastModifiedOn✕✕✓✓✕yyyy-MM-dd'T'HH:mm:ss.SSSZ
architecture✕✕✓✓✕Searchable without the property name
min✕✓✓✓✓Searchable without the property name
airId✕✓✓✓✓Searchable without the property name
imsi✕✓✓✓✓Searchable without the property name
phoneNumber✕✓✓✓✕Searchable without the property name
esn✕✓✓✓✓Searchable without the property name
meid✕✓✓✓✓Searchable without the property name
imei✕✓✓✓✓Searchable without the property name
iccid✕✓✓✓✓Searchable without the property name
poNumber✓✕✓✓✕
shippingOrder✓✕✓✓✕
groupIds✕✕✓✓✕List of groupIds to which Device is associated with
appId✓✓✓✓✕
firmwareVersion✓✕✓✓✕
dmDevice✕✕✓✓✕
vbusEnabledStatus✓✕✓✓✕Valid values: true, false or null
configVersion✓✕✓✓✕
idReportTimestamp✓✕✓✓✕
sku✓✕✓✓✕
fileVersions.platform✓✓✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
fileVersions.version✓✓✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
fileVersions.fileName✓✓✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
fileVersions.fileStatus✓✓✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
networkCarrier✓✕✓✓✕
networkMode✓✕✓✓✕
networkCurrentMode✓✕✓✓✕
signalStrength✓✕✓✕
accountParentHierarchy✕✕✕✕✕This attribute shall be used internally by Device search service to restrict the search results to current user's acct hierarchy & for hierLevel queries.
macAddress✕✓✓✓✓Searchable without the property name
lastReportedTime✕✓✓✕✕yyyy-MM-dd'T'HH:mm:ss.SSSZ
esnAssociatedLMU✓✓✓✓✓
androidOSVersion✓✓✓✓✕
kernelVersion✓✕✓✓✕
account.id✕✕✓✓✕
account.title✕✕✓✓✕
account.status✕✕✓✓✕
pegBehavior.id✕✕✓✓✕
pegBehavior.title✕✕✓✓✕
pegBehavior.status✕✕✓✓✕
type.id✕✕✓✓✕
type.title✕✕✓✓✕
ioProfile.id✕✕✓✓✕
ioProfile.title✕✕✓✓✕
ioProfile.status✕✕✓✓✕
schedules.id✕✕✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
schedules.title✕✕✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
schedules.status✕✕✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
serviceProfile.id✕✕✓✓✕
serviceProfile.title✕✕✓✕✕
serviceProfile.status✕✕✓✓✕
asset.id✕✕✓✓✕
asset.title✕✕✓✓✕
asset.status✕✕✓✓✕
replacedDevice.id✕✕✓✓✕
replacedDevice.title✕✕✓✓✕
replacedDevice.status✕✕✓✓✕
deviceConfiguration.id✕✕✓✓✕
deviceConfiguration.title✕✕✓✓✕
groups.id✕✕✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
groups.title✕✓✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
groups.status✕✕✓✓✕Nested type field. Searchable only using full-fledged Elasticsearch query
platforms.platformId✓✕✓✓✕Nested type field. Searchable only Nested field. using full-fledged Elasticsearch query
platforms.platformType✓✕✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
userDefinedMobileId✓✓✓✓
associatedDevices.mobileId✓✓✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
associatedDevices.mobileIdType✓✕✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
associatedDevices.deviceCategory✓✕✓✓✓Nested type field. Searchable only using full-fledged Elasticsearch query
batteryPercentageLeft✓✓✕✓✕
userESN✓✓✓✓
vbusMode✓✕✓✓✕
© 2023 CalAmp