net~ NodeUrlHelperMixin

A mixin class that adds support for SolarNode properties to a module:net~UrlHelper.

Source

Members

nodeId :number

The first available node ID from the nodeIds property. Setting this replaces any existing node IDs with an array of just that value.

Type:
  • number
Source

nodeIds :Array.<number>

An array of node IDs, set on the nodeIds parameter

Type:
  • Array.<number>
Source

sourceId :string

The first available source ID from the sourceIds property. Setting this replaces any existing node IDs with an array of just that value.

Type:
  • string
Source

sourceIds :Array.<string>

An array of source IDs, set on the sourceIds parameter

Type:
  • Array.<string>
Source

Methods

findSourcesUrl(datumFilter) → {string}

Generate a URL for finding the available source IDs.

Parameters:
NameTypeDescription
datumFiltermodule:domain~DatumFilter

the search criteria, which can define nodeId, startDate, endDate, localStartDate, localEndDdate, metadataFilter, propertyNames, instantaneousPropertyNames, accumulatingPropertyNames, and statusPropertyNames, properties to limit the results to

Source
Returns:

the URL

Type: 
string

listAllNodeIdsUrl() → {string}

Generate a URL to get a list of all active node IDs available to the requesting user.

Note this method only works against the /sec version of the API endpoint.

Source
Returns:

the URL to access the node IDs the requesting user has access to

Type: 
string