Find By Identifier
|
|||||
|
|
||||
Finds devices by hardware identifiers, such as IMEI
Input
This building block consumes 9 input parameters
| Name | Format | Description |
|---|---|---|
partnerId Required |
INTEGER |
Required. The ID of the reseller partner |
limit |
INTEGER |
Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive |
deviceIdentifier |
OBJECT |
Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers |
deviceIdentifier.meid |
STRING |
The device’s MEID number |
deviceIdentifier.manufacturer |
STRING |
The device manufacturer’s name. Matches the device's built-in
value returned from |
deviceIdentifier.serialNumber |
STRING |
The manufacturer's serial number for the device. This value might not be unique across different device models |
deviceIdentifier.model |
STRING |
The device model's name. Matches the device's built-in value returned from
|
deviceIdentifier.imei |
STRING |
The device’s IMEI number. Validated on input |
pageToken |
STRING |
A token specifying which result page to return |
= Parameter name
= Format
|
partnerId INTEGER Required Required. The ID of the reseller partner |
|
limit INTEGER Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive |
|
deviceIdentifier OBJECT Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers |
|
deviceIdentifier.meid STRING The device’s MEID number |
|
deviceIdentifier.manufacturer STRING The device manufacturer’s name. Matches the device's built-in
value returned from |
|
deviceIdentifier.serialNumber STRING The manufacturer's serial number for the device. This value might not be unique across different device models |
|
deviceIdentifier.model STRING The device model's name. Matches the device's built-in value returned from
|
|
deviceIdentifier.imei STRING The device’s IMEI number. Validated on input |
|
pageToken STRING A token specifying which result page to return |
Output
This building block provides 21 output parameters
| Name | Format | Description |
|---|---|---|
devices[] |
OBJECT |
An Android device registered for zero-touch enrollment |
devices[].name |
STRING |
Output only. The API resource name in the format
|
devices[].deviceId |
INTEGER |
Output only. The ID of the device. Assigned by the server |
devices[].configuration |
STRING |
Not available to resellers |
devices[].claims[] |
OBJECT |
A record of a device claimed by a reseller for a customer. Devices claimed
for zero-touch enrollment have a claim with the type
|
devices[].claims[].resellerId |
INTEGER |
The ID of the reseller that claimed the device |
devices[].claims[].sectionType |
ENUMERATION |
Output only. The type of claim made on the device |
devices[].claims[].vacationModeStartTime |
ANY |
The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
devices[].claims[].vacationModeExpireTime |
ANY |
The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
devices[].claims[].ownerCompanyId |
INTEGER |
The ID of the Customer that purchased the device |
devices[].deviceIdentifier |
OBJECT |
Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers |
devices[].deviceIdentifier.meid |
STRING |
The device’s MEID number |
devices[].deviceIdentifier.manufacturer |
STRING |
The device manufacturer’s name. Matches the device's built-in
value returned from |
devices[].deviceIdentifier.serialNumber |
STRING |
The manufacturer's serial number for the device. This value might not be unique across different device models |
devices[].deviceIdentifier.model |
STRING |
The device model's name. Matches the device's built-in value returned from
|
devices[].deviceIdentifier.imei |
STRING |
The device’s IMEI number. Validated on input |
devices[].deviceMetadata |
OBJECT |
Metadata entries that can be attached to a |
devices[].deviceMetadata.entries |
OBJECT |
Metadata entries recorded as key-value pairs |
devices[].deviceMetadata.entries.customKey.value |
STRING |
Metadata entries recorded as key-value pairs |
nextPageToken |
STRING |
A token used to access the next page of results. Omitted if no further results are available |
totalSize |
INTEGER |
The total count of items in the list irrespective of pagination |
= Parameter name
= Format
|
devices[] OBJECT An Android device registered for zero-touch enrollment |
|
devices[].name STRING Output only. The API resource name in the format
|
|
devices[].deviceId INTEGER Output only. The ID of the device. Assigned by the server |
|
devices[].configuration STRING Not available to resellers |
|
devices[].claims[] OBJECT A record of a device claimed by a reseller for a customer. Devices claimed
for zero-touch enrollment have a claim with the type
|
|
devices[].claims[].resellerId INTEGER The ID of the reseller that claimed the device |
|
devices[].claims[].sectionType ENUMERATION Output only. The type of claim made on the device |
|
devices[].claims[].vacationModeStartTime ANY The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
|
devices[].claims[].vacationModeExpireTime ANY The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
|
devices[].claims[].ownerCompanyId INTEGER The ID of the Customer that purchased the device |
|
devices[].deviceIdentifier OBJECT Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers |
|
devices[].deviceIdentifier.meid STRING The device’s MEID number |
|
devices[].deviceIdentifier.manufacturer STRING The device manufacturer’s name. Matches the device's built-in
value returned from |
|
devices[].deviceIdentifier.serialNumber STRING The manufacturer's serial number for the device. This value might not be unique across different device models |
|
devices[].deviceIdentifier.model STRING The device model's name. Matches the device's built-in value returned from
|
|
devices[].deviceIdentifier.imei STRING The device’s IMEI number. Validated on input |
|
devices[].deviceMetadata OBJECT Metadata entries that can be attached to a |
|
devices[].deviceMetadata.entries OBJECT Metadata entries recorded as key-value pairs |
|
devices[].deviceMetadata.entries.customKey.value STRING Metadata entries recorded as key-value pairs |
|
nextPageToken STRING A token used to access the next page of results. Omitted if no further results are available |
|
totalSize INTEGER The total count of items in the list irrespective of pagination |