You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Get devices under a subscription sorted by last seen
519
519
520
520
### Example
521
521
@@ -532,13 +532,19 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
532
532
bearerAuth.accessToken="YOUR ACCESS TOKEN"
533
533
534
534
let apiInstance =newOmniCoreModelAndStateManagementApi.DeviceApi();
535
-
let subscriptionid ="subscriptionid_example"; // String | Subscription ID
536
-
let registryId ="registryId_example"; // String | Registry ID
537
-
let deviceId ="deviceId_example"; // String | Device ID
535
+
let subscriptionId ="subscriptionId_example"; // String | Subscription ID
538
536
let opts = {
539
-
'numStates':56// Number | The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
537
+
'pageNumber':56, // Number | Page Number
538
+
'pageSize':56, // Number | The maximum number of devices to return in the response. If this value is zero, the service will select a default size.
539
+
'fieldMask':"fieldMask_example", // String | The fields of the Device resource to be returned to the response. The fields id and numId are always returned, along with any other fields specified. A comma-separated list of fully qualified names of fields. Example:
540
+
'sortByClientOnline':true, // Boolean | Set to true to return devices sorted by last heartbeat
541
+
'deviceIds': ["null"], // [String] | A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000
542
+
'deviceNumIds': ["null"], // [String] | A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
543
+
'gatewayListOptionsAssociationsDeviceId':"gatewayListOptionsAssociationsDeviceId_example", // String | If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (num_id) or the user-defined string (id). For example, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.
544
+
'gatewayListOptionsAssociationsGatewayId':"gatewayListOptionsAssociationsGatewayId_example", // String | If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (num_id) or the user-defined string (id). For example, if 123 is specified, only devices bound to the gateway with num_id 123 are returned
545
+
'gatewayListOptionsGatewayType':"gatewayListOptionsGatewayType_example"// String | If GATEWAY is specified, only gateways are returned. If NON_GATEWAY is specified, only non-gateway devices are returned. If GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned.
**subscriptionid** | **String**| Subscription ID |
556
-
**registryId** | **String**| Registry ID |
557
-
**deviceId** | **String**| Device ID |
558
-
**numStates** | **Number**| The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. | [optional]
561
+
**subscriptionId** | **String**| Subscription ID |
562
+
**pageNumber** | **Number**| Page Number | [optional]
563
+
**pageSize** | **Number**| The maximum number of devices to return in the response. If this value is zero, the service will select a default size. | [optional]
564
+
**fieldMask** | **String**| The fields of the Device resource to be returned to the response. The fields id and numId are always returned, along with any other fields specified. A comma-separated list of fully qualified names of fields. Example: | [optional]
565
+
**sortByClientOnline** | **Boolean**| Set to true to return devices sorted by last heartbeat | [optional]
566
+
**deviceIds** | [**[String]**](String.md)| A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000 | [optional]
567
+
**deviceNumIds** | [**[String]**](String.md)| A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. | [optional]
568
+
**gatewayListOptionsAssociationsDeviceId** | **String**| If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (num_id) or the user-defined string (id). For example, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound. | [optional]
569
+
**gatewayListOptionsAssociationsGatewayId** | **String**| If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (num_id) or the user-defined string (id). For example, if 123 is specified, only devices bound to the gateway with num_id 123 are returned | [optional]
570
+
**gatewayListOptionsGatewayType** | **String**| If GATEWAY is specified, only gateways are returned. If NON_GATEWAY is specified, only non-gateway devices are returned. If GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned. | [optional]
@@ -594,19 +606,13 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
594
606
bearerAuth.accessToken="YOUR ACCESS TOKEN"
595
607
596
608
let apiInstance =newOmniCoreModelAndStateManagementApi.DeviceApi();
597
-
let subscriptionId ="subscriptionId_example"; // String | Subscription ID
609
+
let subscriptionid ="subscriptionid_example"; // String | Subscription ID
610
+
let registryId ="registryId_example"; // String | Registry ID
611
+
let deviceId ="deviceId_example"; // String | Device ID
598
612
let opts = {
599
-
'pageNumber':56, // Number | Page Number
600
-
'pageSize':56, // Number | The maximum number of devices to return in the response. If this value is zero, the service will select a default size.
601
-
'fieldMask':"fieldMask_example", // String | The fields of the Device resource to be returned to the response. The fields id and numId are always returned, along with any other fields specified. A comma-separated list of fully qualified names of fields. Example:
602
-
'sortByClientOnline':true, // Boolean | Set to true to return devices sorted by last heartbeat
603
-
'deviceIds': ["null"], // [String] | A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000
604
-
'deviceNumIds': ["null"], // [String] | A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
605
-
'gatewayListOptionsAssociationsDeviceId':"gatewayListOptionsAssociationsDeviceId_example", // String | If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (num_id) or the user-defined string (id). For example, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.
606
-
'gatewayListOptionsAssociationsGatewayId':"gatewayListOptionsAssociationsGatewayId_example", // String | If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (num_id) or the user-defined string (id). For example, if 123 is specified, only devices bound to the gateway with num_id 123 are returned
607
-
'gatewayListOptionsGatewayType':"gatewayListOptionsGatewayType_example"// String | If GATEWAY is specified, only gateways are returned. If NON_GATEWAY is specified, only non-gateway devices are returned. If GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned.
613
+
'numStates':56// Number | The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
**subscriptionId** | **String**| Subscription ID |
624
-
**pageNumber** | **Number**| Page Number | [optional]
625
-
**pageSize** | **Number**| The maximum number of devices to return in the response. If this value is zero, the service will select a default size. | [optional]
626
-
**fieldMask** | **String**| The fields of the Device resource to be returned to the response. The fields id and numId are always returned, along with any other fields specified. A comma-separated list of fully qualified names of fields. Example: | [optional]
627
-
**sortByClientOnline** | **Boolean**| Set to true to return devices sorted by last heartbeat | [optional]
628
-
**deviceIds** | [**[String]**](String.md)| A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000 | [optional]
629
-
**deviceNumIds** | [**[String]**](String.md)| A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. | [optional]
630
-
**gatewayListOptionsAssociationsDeviceId** | **String**| If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (num_id) or the user-defined string (id). For example, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound. | [optional]
631
-
**gatewayListOptionsAssociationsGatewayId** | **String**| If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (num_id) or the user-defined string (id). For example, if 123 is specified, only devices bound to the gateway with num_id 123 are returned | [optional]
632
-
**gatewayListOptionsGatewayType** | **String**| If GATEWAY is specified, only gateways are returned. If NON_GATEWAY is specified, only non-gateway devices are returned. If GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned. | [optional]
629
+
**subscriptionid** | **String**| Subscription ID |
630
+
**registryId** | **String**| Registry ID |
631
+
**deviceId** | **String**| Device ID |
632
+
**numStates** | **Number**| The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. | [optional]
**pubsubTopicName** | **String** | PubsubTopicName: A Topic name. For example, `projects/myProject/topics/deviceEvents`. | [optional]
8
8
**subfolderMatches** | **String** | SubfolderMatches: If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes. | [optional]
0 commit comments