DeviceSearch

Introduction
The object used to specify the arguments when searching for a Device.
Properties

comment

Search for Devices with comments matching this value. Wildcard can be used by prepending/appending "%" to string. Example "%comments%".

deviceIds

Search for Devices with these unique Id(s). Supported for Device and also for DeviceStatusInfo, LogRecord, TachographDataFile, FaultData, ChargeEvent, AddInDeviceLink, and DeviceLink. Limited to 5000 IDs per query.
Note: when used with LogRecord, the batch path always excludes private logs regardless of caller permissions. Use single-device search if private log access is required.

deviceType

Search for Devices of this DeviceType.

excludeActiveCommunicationStatusReason

The boolean to filter out devices that currently have an active DeviceCommunicationStatus.
When true it will not return any devices that have a DeviceCommunicationStatus.isActive = true; when false it only return devices with an DeviceCommunicationStatus != true. This property is mostly used with DeviceSearch.isCommunicating to filter devices that are offline with an unknown reason

fromDate

Search for Devices that were active at this date or after. Set to UTC now to search for only currently active (non-archived) devices.

groups

Search for Devices that are a member of these GroupSearch(s). Each GroupSearch is an object within the array. Available GroupSearch options are:
  • Id

id

Search for an entry based on the specific Id.

keywords

Search for entities that contain specific keywords in all wildcard string-searchable fields.

licensePlate

Search for Devices with a license plate matching this value. Wildcard can be used by prepending/appending "%" to string. Example "%LicensePlate%".

macAddress

Search for Devices with this MacAddress.

name

Search for Devices with this Name. Name is the primary description of the Device. Wildcard can be used by prepending/appending "%" to string. Example "%name%".

serialNumber

Search for a Device by its unique serial number. Wildcard can be used by prepending/appending "%" to string. Example "%SerialNumber%".

toDate

Search for Devices that were active at this date or before.

vehicleIdentificationNumber

Search for a Device by Vehicle Identification Number (VIN). This is the unique number assigned to the vehicle during manufacturing. This differs from DeviceSearch.engineVehicleIdentificationNumber in that it is the last VIN reported from the Device that was determined to be valid. Wildcard can be used by prepending/appending "%" to string. Example "%VehicleIdentificationNumber%".

Loading API Runner...