Skip to main content

get Devices Last Seen​

Get devices under a subscription sorted by last seen

Path Parameters
    subscriptionId string required

    Subscription ID

Query Parameters
    pageNumber integer

    Page Number

    pageSize integer

    The maximum number of devices to return in the response. If this value is zero, the service will select a default size.

    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:

    sortByClientOnline boolean

    Set to true to return devices sorted by last heartbeat

    deviceIds string[]

    A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

    deviceNumIds string[]

    A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

    gatewayListOptions.associationsDeviceId 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.

    gatewayListOptions.associationsGatewayId 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

    gatewayListOptions.gatewayType 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.

Responses

OK

Schema
    devices object[]
    id string

    Possible values: >= 3 characters and <= 256 characters

    registry string
    clientOnline boolean
    lastHeartbeatTime string
    subscription string
    pageNumber integer
    pageSize integer
    totalCount integer
Loading...