# plugins_api.dtos

*module*

Data Transfer Objects (DTOs) for plugins.

This module contains all DTOs used in the plugin system.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1-1)

## plugins_api.dtos.AccessType

*class*

```python
class AccessType(StrEnum)
```

Bases: `StrEnum`

Enum for supported access types for external data objects.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1007-1011)

### plugins_api.dtos.AccessType.SHELL

*attribute* · *class attribute* · *instance attribute*

```python
SHELL = 'shell'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1011-1011)

### plugins_api.dtos.AccessType.URL

*attribute* · *class attribute* · *instance attribute*

```python
URL = 'url'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1010-1010)

## plugins_api.dtos.AssociationRole

*class*

```python
class AssociationRole(StrEnum)
```

Bases: `StrEnum`

Possible roles of an object within a submission association.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L940-944)

### plugins_api.dtos.AssociationRole.SOURCE

*attribute* · *class attribute* · *instance attribute*

```python
SOURCE = 'source'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L943-943)

### plugins_api.dtos.AssociationRole.TARGET

*attribute* · *class attribute* · *instance attribute*

```python
TARGET = 'target'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L944-944)

## plugins_api.dtos.ConnectionField

*class*

```python
class ConnectionField(BaseModel)
```

Bases: `BaseModel`

DTO representing a connection field.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L819-824)

### plugins_api.dtos.ConnectionField.schema_content

*attribute* · *instance attribute*

```python
schema_content: dict[str, Any]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L823-823)

### plugins_api.dtos.ConnectionField.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L822-822)

### plugins_api.dtos.ConnectionField.uischema

*attribute* · *class attribute* · *instance attribute*

```python
uischema: dict[str, Any] | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L824-824)

## plugins_api.dtos.ExternalAccess

*class*

```python
class ExternalAccess(BaseModel)
```

Bases: `BaseModel`

DTO for how to access an external data object.

**Attributes**

- `access_type` (`AccessType`) — Type of access to the external data object.
- `details` (`str`) — For ``AccessType.URL``: a URL string. For ``AccessType.SHELL``: a command string. Stored as a string of at most 1000 characters.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1014-1028)

### plugins_api.dtos.ExternalAccess.access_type

*attribute* · *instance attribute*

```python
access_type: AccessType
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1027-1027)

### plugins_api.dtos.ExternalAccess.details

*attribute* · *instance attribute*

```python
details: Any
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1028-1028)

## plugins_api.dtos.ExternalIdentifier

*class*

```python
class ExternalIdentifier(BaseModel)
```

Bases: `BaseModel`

DTO for an identifier assigned by an external repository for submission plugins.

**Attributes**

- `identifier` (`str`) — The identifier string itself (DOI, accession, …).
- `type` (`ExternalIdentifierType`) — Kind of identifier. Must be one of the enum values.
- `url` (`(str, optional)`) — URL for the identifier, if any.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L78-94)

### plugins_api.dtos.ExternalIdentifier.identifier

*attribute* · *instance attribute*

```python
identifier: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L92-92)

### plugins_api.dtos.ExternalIdentifier.type

*attribute* · *class attribute* · *instance attribute*

```python
type: ExternalIdentifierType = Field(..., description='Type of identifier')
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L93-93)

### plugins_api.dtos.ExternalIdentifier.url

*attribute* · *class attribute* · *instance attribute*

```python
url: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L94-94)

## plugins_api.dtos.ExternalIdentifierType

*class*

```python
class ExternalIdentifierType(StrEnum)
```

Bases: `StrEnum`

Type of external identifier.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L55-68)

### plugins_api.dtos.ExternalIdentifierType.ACCESSION

*attribute* · *class attribute* · *instance attribute*

```python
ACCESSION = 'ACCESSION'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L62-62)

### plugins_api.dtos.ExternalIdentifierType.ARK

*attribute* · *class attribute* · *instance attribute*

```python
ARK = 'ARK'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L59-59)

### plugins_api.dtos.ExternalIdentifierType.BIOPROJECT

*attribute* · *class attribute* · *instance attribute*

```python
BIOPROJECT = 'BIOPROJECT'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L67-67)

### plugins_api.dtos.ExternalIdentifierType.BIOSAMPLE

*attribute* · *class attribute* · *instance attribute*

```python
BIOSAMPLE = 'BIOSAMPLE'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L68-68)

### plugins_api.dtos.ExternalIdentifierType.DOI

*attribute* · *class attribute* · *instance attribute*

```python
DOI = 'DOI'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L58-58)

### plugins_api.dtos.ExternalIdentifierType.ENA_EXPERIMENT

*attribute* · *class attribute* · *instance attribute*

```python
ENA_EXPERIMENT = 'ENA EXPERIMENT'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L65-65)

### plugins_api.dtos.ExternalIdentifierType.ENA_PROJECT

*attribute* · *class attribute* · *instance attribute*

```python
ENA_PROJECT = 'ENA PROJECT'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L63-63)

### plugins_api.dtos.ExternalIdentifierType.ENA_RUN

*attribute* · *class attribute* · *instance attribute*

```python
ENA_RUN = 'ENA RUN'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L66-66)

### plugins_api.dtos.ExternalIdentifierType.ENA_SAMPLE

*attribute* · *class attribute* · *instance attribute*

```python
ENA_SAMPLE = 'ENA SAMPLE'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L64-64)

### plugins_api.dtos.ExternalIdentifierType.ID

*attribute* · *class attribute* · *instance attribute*

```python
ID = 'ID'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L60-60)

### plugins_api.dtos.ExternalIdentifierType.PURL

*attribute* · *class attribute* · *instance attribute*

```python
PURL = 'PURL'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L61-61)

## plugins_api.dtos.FieldRepresentation

*class*

```python
class FieldRepresentation(BaseModel)
```

Bases: `BaseModel`

DTO for a metadata field defined by a plugin.

**Attributes**

- `slug` (`str`) — Field slug: ``plugin__field`` or ``plugin__mot__field``.
- `schema_rep` (`SchemaRepresentation`) — Schema for this field. ``schema_rep.slug`` should match ``slug``.
- `title` (`str`) — Display name.
- `description` (`str`) — Human-readable description. May be empty.
- `external_url` (`str`) — Documentation URL for the field. Use ``""`` if none.
- `madbot_fields` (`list[str]`) — Slugs of mapped madbot fields. Empty list if unmapped.
- `hidden` (`bool`) — If True, the field should be hidden in the UI.
- `standard` (`(str, optional)`) — Metadata standard this field belongs to, or None.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L647-678)

