findDevicesByIdentifier
Stay organized with collections
Save and categorize content based on your preferences.
Lists devices with given device identifier.
Method signature
public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;
FindDevicesByDeviceIdentifierRequest
| Property name |
Value |
Required |
Description |
deviceIdentifier |
object(DeviceIdentifier) |
Yes |
Device identifier of the devices to be retrieve. The object can be partially populated. |
pageSize |
int |
No |
The page size, up to 100. If greater than 100 or null, 100 is used. |
pageToken |
string |
No |
The page token. If empty, the first page is returned. |
vendorParams |
map |
No |
Extra fields, vendor specified key-value pair. |
FindDevicesResponse
| Property name |
Value |
Description |
devices |
object(Device) |
The list of devices uploaded by the reseller. Empty if there is no match. |
totalCount |
int |
The total count of devices matching the request. |
nextPageToken |
strong |
The next page token. Empty for the last page. |
vendorParams |
map |
Optional. Extra fields, vendor specified key-value pair. |
Error behavior
If an error occurs, the library throws a CommonException containing one of the
following error codes:
| Error code |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis method retrieves a list of devices based on a provided device identifier.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003edeviceIdentifier\u003c/code\u003e object, which can be partially filled, to specify the devices to be retrieved.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters include \u003ccode\u003epageSize\u003c/code\u003e (up to 100), \u003ccode\u003epageToken\u003c/code\u003e for pagination, and \u003ccode\u003evendorParams\u003c/code\u003e for extra data.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a list of \u003ccode\u003edevices\u003c/code\u003e, the \u003ccode\u003etotalCount\u003c/code\u003e of matching devices, an optional \u003ccode\u003enextPageToken\u003c/code\u003e for additional pages, and \u003ccode\u003evendorParams\u003c/code\u003e for extra information.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors during the process will result in a \u003ccode\u003eCommonException\u003c/code\u003e being thrown, with possible error codes being \u003ccode\u003eINTERNAL_SERVER_ERROR\u003c/code\u003e or \u003ccode\u003eINVALID_PAGE_TOKEN\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `findDevicesByDeviceIdentifier` method retrieves a list of devices based on a provided device identifier. The request requires a `deviceIdentifier`, and optionally accepts `pageSize` (up to 100), `pageToken`, and `vendorParams`. The response includes a list of `devices`, `totalCount`, `nextPageToken`, and optional `vendorParams`. Errors result in a `CommonException`, with codes like `INTERNAL_SERVER_ERROR` or `INVALID_PAGE_TOKEN`.\n"],null,["# findDevicesByIdentifier\n\nLists devices with given device identifier.\n\nMethod signature\n----------------\n\n public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;\n\nFindDevicesByDeviceIdentifierRequest\n------------------------------------\n\n| Property name | Value | Required | Description |\n|--------------------|---------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------|\n| `deviceIdentifier` | `object(`[`DeviceIdentifier`](/zero-touch/reseller-library/reference/objects#deviceidentifier)`)` | Yes | Device identifier of the devices to be retrieve. The object can be partially populated. |\n| `pageSize` | `int` | No | The page size, up to `100`. If greater than `100` or `null`, `100` is used. |\n| `pageToken` | `string` | No | The page token. If empty, the first page is returned. |\n| `vendorParams` | `map` | No | Extra fields, vendor specified key-value pair. |\n\nFindDevicesResponse\n-------------------\n\n| Property name | Value | Description |\n|-----------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| `devices` | `object(`[`Device`](/zero-touch/reseller-library/reference/objects#device)`)` | The list of devices uploaded by the reseller. Empty if there is no match. |\n| `totalCount` | `int` | The total count of devices matching the request. |\n| `nextPageToken` | `strong` | The next page token. Empty for the last page. |\n| `vendorParams` | `map` | Optional. Extra fields, vendor specified key-value pair. |\n\nError behavior\n--------------\n\nIf an error occurs, the library throws a `CommonException` containing one of the\nfollowing error codes:\n\n| Error code |\n|-------------------------|\n| `INTERNAL_SERVER_ERROR` |\n| `INVALID_PAGE_TOKEN` |"]]