Methods
-
availableSourcesUrl(datumFilter, withNodeIds)
-
Generate a URL for finding the available source IDs for a node or metadata filter.
Parameters:
Name Type Description datumFilter
module:domain~DatumFilter the search criteria, which can define
nodeId
,startDate
,endDate
, andmetadataFilter
properties to limit the results to; ifnodeId
not provided thenodeIds
property of this class will be usedwithNodeIds
boolean if
true
then force the response to include node IDs along with source IDs, instead of just source IDsReturns:
the URL
- Type
- string
-
datumFilter()
-
Get a new module:domain~DatumFilter configured with properties of this instance.
This will configure the following properties:
nodeIds
sourceIds
Returns:
the filter
-
datumReadingUrl(datumFilter, readingType [, tolerance] [, sorts] [, pagination])
-
Generate a URL for querying for datum reading values.
The
datumFilter
must provide the required date(s) to use for the reading type. If the reading type only requires one date, then the module:domain~DatumFilter#startDate or module:domain~DatumFilter#endDate value should be provided.Parameters:
Name Type Argument Description datumFilter
module:domain~DatumFilter the search criteria
readingType
module:domain~DatumReadingType the type of reading to find
tolerance
string <optional>
optional query tolerance to use
sorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
Returns:
the URL
- Type
- string
-
listDatumUrl(datumFilter [, sorts] [, pagination])
-
Generate a URL for querying for datum, in either raw or aggregate form.
If the
datumFilter
has anaggregate
value set, then aggregate results will be returned by SolarNet.Parameters:
Name Type Argument Description datumFilter
module:domain~DatumFilter the search criteria
sorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
Returns:
the URL
- Type
- string
-
mostRecentDatumUrl(datumFilter [, sorts] [, pagination])
-
Generate a URL for querying for the most recent datum.
Parameters:
Name Type Argument Description datumFilter
module:domain~DatumFilter the search criteria
sorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
Returns:
the URL
- Type
- string
-
reportableIntervalUrl( [nodeId] [, sourceIds])
-
Generate a URL for the "reportable interval" for a node, optionally limited to a specific set of source IDs.
If no source IDs are provided, then the reportable interval query will return an interval for all available sources.
Parameters:
Name Type Argument Description nodeId
number <optional>
a specific node ID to use; if not provided the
nodeId
property of this class will be usedsourceIds
Array.<string> <optional>
an array of source IDs to limit query to; if not provided the
sourceIds
property of this class will be usedReturns:
the URL
- Type
- string
-
streamDatumUrl(datumFilter [, sorts] [, pagination])
-
Generate a URL for querying for stream datum, in either raw or aggregate form.
If the
datumFilter
has anaggregate
value set, then aggregate results will be returned by SolarNet.Parameters:
Name Type Argument Description datumFilter
module:domain~DatumFilter the search criteria
sorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
- See:
Returns:
the URL
- Type
- string
-
streamReadingUrl(datumFilter, readingType [, tolerance] [, sorts] [, pagination])
-
Generate a URL for querying for stream reading values.
The
datumFilter
must provide the required date(s) to use for the reading type. If the reading type only requires one date, then the module:domain~DatumFilter#startDate or module:domain~DatumFilter#endDate value should be provided.Parameters:
Name Type Argument Description datumFilter
module:domain~DatumFilter the search criteria
readingType
module:domain~DatumReadingType the type of reading to find
tolerance
string <optional>
optional query tolerance to use
sorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
- See:
Returns:
the URL
- Type
- string