### plugins_api.dtos.FieldRepresentation.description

*attribute* · *instance attribute*

```python
description: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L674-674)

### plugins_api.dtos.FieldRepresentation.external_url

*attribute* · *instance attribute*

```python
external_url: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L675-675)

### plugins_api.dtos.FieldRepresentation.hidden

*attribute* · *instance attribute*

```python
hidden: bool
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L677-677)

### plugins_api.dtos.FieldRepresentation.madbot_fields

*attribute* · *instance attribute*

```python
madbot_fields: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L676-676)

### plugins_api.dtos.FieldRepresentation.schema_rep

*attribute* · *instance attribute*

```python
schema_rep: SchemaRepresentation
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L672-672)

### plugins_api.dtos.FieldRepresentation.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L671-671)

### plugins_api.dtos.FieldRepresentation.standard

*attribute* · *class attribute* · *instance attribute*

```python
standard: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L678-678)

### plugins_api.dtos.FieldRepresentation.title

*attribute* · *instance attribute*

```python
title: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L673-673)

## plugins_api.dtos.MadbotMetadata

*class*

```python
class MadbotMetadata(BaseModel)
```

Bases: `BaseModel`

DTO for metadata attached to a madbot object, provided by madbot core to plugins.

**Attributes**

- `field` (`MetadataFieldID`) — Field this value belongs to.
- `metadata_value` (`(MetadataValue, optional)`) — Selected value. Named ``metadata_value`` here (not ``value``).
- `inherited_values` (`list[MetadataValue]`) — Candidate values inherited from ancestors. Same role as ``MetadataObjectMetadata.candidate_values``.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L265-282)

### plugins_api.dtos.MadbotMetadata.field

*attribute* · *instance attribute*

```python
field: MetadataFieldID
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L280-280)

### plugins_api.dtos.MadbotMetadata.inherited_values

*attribute* · *class attribute* · *instance attribute*

```python
inherited_values: list[MetadataValue] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L282-282)

### plugins_api.dtos.MadbotMetadata.metadata_value

*attribute* · *class attribute* · *instance attribute*

```python
metadata_value: MetadataValue | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L281-281)

## plugins_api.dtos.MadbotMetadataObject

*class*

```python
class MadbotMetadataObject(BaseModel)
```

Bases: `BaseModel`

DTO for a metadata object instance provided by madbot core to plugins.

Distinct from `MetadataObject`, which plugins return from `create_metadata_objects()`.

**Attributes**

- `id` (`UUID`) — Madbot identifier of the metadata object.
- `type` (`str`) — Metadata object type slug (e.g. ``"sample"``).
- `metadata` (`list[MetadataObjectMetadata]`) — Field values on this object.
- `cross_validation` (`dict[str, Any]`) — Cross-field validation errors, keyed by field slug. Empty dict if valid.
- `external_identifiers` (`list[ExternalIdentifier]`) — Identifiers assigned after submission, if any.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L477-511)

### plugins_api.dtos.MadbotMetadataObject.cross_validation

*attribute* · *instance attribute*

```python
cross_validation: dict[str, Any]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L500-500)

### plugins_api.dtos.MadbotMetadataObject.external_identifiers

*attribute* · *class attribute* · *instance attribute*

```python
external_identifiers: list[ExternalIdentifier] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L501-501)

### plugins_api.dtos.MadbotMetadataObject.id

*attribute* · *class attribute* · *instance attribute*

```python
id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L497-497)

### plugins_api.dtos.MadbotMetadataObject.metadata

*attribute* · *instance attribute*

```python
metadata: list[MetadataObjectMetadata]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L499-499)

### plugins_api.dtos.MadbotMetadataObject.type

*attribute* · *instance attribute*

```python
type: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L498-498)

## plugins_api.dtos.MetadataFieldID

*class*

```python
class MetadataFieldID(BaseModel)
```

Bases: `BaseModel`

DTO for metadata field.

**Attributes**

- `slug` (`str`) — Unique identifier for the metadata field. For plugin fields: ``plugin__field`` or ``plugin__mot__field``. For madbot fields: the madbot field slug.
- `name` (`str`) — Display name of the metadata field.
- `source` (`str`) — ``"referential"`` for a madbot field, or the plugin slug for a plugin field.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L97-115)

### plugins_api.dtos.MetadataFieldID.name

*attribute* · *instance attribute*

```python
name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L114-114)

### plugins_api.dtos.MetadataFieldID.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L113-113)

### plugins_api.dtos.MetadataFieldID.source

*attribute* · *instance attribute*

```python
source: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L115-115)

## plugins_api.dtos.MetadataFieldMapping

*class*

```python
class MetadataFieldMapping(BaseModel)
```

Bases: `BaseModel`

DTO for metadata mapping.

This DTO is used to map a metadata field from the plugin to a metadata field in madbot.
It represents a bidirectional mapping between fields in the madbot referential
and fields in a plugin referential, along with transformation functions for
converting data between the two systems.

**Attributes**

- `plugin_fields` (`list[str]`) — Plugin field slugs involved in this mapping. Keys of the dict passed to ``transform_plugin_to_madbot`` must be a subset of these slugs.
- `madbot_fields` (`list[str]`) — Madbot field slugs involved in this mapping. Keys of the dict passed to ``transform_madbot_to_plugin`` must be a subset of these slugs.
- `transform_madbot_to_plugin` (`Callable`) — ``dict[madbot_slug, value] -> dict[plugin_slug, value]``.
- `transform_plugin_to_madbot` (`Callable`) — ``dict[plugin_slug, value] -> dict[madbot_slug, value]``.
- `mapping_id` (`Optional[str]`) — Unique identifier for this mapping rule. Useful for distinguishing between multiple mappings for the same field (e.g., different checklists).

> **Notes**
>
> Additional metadata for the mapping (e.g., checklist, version, etc.) can be
> added through extra fields.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L118-157)

### plugins_api.dtos.MetadataFieldMapping.madbot_fields

*attribute* · *instance attribute*

```python
madbot_fields: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L151-151)

### plugins_api.dtos.MetadataFieldMapping.mapping_id

*attribute* · *class attribute* · *instance attribute*

