Mixin: UserDatumAuxiliaryUrlHelperMixin

Methods

---

deleteUserDatumAuxiliaryUrl(type, nodeId, date, sourceId)

Generate a URL for deleting a DatumAuxiliaryType via a DELETE request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:

Name	Type	Description
type	module:domain~DatumAuxiliaryType	the datum auxiliary type
nodeId	number	the node ID
date	Date	a date
sourceId	string	the source ID

Returns:

the URL

Type

string

---

listUserDatumAuxiliaryUrl(filter)

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

Parameters:

Name	Type	Description
filter	module:domain~DatumFilter	the search criteria

Returns:

the URL

Type

string

---

storeUserDatumAuxiliaryUrl(type, nodeId, date, sourceId)

Generate a URL for storing a DatumAuxiliaryType via a POST request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:

Name	Type	Description
type	module:domain~DatumAuxiliaryType	the datum auxiliary type
nodeId	number	the node ID
date	Date	a date
sourceId	string	the source ID

Returns:

the URL

Type

string

---

userDatumAuxiliaryIdQueryUrl(type, nodeId, date, sourceId)

Generate a URL for accessing a specific DatumAuxiliaryType by its primary key, using query parameters for id components.

Parameters:

Name	Type	Description
type	module:domain~DatumAuxiliaryType	the datum auxiliary type
nodeId	number	the node ID
date	Date	a date
sourceId	string	the source ID

Returns:

the URL

Type

string

---

userDatumAuxiliaryIdUrl(type, nodeId, date, sourceId)

Generate a URL for accessing a specific DatumAuxiliaryType by its primary key.

If sourceId contains any / characters, then module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdQueryUrl will be invoked instead.

Parameters:

Name	Type	Description
type	module:domain~DatumAuxiliaryType	the datum auxiliary type
nodeId	number	the node ID
date	Date	a date
sourceId	string	the source ID

Returns:

the URL

Type

string

---

viewUserDatumAuxiliaryUrl(type, nodeId, date, sourceId)

Generate a URL for viewing a DatumAuxiliaryType via a GET request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.

Parameters:

Name	Type	Description
type	module:domain~DatumAuxiliaryType	the datum auxiliary type
nodeId	number	the node ID
date	Date	a date
sourceId	string	the source ID

Returns:

the URL

Type

string