DeviceListResponseSchema

object

@odata.nextLink

string Optional
URL if the page length and number of items match.

supplemental

object ListResponseSupplementalSchema Required
Supplemental info

Properties

• count integer Required
  Number of items returned
• kind string Required
  Type of items in the list
• operation string Required
  Operation type. Should always say 'list'
• pagination object PaginationInfoSchema Required
  Pagination info

Pagination Properties

• end integer Required
  Position of the last item in the list
• records integer Required
  Total number of items returned in the list
• start integer Required
  Position of the first item in the list
• total integer Required
  Total number of items in the project

subscription

object ProjectInfoSchema Optional
Project info

Subscription Properties

• id string Required
  Project ID
• name string Required
  Project name

valuelist of objects

DeviceGetSchema Required
A list of devices.

Device Properties

• kind string Required
  The kind of record.
• metadata object MetadataSchema Required
  Device metadata.

Metadata Properties

• created string Optional format: date-time
  The time when the resource was created
• createdBy string Optional format: uuid
  ID of the user who created the resource
• createdByEmail string Optional
  Email of the user who created the resource
• displayName string Optional
  The display name of the resource
• id string Required format: uuid
  The ID of the resource
• labels map from strings to string Optional
  A dictionary of labels associated with the resource
• name string Optional
  The name of the resource
• updated string Optional format: date-time
  The time when the resource was last updated
• updatedBy string Optional format: uuid
  ID of the user who last updated the resource
• updatedByEmail string Optional
  Email of the user who last updated the resource

spec

object DeviceBodySpec Required
Device specification.

Specification Properties

• autoPreloadLatestSoftware boolean Optional Defaults to false
  Whether the device should automatically preload the latest available software version.
• availableNetworks list of objects AvailableNetworkFragment Required
  The list of networks available to the device.

Geolocation Data

• geolocation object GeolocationFragment Optional
  Optional geolocation data for the device.

Geolocation Properties

• coordinates list of doubles Required
  Co-ordinates that describe the geolocation (ISO 6709).

status

object DeviceStatusGetSchema Required
Device status.

Status Properties

• alarmSeverity enum Optional
  The most severe alarm level last reported by the device.
• assignedFlows list of objects AssignedFlowGetSchema Optional
  A list of the flow names assigned to the device.

beamHA

object BeamHASchema Optional
Information about the beamHA the device is connected to.

capabilities

object DeviceCapabilitiesSchema Optional
Device capabilities based on software version and hardware.