```python
mapping_id: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L154-154)

### plugins_api.dtos.MetadataFieldMapping.model_config

*attribute* · *class attribute* · *instance attribute*

```python
model_config = ConfigDict(extra='allow')
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L157-157)

### plugins_api.dtos.MetadataFieldMapping.plugin_fields

*attribute* · *instance attribute*

```python
plugin_fields: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L150-150)

### plugins_api.dtos.MetadataFieldMapping.transform_madbot_to_plugin

*attribute* · *instance attribute*

```python
transform_madbot_to_plugin: Callable[[dict[str, Any]], dict[str, Any]]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L152-152)

### plugins_api.dtos.MetadataFieldMapping.transform_plugin_to_madbot

*attribute* · *instance attribute*

```python
transform_plugin_to_madbot: Callable[[dict[str, Any]], dict[str, Any]]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L153-153)

## plugins_api.dtos.MetadataGroupNodeDTO

*class*

```python
class MetadataGroupNodeDTO(BaseModel)
```

Bases: `BaseModel`

DTO representing a node in a metadata groups navigation tree.

This tree is for UI navigation only. It is complementary to
``get_all_metadata_object_types()`` / ``get_contextual_metadata_object_types()``,
which define what each metadata object type (MOT) contains (fields, levels,
occurrences). Groups only organize those fields for browsing.

> **Node types**
>
> - ``type="mot"``: mirrors a metadata object type. ``slug`` must match a key
>   from ``get_all_metadata_object_types()``. Usually has no ``fields`` if it
>   has children, if so use ``fields=[]``, and the children are subgroups.
> - ``type="subgroup"``: UI folder under an MOT (or under another subgroup).
>   Holds field slugs that belong to that MOT only.

> **Rules**
>
> - Recreate each MOT as a ``type="mot"`` node (e.g. Zenodo's ``"general"``).
> - Do not mix fields from different MOTs in the same subgroup.
> - Nodes with ``has_groups=True`` must have ``children``; nodes with
>   ``has_groups=False`` must not.
> - Field entries are either a slug string, or
>   ``{"slug": "...", "level": "mandatory"|"recommended"|"optional"}``.

**Attributes**

- `slug` (`str`) — Unique slug for the group node. For ``type="mot"``, use the MOT slug.
- `name` (`str`) — Display name of the group node.
- `description` (`str`) — Human-readable description of the group node.
- `type` (`Literal['mot', 'subgroup'] | None`) — ``"mot"`` for a metadata object type node, ``"subgroup"`` for nested groups.
- `has_groups` (`bool`) — True when this node has child group nodes.
- `fields` (`list[str | dict]`) — Field slugs attached to this node (usually on subgroups, not on MOT nodes that have children). Each field can be either: - a plain slug string, or - a dict with:     - slug: field slug     - level: one of "mandatory", "recommended", "optional"
- `children` (`list[MetadataGroupNodeDTO]`) — Child group nodes.

**Examples**

A single MOT with subgroups (Zenodo-style):

```pycon
>>> MetadataGroupNodeDTO(
...     slug="general",
...     name="General",
...     description="Deposition metadata",
...     type="mot",
...     has_groups=True,
...     fields=[],
...     children=[
...         MetadataGroupNodeDTO(
...             slug="core_identification",
...             name="Core identification",
...             description="Essential identifying information",
...             type="subgroup",
...             has_groups=False,
...             fields=["plugin__title", "plugin__description"],
...             children=[],
...         )
...     ],
... )
```

Two MOTs:

```pycon
>>> [
...     MetadataGroupNodeDTO(
...         slug="general",
...         name="General",
...         description="General metadata object",
...         type="mot",
...         has_groups=False,
...         fields=["plugin__a", "plugin__b"],
...         children=[],
...     ),
...     MetadataGroupNodeDTO(
...         slug="complementary",
...         name="Complementary",
...         description="Complementary metadata object",
...         type="mot",
...         has_groups=False,
...         fields=["plugin__d", "plugin__e"],
...         children=[],
...     ),
... ]
```

A subgroup with checklist-specific levels:

```pycon
>>> MetadataGroupNodeDTO(
...     slug="sample_environment",
...     name="Environment",
...     description="Environmental metadata for the sample",
...     type="subgroup",
...     has_groups=False,
...     fields=[
...         {"slug": "ena__sample__environmental_sample", "level": "optional"},
...         {"slug": "ena__sample__geographical_location", "level": "mandatory"},
...     ],
...     children=[],
... )
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L681-813)

### plugins_api.dtos.MetadataGroupNodeDTO.children

*attribute* · *class attribute* · *instance attribute*

```python
children: list[MetadataGroupNodeDTO] = Field(default_factory=list)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L802-802)

### plugins_api.dtos.MetadataGroupNodeDTO.description

*attribute* · *instance attribute*

```python
description: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L792-792)

### plugins_api.dtos.MetadataGroupNodeDTO.fields

*attribute* · *class attribute* · *instance attribute*

```python
fields: list[str | dict[Literal['slug', 'level'], str | Literal['mandatory', 'recommended', 'optional'] | None]] = Field(default_factory=list)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L795-801)

### plugins_api.dtos.MetadataGroupNodeDTO.has_groups

*attribute* · *class attribute* · *instance attribute*

```python
has_groups: bool = False
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L794-794)

### plugins_api.dtos.MetadataGroupNodeDTO.name

*attribute* · *instance attribute*

```python
name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L791-791)

### plugins_api.dtos.MetadataGroupNodeDTO.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L790-790)

### plugins_api.dtos.MetadataGroupNodeDTO.type

*attribute* · *class attribute* · *instance attribute*

```python
type: Literal['mot', 'subgroup'] | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L793-793)

## plugins_api.dtos.MetadataObject

*class*

```python
class MetadataObject(BaseModel)
```

Bases: `BaseModel`

DTO for a metadata object instance returned by a submission plugin.

Distinct from `MadbotMetadataObject`, which madbot core sends to plugins.
Return these from ``create_metadata_objects()``, keyed by type slug.

**Attributes**

- `id` (`(UUID, optional)`) — Existing madbot ID when updating, or a new UUID when creating.
- `type` (`MetadataObjectType`) — Full type definition, not a slug.
- `metadata` (`list[MetadataObjectMetadata]`) — Field values on this object.
- `cross_validation` (`dict[str, Any]`) — Cross-field validation errors, keyed by field slug. Empty dict if valid.
- `external_identifiers` (`list[ExternalIdentifier]`) — Identifiers assigned after submission, if any.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L902-937)

