Skip to content

Module invenio_rest_api_client.models.metadata

Variables

T

TYPE_CHECKING

Classes

Metadata

class Metadata(
    resource_type: 'ResourceType',
    title: str,
    publication_date: datetime.date,
    creators: list['Creator'],
    publisher: str,
    additional_titles: invenio_rest_api_client.types.Unset | list['AdditionalTitle'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    description: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    additional_descriptions: invenio_rest_api_client.types.Unset | list['AdditionalDescription'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    rights: invenio_rest_api_client.types.Unset | list['Right'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    copyright_: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    contributors: invenio_rest_api_client.types.Unset | list['Creator'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    subjects: invenio_rest_api_client.types.Unset | list['Subject'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    languages: invenio_rest_api_client.types.Unset | list['Lang'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    dates: invenio_rest_api_client.types.Unset | list['Date'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    version: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifiers: invenio_rest_api_client.types.Unset | list['AlternateIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    related_identifiers: invenio_rest_api_client.types.Unset | list['RelatedIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    sizes: invenio_rest_api_client.types.Unset | list[str] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    formats: invenio_rest_api_client.types.Unset | list[str] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    locations: invenio_rest_api_client.types.Unset | list['Location'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    funding: invenio_rest_api_client.types.Unset | list['Funding'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    references: invenio_rest_api_client.types.Unset | list['Reference'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Metadata schema of bibliographic records in InvenioRDM.

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/reference/metadata/#metadata

Attributes:
    resource_type (ResourceType): The type of the resource described by the record.
    title (str): A primary name or primary title by which a resource is known.
    publication_date (datetime.date): The date when the resource was or will be made publicly available.
    creators (list['Creator']): The creators field registers those persons or organisations that should be credited
        for the resource described by the record.
    publisher (str): The name of the entity that holds, archives, publishes, prints, distributes, releases, issues,
        or produces the resource.
    additional_titles (Union[Unset, list['AdditionalTitle']]): Additional names or titles by which a resource is
        known
    description (Union[Unset, str]): The description of a record.
    additional_descriptions (Union[Unset, list['AdditionalDescription']]): Additional descriptions in addition to
        the primary description (e.g. abstracts in other languages), methods or further notes.
    rights (Union[Unset, list['Right']]): Rights management statement for the resource.
    copyright_ (Union[Unset, str]): The copyright field allows authors or depositors to specify a copyright
        statement for the record.
    contributors (Union[Unset, list['Creator']]): The organisations or persons responsible for collecting, managing,
        distributing, or otherwise contributing to the development of the resource.
    subjects (Union[Unset, list['Subject']]): Subject, keyword, classification code, or key phrase describing the
        resource.
    languages (Union[Unset, list['Lang']]): The languages of the resource.
    dates (Union[Unset, list['Date']]): Different dates relevant to the resource.
    version (Union[Unset, str]): The version number of the resource.
    identifiers (Union[Unset, list['AlternateIdentifier']]): Persistent identifiers for the resource other than the
        ones registered as system-managed internal or external persistent identifiers.
    related_identifiers (Union[Unset, list['RelatedIdentifier']]): Identifiers of related resources.
    sizes (Union[Unset, list[str]]): Size (e.g. bytes, pages, inches, etc.) or duration (extent), e.g. hours,
        minutes, days, etc., of a resource.
    formats (Union[Unset, list[str]]): Technical format of the resource.
    locations (Union[Unset, list['Location']]): Spatial region or named place where the data was gathered or about
        which the data is focused.
    funding (Union[Unset, list['Funding']]): Information about financial support (funding) for the resource being
        registered.
    references (Union[Unset, list['Reference']]): A list of reference strings.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_descriptions

additional_keys

additional_properties

additional_titles

contributors

copyright_

creators

dates

description

formats

funding

identifiers

languages

locations

publication_date

publisher

references

related_identifiers

resource_type

rights

sizes

subjects

title

version

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]