Skip to content

metadata

Jump to bottom
YYBartT edited this page Jan 18, 2026 · 1 revision

Metadata

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.


Back To Top

elements_metadata_get_metadata_objects

Elements Operation: getMetadataObjects

This function searches all metadata in the system and returns 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 Function.


Syntax:

elements_metadata_get_metadata_objects(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_search String The search filter to use.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationMetadata
_request ElementsRequest


Back To Top

elements_metadata_create_metadata

Elements Operation: createMetadata

This function 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 Function.


Syntax:

elements_metadata_create_metadata(_body=undefined, _content_type=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateMetadataRequest The body to be included in the HTTP request.
_content_type String The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadata
_request ElementsRequest


Back To Top

elements_metadata_get_metadata_object

Elements Operation: getMetadataObject

This function 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 Function.


Syntax:

elements_metadata_get_metadata_object(_id, _callback=undefined)
Argument Type Description
_id String The metadata object's database assigned unique ID.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadata
_request ElementsRequest


Back To Top

elements_metadata_update_metadata

Elements Operation: updateMetadata

This function 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 Function.


Syntax:

elements_metadata_update_metadata(_id, _body=undefined, _content_type=undefined, _callback=undefined)
Argument Type Description
_id String The metadata object's database assigned unique ID.
_body ElementsUpdateMetadataRequest The body to be included in the HTTP request.
_content_type String The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadata
_request ElementsRequest


Back To Top

elements_metadata_delete_metadata

Elements Operation: deleteMetadata

This function 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 Function.


Syntax:

elements_metadata_delete_metadata(_id, _callback=undefined)
Argument Type Description
_id String The metadata object's database assigned unique ID.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_metadata_spec_get_metadata_specs

Elements Operation: getMetadataSpecs

This function 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 Function.


Syntax:

elements_metadata_spec_get_metadata_specs(_offset=undefined, _count=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationMetadataSpec
_request ElementsRequest


Back To Top

elements_metadata_create_metadata_spec

Elements Operation: createMetadataSpec

This function creates a new MetadataSpec definition.


Syntax:

elements_metadata_create_metadata_spec(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateMetadataSpecRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A



Back To Top

elements_metadata_update_metadata_spec

Elements Operation: updateMetadataSpec

This function updates a MetadataSpec with the specified ID.


Syntax:

elements_metadata_update_metadata_spec(_metadata_spec_id, _body=undefined, _callback=undefined)
Argument Type Description
_metadata_spec_id String The ID of the Metadata Spec.
_body ElementsUpdateMetadataSpecRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A



Back To Top

elements_metadata_delete_metadata_spec

Elements Operation: deleteMetadataSpec

This function deletes a MetadataSpec with the specified ID.


Syntax:

elements_metadata_delete_metadata_spec(_metadata_spec_id, _callback=undefined)
Argument Type Description
_metadata_spec_id String The ID of the Metadata Spec.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A



Back To Top

elements_metadata_spec_get_editor_schema

Elements Operation: getEditorSchema

This function 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 Function.


Syntax:

elements_metadata_spec_get_editor_schema(_metadata_spec_name, _callback=undefined)
Argument Type Description
_metadata_spec_name String The name of the Metadata Spec.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsEditorSchema
_request ElementsRequest


Back To Top

elements_metadata_spec_get_json_schema

Elements Operation: getJsonSchema

This function 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 Function.


Syntax:

elements_metadata_spec_get_json_schema(_metadata_spec_name, _callback=undefined)
Argument Type Description
_metadata_spec_name String The name of the Metadata Spec.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsJsonSchema
_request ElementsRequest


Back To Top

elements_metadata_spec_get_metadata_spec

Elements Operation: getMetadataSpec

This function 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 Function.


Syntax:

elements_metadata_spec_get_metadata_spec(_metadata_spec_name_or_id, _callback=undefined)
Argument Type Description
_metadata_spec_name_or_id String The name or ID of the Metadata Spec.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadataSpec
_request ElementsRequest


Back To Top

elements_metadata_spec_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 Function.


Syntax:

elements_metadata_spec_create_metadata_spec(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateMetadataSpecRequest The body to be included in the http request.
_callback Function The function - with signature (status: Real, data: ${Struct.ElementsMetadataSpec}, request: ${Struct.ElementsRequest}) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadataSpec
_request ElementsRequest


Back To Top

elements_metadata_spec_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 Function.


Syntax:

elements_metadata_spec_delete_metadata_spec(_metadata_spec_id, _callback=undefined)
Argument Type Description
_metadata_spec_id String
_callback Function The function - with signature (status: Real, data: Undefined, request: ${Struct.ElementsRequest}) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_metadata_spec_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 Function.


Syntax:

elements_metadata_spec_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 The function - with signature (status: Real, data: ${Struct.ElementsMetadataSpec}, request: ${Struct.ElementsRequest}) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsMetadataSpec
_request ElementsRequest


GameMaker 2026

GMEXT-Elements

Guides

REST API

Schemas

Clone this wiki locally