ESPRMAdminNode
Defined in: src/ESPRMAdminNode.ts:11
Shell class for admin node management operations. Methods are added via prototype augmentation in methods/ESPRMAdminNode/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminNode():
ESPRMAdminNode
Returns
Section titled “Returns”ESPRMAdminNode
Methods
Section titled “Methods”activateDeactivateNodes()
Section titled “activateDeactivateNodes()”activateDeactivateNodes(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminNode/ActivateDeactivateNodes.ts:22
Activates or deactivates nodes based on the provided parameters.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters specifying which nodes to activate or deactivate.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the operation.
addCommandRequest()
Section titled “addCommandRequest()”addCommandRequest(
params):Promise<AddCommandRequestResponse>
Defined in: src/methods/ESPRMAdminNode/AddCommandRequest.ts:22
Sends a new command request to one or more nodes.
Parameters
Section titled “Parameters”params
Section titled “params”The command request payload including target nodes and command data.
Returns
Section titled “Returns”Promise<AddCommandRequestResponse>
The response containing the created command request details.
attachNodeTags()
Section titled “attachNodeTags()”attachNodeTags(
nodeId,params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminNode/AttachNodeTags.ts:28
Attaches tags to a specific node.
Parameters
Section titled “Parameters”nodeId
Section titled “nodeId”string
The ID of the node to attach tags to.
params
Section titled “params”The tag attachment request payload.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the tags were attached.
getCommandRequests()
Section titled “getCommandRequests()”getCommandRequests(
params?):Promise<GetCommandRequestsResponse>
Defined in: src/methods/ESPRMAdminNode/GetCommandRequests.ts:22
Retrieves command requests with optional filtering parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter command requests.
Returns
Section titled “Returns”Promise<GetCommandRequestsResponse>
The list of command requests matching the specified criteria.
getNodes()
Section titled “getNodes()”getNodes(
params?):Promise<AdminNodeListResponse>
Defined in: src/methods/ESPRMAdminNode/GetNodes.ts:22
Retrieves a list of admin nodes with optional filtering parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the node list.
Returns
Section titled “Returns”Promise<AdminNodeListResponse>
The list of admin nodes matching the specified criteria.
getNodeTags()
Section titled “getNodeTags()”getNodeTags(
params?):Promise<GetNodeTagsResponse>
Defined in: src/methods/ESPRMAdminNode/GetNodeTags.ts:21
Retrieves node tag names, or tag values for a specific tag name.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters for filtering and pagination.
Returns
Section titled “Returns”Promise<GetNodeTagsResponse>
The response containing tags or tag values with pagination info.
getSimpleTimeSeriesData()
Section titled “getSimpleTimeSeriesData()”getSimpleTimeSeriesData(
params):Promise<GetSimpleTimeSeriesDataResponse>
Defined in: src/methods/ESPRMAdminNode/GetSimpleTimeSeriesData.ts:27
Retrieves simplified time series data for a specific node.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters including the node ID and time range for the query.
Returns
Section titled “Returns”Promise<GetSimpleTimeSeriesDataResponse>
The simplified time series data for the specified node.
getTimeSeriesData()
Section titled “getTimeSeriesData()”getTimeSeriesData(
params):Promise<GetTimeSeriesDataResponse>
Defined in: src/methods/ESPRMAdminNode/GetTimeSeriesData.ts:27
Retrieves time series data for a specific node.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters including the node ID and time range for the query.
Returns
Section titled “Returns”Promise<GetTimeSeriesDataResponse>
The time series data for the specified node.
removeNodeTags()
Section titled “removeNodeTags()”removeNodeTags(
nodeId,tags):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminNode/RemoveNodeTags.ts:27
Removes the specified tags from a node.
Parameters
Section titled “Parameters”nodeId
Section titled “nodeId”string
The ID of the node to remove tags from.
string[]
Array of tag strings to remove.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the tags were removed.