net~ LocationDatumMetadataUrlHelperMixin

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

Location datum metadata is metadata associated with a specific location and source, i.e. a `locationId` and a `sourceId`.

Source

Methods

addLocationDatumMetadataUrl(locationIdopt, sourceIdopt) → {string}

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

Parameters:
NameTypeAttributesDescription
locationIdnumber<optional>

a specific location ID to use; if not provided the locationId property of this class will be used

sourceIdstring<optional>

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

Source
Returns:

the URL

Type: 
string

deleteLocationDatumMetadataUrl(locationIdopt, sourceIdopt) → {string}

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

Parameters:
NameTypeAttributesDescription
locationIdnumber<optional>

a specific location ID to use; if not provided the locationId property of this class will be used

sourceIdstring<optional>

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

Source
Returns:

the URL

Type: 
string

findLocationDatumMetadataUrl(filteropt, sortsopt, paginationopt) → {string}

Generate a URL for searching for location metadata.

Parameters:
NameTypeAttributesDescription
filtermodule:domain~DatumFilter<optional>

a search filter; the locationIds, sourceIds, tags, query, and location properties are supported

sortsArray.<module:domain~SortDescriptor><optional>

optional sort settings to use

paginationmodule:domain~Pagination<optional>

optional pagination settings to use

Source
Returns:

the URL

Type: 
string

replaceLocationDatumMetadataUrl(locationIdopt, sourceIdopt) → {string}

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

Parameters:
NameTypeAttributesDescription
locationIdnumber<optional>

a specific location ID to use; if not provided the locationId property of this class will be used

sourceIdstring<optional>

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

Source
Returns:

the URL

Type: 
string

viewLocationDatumMetadataUrl(locationIdopt, sourceIdopt) → {string}

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:
NameTypeAttributesDescription
locationIdnumber<optional>

a specific location ID to use; if not provided the locationId property of this class will be used

sourceIdstring<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

Source
Returns:

the URL

Type: 
string