plugins_metadata_mapping_retrieve
GET
/api/plugins/{name}/metadata_mapping
const url = 'https://example.com/api/plugins/example/metadata_mapping';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/plugins/example/metadata_mapping \ --header 'Authorization: <Authorization>'List the metadata field mapping to a specific plugin and an optional group.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Query Parameters
Section titled “Query Parameters”group
string
Filter by group name
Responses
Section titled “Responses”Media typeapplication/json
Serializer for MetadataMapping.
object
plugin_metadata_field
required
Serializer for MetadataField.
object
id
required
string format: uuid
slug
required
string
name
required
string
original_name
required
string
description
required
string
schema
required
Return schema associated with the metadata field.
Parameters
obj : PluginMetadataField The metadata field instance.
Returns
dict The schema of the metadata field.
object
key
additional properties
madbot_metadata_field
required
Serializer for MetadataField.
object
id
required
string format: uuid
slug
required
string
name
required
string
description
required
string
schema
required
Return schema associated with the metadata field.
Parameters
obj : madbot_api.core.models.MadbotMetadataField The metadata field instance.
Returns
dict The schema of the metadata field.
object
key
additional properties
plugin
string
Example generated
{ "plugin_metadata_field": { "name": "example", "original_name": "example", "description": "example" }, "madbot_metadata_field": { "name": "example", "description": "example" }, "plugin": "example"}Media typeapplication/json
object
code
required
string
message
required
string
details
required
Array<object>
object
parameter
string
code
string
message
string
Example
{ "code": "plugin_error", "message": "An error occurred in the plugin. Check the `details` property for more details.", "details": [ { "parameter": "plugin", "code": "invalid_plugin_type", "message": "Invalid plugin type" } ]}Media typeapplication/json
object
code
required
string
message
required
string
details
required
Array<object>
object
parameter
string
code
string
message
string
Example
{ "code": "object_not_found", "message": "Object not found. Check the `details` property for more details.", "details": [ { "parameter": "<id>", "code": "does_not_exist", "message": "\"<id>\" does not exist." } ]}