### plugins_api.dtos.MetadataObject.cross_validation

*attribute* · *instance attribute*

```python
cross_validation: dict[str, Any]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L926-926)

### plugins_api.dtos.MetadataObject.external_identifiers

*attribute* · *class attribute* · *instance attribute*

```python
external_identifiers: list[ExternalIdentifier] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L927-927)

### plugins_api.dtos.MetadataObject.id

*attribute* · *class attribute* · *instance attribute*

```python
id: UUID | None = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L923-923)

### plugins_api.dtos.MetadataObject.metadata

*attribute* · *instance attribute*

```python
metadata: list[MetadataObjectMetadata]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L925-925)

### plugins_api.dtos.MetadataObject.type

*attribute* · *instance attribute*

```python
type: MetadataObjectType
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L924-924)

## plugins_api.dtos.MetadataObjectMetadata

*class*

```python
class MetadataObjectMetadata(BaseModel)
```

Bases: `BaseModel`

DTO for one metadata field on a metadata object.

**Attributes**

- `field` (`MetadataFieldID`) — Field this value belongs to.
- `metadata_value` (`(MetadataValue or SubmissionMetadataValue, optional)`) — Selected value.
- `candidate_values` (`list[MetadataValue | SubmissionMetadataValue]`) — Alternative values the user may pick. Same role as ``MadbotMetadata.inherited_values``.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L301-343)

### plugins_api.dtos.MetadataObjectMetadata.candidate_values

*attribute* · *class attribute* · *instance attribute*

```python
candidate_values: list[MetadataValue | SubmissionMetadataValue] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L318-318)

### plugins_api.dtos.MetadataObjectMetadata.field

*attribute* · *instance attribute*

```python
field: MetadataFieldID
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L316-316)

### plugins_api.dtos.MetadataObjectMetadata.metadata_value

*attribute* · *class attribute* · *instance attribute*

```python
metadata_value: MetadataValue | SubmissionMetadataValue | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L317-317)

### plugins_api.dtos.MetadataObjectMetadata.from_metadata

*method* · *classmethod*

```python
def from_metadata(metadata: MadbotMetadata) -> MetadataObjectMetadata
```

Convert a Metadata to a MetadataObjectMetadata.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L320-327)

### plugins_api.dtos.MetadataObjectMetadata.to_metadata

*method*

```python
def to_metadata() -> MadbotMetadata
```

Convert a MetadataObjectMetadata to a Metadata.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L329-335)

## plugins_api.dtos.MetadataObjectType

*class*

```python
class MetadataObjectType(BaseModel)
```

Bases: `BaseModel`

DTO representing a type of metadata object in the submission plugin.

This class defines the structure and requirements for a metadata object type in the system.
It specifies what fields are required, recommended, or optional, along with their validation rules.

**Attributes**

- `name` (`str`) — The display name of the metadata object type (e.g., 'Sample', 'Experiment', 'Dataset').
- `slug` (`str`) — A unique identifier for the metadata object type, used in URLs and API endpoints. Should be lowercase with hyphens (e.g., 'sample', 'experiment', 'dataset').
- `summary_fields` (`List[str]`) — List of field names that should be displayed in summary views or lists. These fields provide a quick overview of the metadata object.
- `priority` (`List[str]`) — Ordered list of field names indicating their display priority. Fields listed first will be displayed before fields listed later.
- `description` (`str`) — A detailed description of what this metadata object type represents and how it should be used in the system.
- `additional_information` (`(str, optional)`) — Additional contextual information displayed as an informational alert in the submission UI tabs. Intended to provide guidance or warnings specific to this metadata object type, such as instructions for configuring paired data. If None, no alert is displayed.
- `show_additional_information_on_data_tab` (`bool`) — Whether the additional_information message should also be displayed in the Data tab of the submission UI, in addition to the metadata object type's own tab. Useful when the guidance is relevant to data configuration, such as paired file setup. Defaults to False.
- `minimal_occurrence` (`int`) — The minimum number of instances of this metadata object type that must be provided in a submission. For example, if set to 1, at least one instance is required.
- `maximal_occurrence` (`Optional[int]`) — The maximum number of instances of this metadata object type allowed in a submission. If None, there is no upper limit to the number of instances.
- `mandatory_fields_schemas` (`list[FieldRepresentation]`) — List of field schemas that are required for this metadata object type. These fields must be provided for the submission to be valid.
- `recommended_fields_schemas` (`list[FieldRepresentation]`) — List of field schemas that are recommended but not required for this metadata object type. These fields should be provided when possible but their absence won't invalidate the submission.
- `optional_fields_schemas` (`list[FieldRepresentation]`) — List of field schemas that are optional for this metadata object type. These fields can be provided but are not required or recommended.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L837-899)

### plugins_api.dtos.MetadataObjectType.additional_information

*attribute* · *class attribute* · *instance attribute*

```python
additional_information: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L893-893)

### plugins_api.dtos.MetadataObjectType.description

*attribute* · *instance attribute*

```python
description: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L892-892)

### plugins_api.dtos.MetadataObjectType.mandatory_fields_schemas

*attribute* · *instance attribute*

```python
mandatory_fields_schemas: list[FieldRepresentation]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L897-897)

### plugins_api.dtos.MetadataObjectType.maximal_occurrence

*attribute* · *class attribute* · *instance attribute*

```python
maximal_occurrence: int | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L896-896)

### plugins_api.dtos.MetadataObjectType.minimal_occurrence

*attribute* · *instance attribute*

```python
minimal_occurrence: int
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L895-895)

### plugins_api.dtos.MetadataObjectType.name

*attribute* · *instance attribute*

```python
name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L888-888)

### plugins_api.dtos.MetadataObjectType.optional_fields_schemas

*attribute* · *instance attribute*

```python
optional_fields_schemas: list[FieldRepresentation]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L899-899)

### plugins_api.dtos.MetadataObjectType.priority

*attribute* · *instance attribute*

```python
priority: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L891-891)

### plugins_api.dtos.MetadataObjectType.recommended_fields_schemas

*attribute* · *instance attribute*

```python
recommended_fields_schemas: list[FieldRepresentation]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L898-898)

### plugins_api.dtos.MetadataObjectType.show_additional_information_on_data_tab

*attribute* · *class attribute* · *instance attribute*

```python
show_additional_information_on_data_tab: bool = False
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L894-894)

