Skip to main content

devices

Creates, updates, deletes, gets or lists a devices resource.

Overview

Namedevices
TypeResource
Idgoogle.sasportal.devices

Fields

NameDatatypeDescription
namestringOutput only. The resource path name.
activeConfigobjectInformation about the device configuration.
currentChannelsarrayOutput only. Current channels with scores.
deviceMetadataobjectDevice data overridable by both SAS Portal and registration requests.
displayNamestringDevice display name.
fccIdstringThe FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.
grantRangeAllowlistsarrayOnly ranges that are within the allowlists are available for new grants.
grantsarrayOutput only. Grants held by the device.
preloadedConfigobjectInformation about the device configuration.
serialNumberstringA serial number assigned to the device by the device manufacturer.
statestringOutput only. Device state.

Methods

NameAccessible byRequired ParamsDescription
customers_deployments_devices_listSELECTcustomersId, deploymentsIdLists devices under a node or customer.
customers_devices_getSELECTcustomersId, devicesIdGets details about a device.
customers_devices_listSELECTcustomersIdLists devices under a node or customer.
customers_nodes_devices_listSELECTcustomersId, nodesIdLists devices under a node or customer.
deployments_devices_getSELECTdeploymentsId, devicesIdGets details about a device.
nodes_deployments_devices_listSELECTdeploymentsId, nodesIdLists devices under a node or customer.
nodes_devices_getSELECTdevicesId, nodesIdGets details about a device.
nodes_devices_listSELECTnodesIdLists devices under a node or customer.
nodes_nodes_devices_listSELECTnodesId, nodesId1Lists devices under a node or customer.
customers_deployments_devices_createINSERTcustomersId, deploymentsIdCreates a device under a node or customer.
customers_devices_createINSERTcustomersIdCreates a device under a node or customer.
customers_nodes_devices_createINSERTcustomersId, nodesIdCreates a device under a node or customer.
nodes_deployments_devices_createINSERTdeploymentsId, nodesIdCreates a device under a node or customer.
nodes_devices_createINSERTnodesIdCreates a device under a node or customer.
nodes_nodes_devices_createINSERTnodesId, nodesId1Creates a device under a node or customer.
customers_devices_deleteDELETEcustomersId, devicesIdDeletes a device.
deployments_devices_deleteDELETEdeploymentsId, devicesIdDeletes a device.
nodes_devices_deleteDELETEdevicesId, nodesIdDeletes a device.
customers_devices_patchUPDATEcustomersId, devicesIdUpdates a device.
deployments_devices_patchUPDATEdeploymentsId, devicesIdUpdates a device.
nodes_devices_patchUPDATEdevicesId, nodesIdUpdates a device.
customers_devices_moveEXECcustomersId, devicesIdMoves a device under another node or customer.
customers_devices_sign_deviceEXECcustomersId, devicesIdSigns a device.
deployments_devices_moveEXECdeploymentsId, devicesIdMoves a device under another node or customer.
deployments_devices_sign_deviceEXECdeploymentsId, devicesIdSigns a device.
nodes_devices_moveEXECdevicesId, nodesIdMoves a device under another node or customer.
nodes_devices_sign_deviceEXECdevicesId, nodesIdSigns a device.

SELECT examples

Lists devices under a node or customer.

SELECT
name,
activeConfig,
currentChannels,
deviceMetadata,
displayName,
fccId,
grantRangeAllowlists,
grants,
preloadedConfig,
serialNumber,
state
FROM google.sasportal.devices
WHERE nodesId = '{{ nodesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new devices resource.

/*+ create */
INSERT INTO google.sasportal.devices (
nodesId,
grants,
displayName,
preloadedConfig,
fccId,
deviceMetadata,
activeConfig,
name,
grantRangeAllowlists,
serialNumber,
state
)
SELECT
'{{ nodesId }}',
'{{ grants }}',
'{{ displayName }}',
'{{ preloadedConfig }}',
'{{ fccId }}',
'{{ deviceMetadata }}',
'{{ activeConfig }}',
'{{ name }}',
'{{ grantRangeAllowlists }}',
'{{ serialNumber }}',
'{{ state }}'
;

UPDATE example

Updates a devices resource.

/*+ update */
UPDATE google.sasportal.devices
SET
grants = '{{ grants }}',
displayName = '{{ displayName }}',
preloadedConfig = '{{ preloadedConfig }}',
fccId = '{{ fccId }}',
deviceMetadata = '{{ deviceMetadata }}',
activeConfig = '{{ activeConfig }}',
name = '{{ name }}',
grantRangeAllowlists = '{{ grantRangeAllowlists }}',
serialNumber = '{{ serialNumber }}',
state = '{{ state }}'
WHERE
devicesId = '{{ devicesId }}'
AND nodesId = '{{ nodesId }}';

DELETE example

Deletes the specified devices resource.

/*+ delete */
DELETE FROM google.sasportal.devices
WHERE devicesId = '{{ devicesId }}'
AND nodesId = '{{ nodesId }}';