Methods
addNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}
Generate a URL for adding (merging) datum metadata via a POST
request.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
sourceId | string | <optional> | a specific source ID to use; if not provided the |
the URL
- Type:
- string
deleteNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}
Generate a URL for deleting datum metadata via a DELETE
request.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
sourceId | string | <optional> | a specific source ID to use; if not provided the |
the URL
- Type:
- string
findNodeDatumMetadataUrl(nodeIdopt, sourceIdopt, sortsopt, paginationopt) → {string}
Generate a URL for searching for datum metadata.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
sourceId | string | <optional> | a specific source ID to use; if not provided the |
sorts | Array.<SortDescriptor> | <optional> | optional sort settings to use |
pagination | module:domain~Pagination | <optional> | optional pagination settings to use |
the URL
- Type:
- string
replaceNodeDatumMetadataUrl(nodeIdopt, sourceIdopt) → {string}
Generate a URL for setting datum metadata via a PUT
request.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
sourceId | string | <optional> | a specific source ID to use; if not provided the |
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.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
sourceId | string | <optional> | a specific source ID to use; if not provided the |
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.
Name | Type | Attributes | Description |
---|---|---|---|
userId | number | | <optional> | a specific user ID; if not provided the |
the URL
- Type:
- string