### plugins_api.dtos.MetadataObjectType.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L889-889)

### plugins_api.dtos.MetadataObjectType.summary_fields

*attribute* · *instance attribute*

```python
summary_fields: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L890-890)

## plugins_api.dtos.MetadataValue

*class*

```python
class MetadataValue(BaseModel)
```

Bases: `BaseModel`

DTO for a metadata value.

**Attributes**

- `value` (`(Any, optional)`) — The value. Must match the field's JSON schema. None means that the value is not set.
- `source_id` (`(UUID, optional)`) — Madbot ``Metadata`` record UUID this value comes from. Plugins building values should leave this ``None``.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L160-177)

### plugins_api.dtos.MetadataValue.source_id

*attribute* · *class attribute* · *instance attribute*

```python
source_id: UUID | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L174-174)

### plugins_api.dtos.MetadataValue.value

*attribute* · *class attribute* · *instance attribute*

```python
value: Any | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L173-173)

## plugins_api.dtos.PluginDataAssociation

*class*

```python
class PluginDataAssociation(BaseModel)
```

Bases: `BaseModel`

DTO representing a data association returned by data plugins.

A data association represents a relationship between multiple data objects.
Each association contains a list of external_id values that should be grouped
together in a single DataAssociation in madbot, and optionally metadata that
should be attached to the association.

**Attributes**

- `associated_external_ids` (`list[str]`) — List of external_id values for data objects that should be associated together.
- `metadata` (`(list[PluginMetadata], optional)`) — List of metadata that should be attached to the DataAssociation. Defaults to empty list if not provided.

> **Notes**
>
> Plugins should return associations bidirectionally - if data object A is associated
> with data objects B and C in association group 1, then when querying A, B, or C,
> they should all return the same association group containing [A, B, C].

**Examples**

If data objects A, B, and C should be associated together:

```pycon
>>> PluginDataAssociation(associated_external_ids=["A", "B", "C"])
```

If data object A has two separate associations (one with B, one with C):

```pycon
>>> [
...     PluginDataAssociation(associated_external_ids=["A", "B"]),
...     PluginDataAssociation(associated_external_ids=["A", "C"]),
... ]
```

With metadata:

```pycon
>>> PluginDataAssociation(
...     associated_external_ids=["B", "C"],
...     metadata=[
...         PluginMetadata(
...             field=MetadataFieldID(slug="association_type", source="referential", name="Association Type"),
...             value=MetadataValue(value="paired")
...         )
...     ]
... )
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1031-1079)

### plugins_api.dtos.PluginDataAssociation.associated_external_ids

*attribute* · *instance attribute*

```python
associated_external_ids: list[str]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1078-1078)

### plugins_api.dtos.PluginDataAssociation.metadata

*attribute* · *class attribute* · *instance attribute*

```python
metadata: list[PluginMetadata] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1079-1079)

## plugins_api.dtos.PluginDataObject

*class*

```python
class PluginDataObject(BaseModel)
```

Bases: `BaseModel`

DTO for an external data object returned by a data plugin.

**Attributes**

- `id` (`str`) — Stable identifier in the external system. Becomes madbot ``external_id``.
- `name` (`str`) — Display name.
- `type` (`(str, optional)`) — Free-form kind of object (e.g. ``"file"``, ``"directory"``, ``"project"``).
- `description` (`(str, optional)`) — Human-readable description, or None.
- `media_type` (`(str, optional)`) — MIME type (e.g. ``"application/gzip"``), or None.
- `file_extension` (`(str, optional)`) — Extension without the leading dot (e.g. ``"fastq"`` or ``"fastq.gz"``), or None.
- `size` (`(int, optional)`) — Size in bytes, or None.
- `icon` (`(str, optional)`) — Nerd Font class from ``get_icon()`` (e.g. ``"nf nf-fa-folder"``), or None.
- `has_children` (`bool`) — True if ``get_data_objects(this id)`` will return items.
- `linkable` (`bool`) — Whether the object can be linked into a madbot node.
- `children` (`list[PluginDataObject]`) — List of child external data objects. Defaults to None.
- `accesses` (`list[ExternalAccess]`) — Ways to open or download the object.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1082-1151)

### plugins_api.dtos.PluginDataObject.accesses

*attribute* · *class attribute* · *instance attribute*

```python
accesses: list[ExternalAccess] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1126-1126)

### plugins_api.dtos.PluginDataObject.children

*attribute* · *class attribute* · *instance attribute*

```python
children: list[PluginDataObject] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1125-1125)

### plugins_api.dtos.PluginDataObject.description

*attribute* · *class attribute* · *instance attribute*

```python
description: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1118-1118)

### plugins_api.dtos.PluginDataObject.file_extension

*attribute* · *class attribute* · *instance attribute*

```python
file_extension: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1120-1120)

### plugins_api.dtos.PluginDataObject.has_children

*attribute* · *class attribute* · *instance attribute*

```python
has_children: bool = False
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1123-1123)

### plugins_api.dtos.PluginDataObject.icon

*attribute* · *class attribute* · *instance attribute*

```python
icon: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1122-1122)

### plugins_api.dtos.PluginDataObject.id

*attribute* · *instance attribute*

```python
id: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1115-1115)

### plugins_api.dtos.PluginDataObject.linkable

*attribute* · *class attribute* · *instance attribute*

```python
linkable: bool = False
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1124-1124)

### plugins_api.dtos.PluginDataObject.media_type

*attribute* · *class attribute* · *instance attribute*

```python
media_type: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1119-1119)

### plugins_api.dtos.PluginDataObject.name

*attribute* · *instance attribute*

```python
name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1116-1116)

### plugins_api.dtos.PluginDataObject.size

*attribute* · *class attribute* · *instance attribute*

```python
size: int | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1121-1121)

### plugins_api.dtos.PluginDataObject.type

*attribute* · *class attribute* · *instance attribute*

```python
type: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1117-1117)

### plugins_api.dtos.PluginDataObject.add_external_access

*method*

```python
def add_external_access(access_type: AccessType, access_details: str) -> None
```

Add external access information to the data object.

**Parameters**

- `access_type` (`AccessType`) — The type of access being added (must be one of the supported access types).
- `access_details` (`str`) — The access details to be associated with the specified access type. For ``AccessType.URL``: a URL. For ``AccessType.SHELL``: a command.

**Raises**

