REST Resource: customers.nodes

  • A Node is a resource within the Spectrum Access System, represented by a JSON object with properties like name, display name, and associated user IDs.

  • Nodes have specific fields like name, displayName, and sasUserIds which define their properties and relationships.

  • You can manage nodes using methods such as create, delete, get, list, move, and patch to perform various operations on them.

  • These 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.

Resource: Node

The Node.

JSON representation 
{
  "name": string,
  "displayName": string,
  "sasUserIds": [
    string
  ]
}
Fields
name

string

Output only. Resource name.
displayName

string

The node's display name.
sasUserIds[]

string

User ids used by the devices belonging to this node.

Methods

create

 Creates a new node.

delete

 Deletes a node.

get

 Returns a requested node.

list

 Lists nodes.

move

 Moves a node under another node or customer.

patch

 Updates an existing node.