Mixin: NodeDatumMetadataUrlHelperMixin

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 23

Methods

addNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}

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

Parameters:

Name	Type	Attributes	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

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 66

Returns:

the URL

Type:: string

deleteNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}

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

Parameters:

Name	Type	Attributes	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

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 88

Returns:

the URL

Type:: string

findNodeDatumMetadataUrl(nodeIdopt, sourceIdopt, sortsopt, paginationopt) → {string}

Generate a URL for searching for datum metadata.

Parameters:

Name	Type	Attributes	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

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 103

Returns:

the URL

Type:: string

replaceNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}

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

Parameters:

Name	Type	Attributes	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

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 77

Returns:

the URL

Type:: string

viewNodeDatumMetadataUrl(nodeIdopt, 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:

Name	Type	Attributes	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

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 55

Returns:

the URL

Type:: string

viewUserMetadataUrl(userIdopt) → {string}

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	Attributes	Description
`userId`	number \| null	<optional>	a specific user ID; if not provided the `userId` property of this class will be used

Source: net/nodeDatumMetadataUrlHelperMixin.js, line 158

Returns:

the URL

Type:: string