- `ValueError` — If the provided access_type is not supported.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1128-1151)

## plugins_api.dtos.PluginMetadata

*class*

```python
class PluginMetadata(BaseModel)
```

Bases: `BaseModel`

DTO for metadata returned by a plugin.

**Attributes**

- `field` (`MetadataFieldID`) — Field this value belongs to.
- `value` (`(MetadataValue, optional)`) — The value.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L285-298)

### plugins_api.dtos.PluginMetadata.field

*attribute* · *instance attribute*

```python
field: MetadataFieldID
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L297-297)

### plugins_api.dtos.PluginMetadata.value

*attribute* · *class attribute* · *instance attribute*

```python
value: MetadataValue | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L298-298)

## plugins_api.dtos.PluginStatus

*class*

```python
class PluginStatus(StrEnum)
```

Bases: `StrEnum`

Maturity status of a plugin for a given capability type.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L71-75)

### plugins_api.dtos.PluginStatus.PREVIEW

*attribute* · *class attribute* · *instance attribute*

```python
PREVIEW = 'preview'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L74-74)

### plugins_api.dtos.PluginStatus.STABLE

*attribute* · *class attribute* · *instance attribute*

```python
STABLE = 'stable'
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L75-75)

## plugins_api.dtos.SchemaRepresentation

*class*

```python
class SchemaRepresentation(BaseModel)
```

Bases: `BaseModel`

DTO for the JSON schema of a metadata or connection field.

**Attributes**

- `slug` (`str`) — Field slug. For metadata fields: ``plugin__field`` or ``plugin__mot__field``.
- `schema_content` (`dict[str, Any]`) — JSON Schema. ``originalTitle`` is read by madbot core as the original field name when ``title`` is a user-friendly label.
- `uischema` (`(dict[str, Any], optional)`) — JSON Forms UI schema, if any.
- `source` (`str`) — Plugin slug.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L624-644)

### plugins_api.dtos.SchemaRepresentation.schema_content

*attribute* · *instance attribute*

```python
schema_content: dict[str, Any]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L642-642)

### plugins_api.dtos.SchemaRepresentation.slug

*attribute* · *instance attribute*

```python
slug: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L641-641)

### plugins_api.dtos.SchemaRepresentation.source

*attribute* · *instance attribute*

```python
source: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L644-644)

### plugins_api.dtos.SchemaRepresentation.uischema

*attribute* · *class attribute* · *instance attribute*

```python
uischema: dict[str, Any] | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L643-643)

## plugins_api.dtos.SettingField

*class*

```python
class SettingField(ConnectionField)
```

Bases: `plugins_api.dtos.ConnectionField`

DTO for a submission setting schema, returned by ``get_settings_fields()``.

The slug must match ``Settings.field`` in the plugin constructor.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L827-834)

### plugins_api.dtos.SettingField.schema_content

*attribute* · *instance attribute*

```python
schema_content: dict[str, Any]
```

Inherited from: `plugins_api.dtos.ConnectionField`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L823-823)

### plugins_api.dtos.SettingField.slug

*attribute* · *instance attribute*

```python
slug: str
```

Inherited from: `plugins_api.dtos.ConnectionField`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L822-822)

### plugins_api.dtos.SettingField.uischema

*attribute* · *class attribute* · *instance attribute*

```python
uischema: dict[str, Any] | None = None
```

Inherited from: `plugins_api.dtos.ConnectionField`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L824-824)

## plugins_api.dtos.Settings

*class*

```python
class Settings(BaseModel)
```

Bases: `BaseModel`

DTO for a submission setting value passed to the plugin constructor.

Distinct from `SettingField`, which describes the setting schema.
Madbot core passes `dict[str, Settings]` keyed by setting slug.

**Attributes**

- `field` (`str`) — Setting slug, matching a `SettingField.slug` from `get_settings_fields()`.
- `setting_value` (`Any`) — User-provided value, validated against that setting's JSON schema.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L18-34)

### plugins_api.dtos.Settings.field

*attribute* · *instance attribute*

```python
field: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L33-33)

### plugins_api.dtos.Settings.setting_value

*attribute* · *instance attribute*

```python
setting_value: Any
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L34-34)

## plugins_api.dtos.Source

*class*

```python
class Source(BaseModel, ABC)
```

Bases: `BaseModel`, `ABC`

Abstract base DTO for a madbot object that is the source of a metadata value.

Do not instantiate this class. Use ``SourceData``, ``SourceNode``,
``SourceSample``, or ``SourceAssociationData``.

**Attributes**

- `madbot_id` (`UUID`) — Madbot identifier of the source object.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L346-367)

### plugins_api.dtos.Source.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L359-359)

### plugins_api.dtos.Source.model_post_init

*method*

```python
def model_post_init(__context: Any) -> None
```

Reject direct instantiation of the abstract base.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L361-367)

## plugins_api.dtos.SourceAssociationData

*class*

```python
class SourceAssociationData(Source)
```

Bases: `plugins_api.dtos.Source`

DTO for a data association that is the source of a metadata value.

**Attributes**

- `source_data` (`list[SourceData]`) — Data objects in the association.
- `metadata` (`list[MadbotMetadata]`) — Metadata attached to the association.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L461-474)

### plugins_api.dtos.SourceAssociationData.metadata

*attribute* · *class attribute* · *instance attribute*

```python
metadata: list[MadbotMetadata] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L474-474)

### plugins_api.dtos.SourceAssociationData.source_data

*attribute* · *instance attribute*

```python
source_data: list[SourceData]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L473-473)

### plugins_api.dtos.SourceAssociationData.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

Inherited from: `plugins_api.dtos.Source`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L359-359)

### plugins_api.dtos.SourceAssociationData.model_post_init

*method*

```python
def model_post_init(__context: Any) -> None
```

Inherited from: `plugins_api.dtos.Source`

Reject direct instantiation of the abstract base.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L361-367)

## plugins_api.dtos.SourceData

*class*

```python
class SourceData(Source)
```

Bases: `plugins_api.dtos.Source`

DTO for a madbot data object that is the source of a metadata value.

**Attributes**

- `name` (`str`) — Display name of the data object.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L370-380)

### plugins_api.dtos.SourceData.name

*attribute* · *instance attribute*

