REST Resource: deployments.devices
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eDevice\u003c/code\u003e resource represents a device registered with the Spectrum Access System (SAS), including details like FCC ID, serial number, and configuration.\u003c/p\u003e\n"],["\u003cp\u003eDevices can be managed through various methods like \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003emove\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e, \u003ccode\u003esignDevice\u003c/code\u003e, and \u003ccode\u003eupdateSigned\u003c/code\u003e to control their lifecycle and properties.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDevice\u003c/code\u003e resource provides information about a device's current state, grants, and operational parameters, allowing for monitoring and control within the SAS.\u003c/p\u003e\n"],["\u003cp\u003eA JSON representation of the \u003ccode\u003eDevice\u003c/code\u003e resource outlines its structure and the specific data fields associated with each device.\u003c/p\u003e\n"]]],["The provided content describes a \"Device\" resource, its JSON representation, and associated methods. Key device information includes `name`, `fccId`, `serialNumber`, `preloadedConfig`, `activeConfig`, `state`, `grants`, `displayName`, `deviceMetadata`, `currentChannels`, and `grantRangeAllowlists`. Available actions for a device involve deletion, retrieval of details, relocation to a different node or customer, modification, signing, and updating signed versions. The current channels field is deprecated.\n"],null,["# REST Resource: deployments.devices\n\n- [Resource: Device](#Device)\n - [JSON representation](#Device.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Device\n----------------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"fccId\": string, \"serialNumber\": string, \"preloadedConfig\": { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceConfig) }, \"activeConfig\": { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceConfig) }, \"state\": enum (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.State_1), \"grants\": [ { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceGrant) } ], \"displayName\": string, \"deviceMetadata\": { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceMetadata) }, \"currentChannels\": [ { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.ChannelWithScore) } ], \"grantRangeAllowlists\": [ { object (/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.FrequencyRange) } ] } ``` |\n\n| Fields ||\n|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The resource path name. |\n| `fccId` | `string` The FCC identifier of the device. |\n| `serialNumber` | `string` A serial number assigned to the device by the device manufacturer. |\n| `preloadedConfig` | `object (`[DeviceConfig](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceConfig)`)` Configuration of the device, as specified via SAS Portal API. |\n| `activeConfig` | `object (`[DeviceConfig](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceConfig)`)` Output only. Current configuration of the device as registered to the SAS. |\n| `state` | `enum (`[State](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.State_1)`)` Output only. Device state. |\n| `grants[]` | `object (`[DeviceGrant](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceGrant)`)` Output only. Grants held by the device. |\n| `displayName` | `string` Device display name. |\n| `deviceMetadata` | `object (`[DeviceMetadata](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceMetadata)`)` Device parameters that can be overridden by both SAS Portal and SAS registration requests. |\n| `currentChannels[]` **(deprecated)** | `object (`[ChannelWithScore](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.ChannelWithScore)`)` | This item is deprecated! Output only. Current channels with scores. |\n| `grantRangeAllowlists[]` | `object (`[FrequencyRange](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.FrequencyRange)`)` Only ranges that are within the allowlists are available for new grants. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [delete](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/delete) | Deletes a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device). |\n| ### [get](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/get) | Gets details about a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device). |\n| ### [move](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/move) | Moves a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under another [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |\n| ### [patch](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/patch) | Updates a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device). |\n| ### [signDevice](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/signDevice) | Signs a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device). |\n| ### [updateSigned](/spectrum-access-system/reference/rest/v1alpha1/deployments.devices/updateSigned) | Updates a signed [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device). |"]]