REST Resource: nodes.nodes.devices
Stay organized with collections
Save and categorize content based on your preferences.
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 Device resource represents a registered device within the Spectrum Access System (SAS), containing device-specific information like FCC ID, serial number, and operational state.\u003c/p\u003e\n"],["\u003cp\u003eDevices can be created and managed under a specific node or customer using provided methods.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a device includes key fields like name, configuration details, grants, and metadata.\u003c/p\u003e\n"],["\u003cp\u003eAvailable methods for Device resources include create, createSigned, and list, allowing for device registration and retrieval.\u003c/p\u003e\n"]]],["The `Device` resource contains information like `name`, `fccId`, `serialNumber`, `preloadedConfig`, `activeConfig`, `state`, `grants`, `displayName`, and `deviceMetadata`. It includes lists for `currentChannels` (deprecated) and `grantRangeAllowlists`. Key actions include creating devices under a node or customer, both signed and unsigned, as well as listing existing devices. The JSON representation defines the structure of this data.\n"],null,["# REST Resource: nodes.nodes.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| ### [create](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes.devices/create) | Creates a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |\n| ### [createSigned](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes.devices/createSigned) | Creates a signed [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |\n| ### [list](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes.devices/list) | Lists [devices](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer). |"]]