```python
name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L380-380)

### plugins_api.dtos.SourceData.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

Inherited from: `plugins_api.dtos.Source`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L359-359)

### plugins_api.dtos.SourceData.model_post_init

*method*

```python
def model_post_init(__context: Any) -> None
```

Inherited from: `plugins_api.dtos.Source`

Reject direct instantiation of the abstract base.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L361-367)

## plugins_api.dtos.SourceNode

*class*

```python
class SourceNode(Source)
```

Bases: `plugins_api.dtos.Source`

DTO for a madbot node that is the source of a metadata value.

**Attributes**

- `title` (`str`) — Node title.
- `description` (`(str, optional)`) — Node description as a JSON string of EditorJS content.
- `parent` (`(SourceNode, optional)`) — Parent node, or None for a root node.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L383-442)

### plugins_api.dtos.SourceNode.description

*attribute* · *class attribute* · *instance attribute*

```python
description: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L398-398)

### plugins_api.dtos.SourceNode.parent

*attribute* · *class attribute* · *instance attribute*

```python
parent: Optional[SourceNode] = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L399-399)

### plugins_api.dtos.SourceNode.title

*attribute* · *instance attribute*

```python
title: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L397-397)

### plugins_api.dtos.SourceNode.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

Inherited from: `plugins_api.dtos.Source`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L359-359)

### plugins_api.dtos.SourceNode.from_node

*method* · *classmethod*

```python
def from_node(values: Any) -> Any
```

Convert a generic node object into a SourceNode.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L401-425)

### plugins_api.dtos.SourceNode.get_ancestors

*method*

```python
def get_ancestors() -> list[SourceNode]
```

Get all ancestors of this node, from root to the node itself.

**Returns**

- (`List[SourceNode]`) — List of ancestors, ordered from root to this node

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L427-442)

### plugins_api.dtos.SourceNode.model_post_init

*method*

```python
def model_post_init(__context: Any) -> None
```

Inherited from: `plugins_api.dtos.Source`

Reject direct instantiation of the abstract base.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L361-367)

## plugins_api.dtos.SourceSample

*class*

```python
class SourceSample(Source)
```

Bases: `plugins_api.dtos.Source`

DTO for a madbot sample that is the source of a metadata value.

**Attributes**

- `title` (`str`) — Sample title.
- `alias` (`str`) — Sample alias.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L445-458)

### plugins_api.dtos.SourceSample.alias

*attribute* · *instance attribute*

```python
alias: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L458-458)

### plugins_api.dtos.SourceSample.title

*attribute* · *instance attribute*

```python
title: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L457-457)

### plugins_api.dtos.SourceSample.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

Inherited from: `plugins_api.dtos.Source`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L359-359)

### plugins_api.dtos.SourceSample.model_post_init

*method*

```python
def model_post_init(__context: Any) -> None
```

Inherited from: `plugins_api.dtos.Source`

Reject direct instantiation of the abstract base.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L361-367)

## plugins_api.dtos.Submission

*class*

```python
class Submission(BaseModel)
```

Bases: `BaseModel`

DTO for a submission.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L46-52)

### plugins_api.dtos.Submission.id

*attribute* · *class attribute* · *instance attribute*

```python
id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L49-49)

### plugins_api.dtos.Submission.members

*attribute* · *instance attribute*

```python
members: list[SubmissionMember]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L52-52)

### plugins_api.dtos.Submission.status

*attribute* · *instance attribute*

```python
status: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L51-51)

### plugins_api.dtos.Submission.title

*attribute* · *instance attribute*

```python
title: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L50-50)

## plugins_api.dtos.SubmissionAssociation

*class*

```python
class SubmissionAssociation(BaseModel)
```

Bases: `BaseModel`

DTO representing an association (a group of related objects).

**Attributes**

- `id` (`UUID`) — Unique identifier for the association.
- `submission_id` (`UUID`) — Identifier of the submission to which this association belongs.
- `association_name` (`str`) — Descriptive name for the association, indicating the kind of relationship between objects (free-form, e.g. ``"paired_end"``).
- `objects` (`list[SubmissionAssociationObject]`) — List of objects participating in the association. Each object may have a role (source/target) and can be either a metadata object or a data object.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L977-1004)

### plugins_api.dtos.SubmissionAssociation.association_name

*attribute* · *instance attribute*

```python
association_name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1000-1000)

### plugins_api.dtos.SubmissionAssociation.id

*attribute* · *class attribute* · *instance attribute*

```python
id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L998-998)

### plugins_api.dtos.SubmissionAssociation.objects

*attribute* · *instance attribute*

```python
objects: list[SubmissionAssociationObject]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L1001-1001)

### plugins_api.dtos.SubmissionAssociation.submission_id

*attribute* · *instance attribute*

```python
submission_id: UUID
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L999-999)

## plugins_api.dtos.SubmissionAssociationObject

*class*

```python
class SubmissionAssociationObject(BaseModel)
```

Bases: `BaseModel`

DTO representing an object within a submission association.

**Attributes**

- `id` (`UUID`) — Unique identifier for the association object.
- `role` (`Optional[AssociationRole]`) — Role of this object in the association. - "source": object initiating the association - "target": object receiving the association - None: neutral, undirected membership (no orientation)
- `object` (`MadbotMetadataObject or SubmissionData or MetadataObject`) — The actual object participating in the association. Can be either: - a metadata object (incoming ``MadbotMetadataObject`` or outgoing ``MetadataObject``) - a data object (`SubmissionData`)

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L947-974)

### plugins_api.dtos.SubmissionAssociationObject.id

*attribute* · *instance attribute*

```python
id: UUID
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L969-969)

### plugins_api.dtos.SubmissionAssociationObject.object

*attribute* · *instance attribute*

```python
object: Union[MadbotMetadataObject, SubmissionData, MetadataObject]
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L971-971)

### plugins_api.dtos.SubmissionAssociationObject.role

*attribute* · *class attribute* · *instance attribute*

