Skip to content

plugins_metadata_mapping_retrieve

GET
/api/plugins/{name}/metadata_mapping
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.

name
required
string
group
string

Filter by group name

Media typeapplication/json

Serializer for MetadataMapping.

object
plugin_metadata_field
required

Serializer for MetadataField.

object
id
required
string format: uuid
slug
required
string
/^[-a-zA-Z0-9_]+$/
name
required
string
<= 100 characters
original_name
required
string
<= 100 characters
description
required
string
<= 3000 characters
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
/^[-a-zA-Z0-9_]+$/
name
required
string
<= 100 characters
description
required
string
<= 3000 characters
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
nullable <= 100 characters

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
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
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
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
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."
}
]
}