REST Resource: customers.nodes
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\u003eThis documentation provides an overview of the Node resource within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eIt describes the properties of a Node, including its name, display name, and associated user IDs.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Nodes with various methods like creating, deleting, retrieving, listing, moving, and updating them.\u003c/p\u003e\n"],["\u003cp\u003eUse the provided links within each section to access more detailed information and instructions.\u003c/p\u003e\n"]]],["Nodes have a JSON representation with fields for `name`, `displayName`, and `sasUserIds`. Key actions include: creating a new node, deleting an existing node, retrieving a specific node, and listing all nodes. Furthermore, you can move a node under another node or customer. You can also update the node by patching it. The resource `Node` is a representation of a node, it has the fields `name`, `displayName` and `sasUserIds`.\n"],null,["# REST Resource: customers.nodes\n\n- [Resource: Node](#Node)\n - [JSON representation](#Node.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Node\n--------------\n\nThe Node.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"displayName\": string, \"sasUserIds\": [ string ] } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------|\n| `name` | `string` Output only. Resource name. |\n| `displayName` | `string` The node's display name. |\n| `sasUserIds[]` | `string` User ids used by the devices belonging to this node. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [create](/spectrum-access-system/reference/rest/customers.nodes/create) | Creates a new [node](/spectrum-access-system/reference/rest/customers.nodes#Node). |\n| ### [delete](/spectrum-access-system/reference/rest/customers.nodes/delete) | Deletes a [node](/spectrum-access-system/reference/rest/customers.nodes#Node). |\n| ### [get](/spectrum-access-system/reference/rest/customers.nodes/get) | Returns a requested [node](/spectrum-access-system/reference/rest/customers.nodes#Node). |\n| ### [list](/spectrum-access-system/reference/rest/customers.nodes/list) | Lists [nodes](/spectrum-access-system/reference/rest/customers.nodes#Node). |\n| ### [move](/spectrum-access-system/reference/rest/customers.nodes/move) | Moves a [node](/spectrum-access-system/reference/rest/customers.nodes#Node) under another [node](/spectrum-access-system/reference/rest/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/customers#Customer). |\n| ### [patch](/spectrum-access-system/reference/rest/customers.nodes/patch) | Updates an existing [node](/spectrum-access-system/reference/rest/customers.nodes#Node). |"]]