```python
role: AssociationRole | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L970-970)

## plugins_api.dtos.SubmissionData

*class*

```python
class SubmissionData(BaseModel)
```

Bases: `BaseModel`

DTO for a data object included in a submission, provided by madbot core.

**Attributes**

- `filename` (`str`) — File name as stored in madbot.
- `size` (`int`) — File size in bytes.
- `madbot_id` (`UUID`) — Identifier of the submission-data row (not the Data object).
- `data_madbot_id` (`UUID`) — Identifier of the Data object.
- `parent_node` (`(SourceNode, optional)`) — Node the data is linked to.
- `path` (`(str, optional)`) — Local path of the file, if already downloaded.
- `md5_hash` (`(str, optional)`) — MD5 checksum of the file.
- `file_type` (`(str, optional)`) — File type / extension.
- `metadata` (`list[MadbotMetadata]`) — Metadata attached to this data object.
- `data_associations` (`list[SourceAssociationData]`) — Associations this data object belongs to.
- `bound_samples` (`list[dict]`) — Samples bound to this data. Each dict has ``id`` (UUID string), ``title`` (str), and ``alias`` (str or None).

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L514-621)

### plugins_api.dtos.SubmissionData.bound_samples

*attribute* · *class attribute* · *instance attribute*

```python
bound_samples: list[dict] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L555-555)

### plugins_api.dtos.SubmissionData.data_associations

*attribute* · *class attribute* · *instance attribute*

```python
data_associations: list[SourceAssociationData] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L554-554)

### plugins_api.dtos.SubmissionData.data_madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
data_madbot_id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L548-548)

### plugins_api.dtos.SubmissionData.file_type

*attribute* · *class attribute* · *instance attribute*

```python
file_type: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L552-552)

### plugins_api.dtos.SubmissionData.filename

*attribute* · *instance attribute*

```python
filename: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L545-545)

### plugins_api.dtos.SubmissionData.madbot_id

*attribute* · *class attribute* · *instance attribute*

```python
madbot_id: UUID = Field(default_factory=uuid4)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L547-547)

### plugins_api.dtos.SubmissionData.md5_hash

*attribute* · *class attribute* · *instance attribute*

```python
md5_hash: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L551-551)

### plugins_api.dtos.SubmissionData.metadata

*attribute* · *class attribute* · *instance attribute*

```python
metadata: list[MadbotMetadata] = []
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L553-553)

### plugins_api.dtos.SubmissionData.parent_node

*attribute* · *class attribute* · *instance attribute*

```python
parent_node: SourceNode | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L549-549)

### plugins_api.dtos.SubmissionData.path

*attribute* · *class attribute* · *instance attribute*

```python
path: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L550-550)

### plugins_api.dtos.SubmissionData.size

*attribute* · *instance attribute*

```python
size: int
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L546-546)

### plugins_api.dtos.SubmissionData.find_last_common_ancestor

*method* · *staticmethod*

```python
def find_last_common_ancestor(data_objects: list[SubmissionData]) -> list[SourceNode] | None
```

Find the last common ancestor of multiple data objects.

**Parameters**

- `data_objects` (`List[SubmissionData]`) — List of Data objects to find common ancestor for

**Returns**

- (`Optional[List[SourceNode]]`) — The last common ancestor nodes, or None if no common ancestor exists

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L557-621)

## plugins_api.dtos.SubmissionMember

*class*

```python
class SubmissionMember(BaseModel)
```

Bases: `BaseModel`

DTO for a submission member.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L37-43)

### plugins_api.dtos.SubmissionMember.first_name

*attribute* · *instance attribute*

```python
first_name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L40-40)

### plugins_api.dtos.SubmissionMember.last_name

*attribute* · *instance attribute*

```python
last_name: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L41-41)

### plugins_api.dtos.SubmissionMember.orcid_uri

*attribute* · *class attribute* · *instance attribute*

```python
orcid_uri: str | None = None
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L43-43)

### plugins_api.dtos.SubmissionMember.role

*attribute* · *instance attribute*

```python
role: str
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L42-42)

## plugins_api.dtos.SubmissionMetadataValue

*class*

```python
class SubmissionMetadataValue(MetadataValue)
```

Bases: `plugins_api.dtos.MetadataValue`

DTO for a metadata value on a submission.

Inherits from MetadataValue and adds a list of source submission data IDs.
This allows tracking which submission data objects are associated with each metadata value,
enabling easier management (such as removal) of metadata values when related submission data objects are deleted.

**Attributes**

- `sources_submission_data` (`list[UUID]`) — Submission-data UUIDs this value was derived from. Used by madbot core to drop the value when those data objects are removed.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L180-262)

### plugins_api.dtos.SubmissionMetadataValue.sources_submission_data

*attribute* · *class attribute* · *instance attribute*

```python
sources_submission_data: list[UUID] = Field(default_factory=list)
```

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L195-195)

### plugins_api.dtos.SubmissionMetadataValue.source_id

*attribute* · *class attribute* · *instance attribute*

```python
source_id: UUID | None = None
```

Inherited from: `plugins_api.dtos.MetadataValue`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L174-174)

### plugins_api.dtos.SubmissionMetadataValue.value

*attribute* · *class attribute* · *instance attribute*

```python
value: Any | None = None
```

Inherited from: `plugins_api.dtos.MetadataValue`

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L173-173)

### plugins_api.dtos.SubmissionMetadataValue.add_source_for_all

*method* · *classmethod*

```python
def add_source_for_all(metadata_values: list[SubmissionMetadataValue], source_id: UUID) -> list[SubmissionMetadataValue]
```

Add the same submission data ID to all submission metadata values in the list.

**Parameters**

- `metadata_values` (`List[SubmissionMetadataValue]`) — The list of SubmissionMetadataValue instances.
- `source_id` (`UUID`) — The source ID to add.

**Returns**

- (`List[SubmissionMetadataValue]`) — The list of updated SubmissionMetadataValue instances.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L241-262)

### plugins_api.dtos.SubmissionMetadataValue.add_sources_submission_data

*method*

```python
def add_sources_submission_data(submission_data_ids: UUID | list[UUID]) -> None
```

Add one or more source submission data IDs to the metadata value.

**Parameters**

- `submission_data_ids` (`UUID or List[UUID]`) — The ID(s) of the submission data to add as sources.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L200-216)

### plugins_api.dtos.SubmissionMetadataValue.create_from_metadata_value

*method* · *classmethod*

```python
def create_from_metadata_value(metadata_value: MetadataValue) -> SubmissionMetadataValue
```

Create a SubmissionMetadataValue from a MetadataValue.

**Parameters**

- `metadata_value` (`MetadataValue`) — The MetadataValue to convert.

**Returns**

- (`SubmissionMetadataValue`) — The converted SubmissionMetadataValue instance.

[View source](https://gitlab.com/ifb-elixirfr/madbot/madbot/-/blob/plugins-api-v2.0.1/plugin_api/plugins_api/dtos.py#L218-239)
