SolarNetwork Core

Mixin: NodeDatumMetadataUrlHelperMixin

net~ NodeDatumMetadataUrlHelperMixin

A mixin class that adds SolarNode datum metadata support to module:net~UrlHelper.

Datum metadata is metadata associated with a specific node and source, i.e. a nodeId and a sourceId.

Methods

addNodeDatumMetadataUrl( [nodeId] [, sourceId])

Generate a URL for adding (merging) datum metadata via a POST request.

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 used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

deleteNodeDatumMetadataUrl( [nodeId] [, sourceId])

Generate a URL for deleting datum metadata via a DELETE request.

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 used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

findNodeDatumMetadataUrl( [nodeId] [, sourceId] [, sorts] [, pagination])

Generate a URL for searching for datum metadata.

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 used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used; if null then ignore any sourceId property of this class
sorts Array.<SortDescriptor> <optional>

optional sort settings to use
pagination module:domain~Pagination <optional>

optional pagination settings to use
Returns:

the URL

Type
string

replaceNodeDatumMetadataUrl( [nodeId] [, sourceId])

Generate a URL for setting datum metadata via a PUT request.

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 used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used
Returns:

the URL

Type
string

viewNodeDatumMetadataUrl( [nodeId] [, sourceId])

Generate a URL for viewing datum metadata.

If no sourceId is provided, then the API will return all available datum metadata for all 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 used
sourceId string <optional>

a specific source ID to use; if not provided the sourceId property of this class will be used; if null then ignore any sourceId property of this class
Returns:

the URL

Type
string

viewUserMetadataUrl( [userId])

Generate a URL for viewing a specific user's metadata via a GET request.

Note this URL is similar to module:net~UserMetadataUrlHelperMixin#viewUserMetadataUrl but is for the read-only SolarQuery API, rather than the read-write SolarUser API.

Parameters:
Name Type Argument Description
userId number | null <optional>

a specific user ID; if not provided the userId property of this class will be used
Returns:

the URL

Type
string