Get
|
|||||
|
|
Gets a device
Input
This building block consumes 1 input parameters
Name | Format | Description |
---|---|---|
name Required |
STRING |
Required. The device API resource name in the format
|
= Parameter name
= Format
name STRING Required Required. The device API resource name in the format
|
Output
This building block provides 18 output parameters
Name | Format | Description |
---|---|---|
name |
STRING |
Output only. The API resource name in the format
|
deviceId |
INTEGER |
Output only. The ID of the device. Assigned by the server |
configuration |
STRING |
Not available to resellers |
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
|
claims[].resellerId |
INTEGER |
The ID of the reseller that claimed the device |
claims[].sectionType |
ENUMERATION |
Output only. The type of claim made on the device |
claims[].vacationModeStartTime |
ANY |
The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
claims[].vacationModeExpireTime |
ANY |
The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
claims[].ownerCompanyId |
INTEGER |
The ID of the Customer that purchased the device |
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 |
deviceMetadata |
OBJECT |
Metadata entries that can be attached to a |
deviceMetadata.entries |
OBJECT |
Metadata entries recorded as key-value pairs |
deviceMetadata.entries.customKey.value |
STRING |
Metadata entries recorded as key-value pairs |
= Parameter name
= Format
name STRING Output only. The API resource name in the format
|
deviceId INTEGER Output only. The ID of the device. Assigned by the server |
configuration STRING Not available to resellers |
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
|
claims[].resellerId INTEGER The ID of the reseller that claimed the device |
claims[].sectionType ENUMERATION Output only. The type of claim made on the device |
claims[].vacationModeStartTime ANY The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
claims[].vacationModeExpireTime ANY The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode' |
claims[].ownerCompanyId INTEGER The ID of the Customer that purchased the device |
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 |
deviceMetadata OBJECT Metadata entries that can be attached to a |
deviceMetadata.entries OBJECT Metadata entries recorded as key-value pairs |
deviceMetadata.entries.customKey.value STRING Metadata entries recorded as key-value pairs |