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\u003eA Node is a resource within the Spectrum Access System, represented by a JSON object with properties like name, display name, and associated user IDs.\u003c/p\u003e\n"],["\u003cp\u003eNodes have specific fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003edisplayName\u003c/code\u003e, and \u003ccode\u003esasUserIds\u003c/code\u003e which define their properties and relationships.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage nodes using methods such as create, delete, get, list, move, and patch to perform various operations on them.\u003c/p\u003e\n"],["\u003cp\u003eThese methods allow for comprehensive control over nodes, including creating new nodes, deleting existing ones, retrieving specific node data, listing all nodes, moving nodes to different hierarchies, and updating node properties.\u003c/p\u003e\n"]]],["Nodes are defined by a name, display name, and a list of associated user IDs. The provided methods allow for managing nodes, including creating, deleting, retrieving, and listing them. Nodes can be moved under another node or a customer. Existing nodes can also be updated. The JSON representation of a node shows the structure used to define the fields of the node.\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/v1alpha1/customers.nodes/create) | Creates a new [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [delete](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes/delete) | Deletes a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [get](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes/get) | Returns a requested [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [list](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes/list) | Lists [nodes](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |\n| ### [move](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes/move) | Moves a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) 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/customers.nodes/patch) | Updates an existing [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node). |"]]
