elements_metadata_spec

Metadata Spec

The Metadata Spec 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_spec
• elements_delete_metadata_spec
• elements_get_editor_schema
• elements_get_json_schema
• elements_get_metadata_spec
• elements_get_metadata_specs
• elements_update_metadata_spec

---

Back To Top

elements_create_metadata_spec

Creates a new Metadata Spec definition.

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_spec(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataSpecRequest	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	ElementsMetadataSpec or Undefined
_request	ElementsRequest

---

Back To Top

elements_delete_metadata_spec

Deletes a MetadataSpec with the specified 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_spec(_metadata_spec_id, _callback=undefined)

Argument	Type	Description
_metadata_spec_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_editor_schema

Gets a specific Metadata Editor Schema backed by the supplied MetadataSpec by name.

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_editor_schema(_metadata_spec_name, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsEditorSchema or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_json_schema

Gets a specific JSON Schema backed by the supplied MetadataSpec by name.

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_json_schema(_metadata_spec_name, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsJsonSchema or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_metadata_spec

Gets a specific MetadataSpec 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_spec(_metadata_spec_name_or_id, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadataSpec or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_metadata_specs

Gets a pagination of Metadata Specs for the given query.

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_specs(_offset=undefined, _count=undefined, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMetadataSpec or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_metadata_spec

Updates a MetadataSpec with the specified 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_spec(_metadata_spec_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_metadata_spec_id	String
_body	ElementsUpdateMetadataSpecRequest	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	ElementsMetadataSpec or Undefined
_request	ElementsRequest

---