REST Resource: nodes.deployments.devices

  • This documentation outlines the Device resource within the Spectrum Access System, detailing its properties like FCC ID, serial number, configuration, and operational state.

  • The Device resource includes nested objects for configuration, grants, metadata, and frequency ranges for spectrum access.

  • Developers can manage Device resources using methods like create, createSigned, and list to register and track devices.

  • A JSON representation of the Device resource is provided, illustrating its structure and data fields for integration purposes.

Resource: Device

JSON representation 
{
  "name": string,
  "fccId": string,
  "serialNumber": string,
  "preloadedConfig": {
    object (DeviceConfig)
  },
  "activeConfig": {
    object (DeviceConfig)
  },
  "state": enum (State),
  "grants": [
    {
      object (DeviceGrant)
    }
  ],
  "displayName": string,
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "currentChannels": [
    {
      object (ChannelWithScore)
    }
  ],
  "grantRangeAllowlists": [
    {
      object (FrequencyRange)
    }
  ]
}
Fields
name

string

Output only. The resource path name.
fccId

string

The FCC identifier of the device.
serialNumber

string

A serial number assigned to the device by the device manufacturer.
preloadedConfig

object (DeviceConfig)

Configuration of the device, as specified via SAS Portal API.
activeConfig

object (DeviceConfig)

Output only. Current configuration of the device as registered to the SAS.
state

enum (State)

Output only. Device state.
grants[]

object (DeviceGrant)

Output only. Grants held by the device.
displayName

string

Device display name.
deviceMetadata

object (DeviceMetadata)

Device parameters that can be overridden by both SAS Portal and SAS registration requests.
currentChannels[]
(deprecated)

object (ChannelWithScore)

Output only. Current channels with scores.
grantRangeAllowlists[]

object (FrequencyRange)

Only ranges that are within the allowlists are available for new grants.

Methods

create

 Creates a device under a node or customer.

createSigned

 Creates a signed device under a node or customer.

list

 Lists devices under a node or customer.