findDevicesByIdentifier
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Liste les appareils avec un identifiant d'appareil donné.
Signature de la méthode
public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;
FindDevicesByDeviceIdentifierRequest
| Nom de propriété |
Valeur |
Obligatoire |
Description |
deviceIdentifier |
object(DeviceIdentifier) |
Oui |
Identifiant des appareils à récupérer. L'objet peut être partiellement renseigné. |
pageSize |
int |
Non |
Taille de la page, jusqu'à 100. Si elle est supérieure à 100 ou à null, 100 est utilisé. |
pageToken |
string |
Non |
Jeton de la page. Si ce champ est vide, la première page est renvoyée. |
vendorParams |
map |
Non |
Champs supplémentaires, paire clé-valeur spécifiée par le fournisseur. |
FindDevicesResponse
| Nom de propriété |
Valeur |
Description |
devices |
object(Device) |
Liste des appareils importés par le revendeur. Vide s'il n'y a pas de correspondance. |
totalCount |
int |
Nombre total d'appareils correspondant à la requête. |
nextPageToken |
strong |
Jeton de la page suivante. Vide pour la dernière page. |
vendorParams |
map |
Facultatif. Champs supplémentaires, paire clé-valeur spécifiée par le fournisseur. |
Comportement en cas d'erreur
Si une erreur se produit, la bibliothèque génère une CommonException contenant l'un des codes d'erreur suivants:
| Code d'erreur |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 2025/08/29 (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` |"]]
