elements_metadata

Metadata

The Metadata endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_create_metadata
• elements_delete_metadata
• elements_get_metadata_object
• elements_get_metadata_objects
• elements_update_metadata

---

Back To Top

elements_create_metadata

Creates a new Metadata object with the provided details.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_metadata(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	ElementsRequest

---

Back To Top

elements_delete_metadata

Deletes a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_metadata(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_get_metadata_object

Gets a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_object(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_metadata_objects

Searches all metadata in the system and returning all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_objects(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMetadata or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_metadata

Updates a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_metadata(_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_id	String
_body	ElementsUpdateMetadataRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	ElementsRequest

---