Metadata Model Documentation - Národní repozitář

Minimal record

The absolute minimum required to create a valid draft:

{
  "parent": {
    "communities": {
      "default": "community_slug"
    }
  },
  "access": {
    "record": "public",
    "files": "public"
  },
  "metadata": {
    "title": "Example title",
    "creators": [
      {
        "person_or_org": {
          "type": "personal",
          "family_name": "Novak"
        }
      }
    ],
    "dateIssued": "2026-07-09",
    "languages": [{"id": "cs"}],
    "resourceType": {"id": "book"}
  }
}

System fields

`parent.communities`

Community assignment. The default key contains the community slug.

{"default": "community_slug"}

`access`

Access control settings.

Field	Values	Notes
`record`	`"public"`	Always `"public"`
`files`	`"public"`, `"restricted"`	Must be `"restricted"` when `status` is `"embargoed"` or `"restricted"`
`status`	`"open"`, `"embargoed"`, `"restricted"`

When status is "embargoed", include the embargo object:

Embargo field	Type	Notes
`embargo.active`	boolean
`embargo.until`	string	`YYYY-MM-DD`
`embargo.reason`	string or null

{
  "record": "public",
  "files": "restricted",
  "embargo": {
    "active": true,
    "until": "2027-01-01",
    "reason": null
  },
  "status": "embargoed"
}

Metadata fields

All metadata fields live under the top-level metadata key.

`title` (required)

Main title of the resource. String.

"title": "Grey Literature from Archivist's Viewpoint"

`creators` (required)

Array of author/creator objects. Each element has a person_or_org object and optional affiliations.

Personal creator

Field	Required	Notes
`person_or_org.type`	yes	`"personal"`
`person_or_org.family_name`	yes
`person_or_org.given_name`	no
`person_or_org.name`	no	Full name, e.g. `"Novak, Jan"`
`person_or_org.identifiers`	no	Array; schemes: `orcid`, `scopusId`, `researcherId`, `vedidk`
`affiliations`	no	Array of `{"id": "..."}` from `/api/vocabularies/affiliations`

{
  "person_or_org": {
    "type": "personal",
    "name": "Novak, Jan",
    "given_name": "Jan",
    "family_name": "Novak",
    "identifiers": [
      {"identifier": "0000-0001-5384-2656", "scheme": "orcid"},
      {"identifier": "57194547661", "scheme": "scopusId"}
    ]
  },
  "affiliations": [
    {"id": "ntk"}
  ]
}

Organizational creator

Field	Required	Notes
`person_or_org.type`	yes	`"organizational"`
`person_or_org.name`	yes	Organization name
`person_or_org.identifiers`	no	Array; schemes: `ico`, `ror`, `url`

{
  "person_or_org": {
    "type": "organizational",
    "name": "Národní technická knihovna",
    "identifiers": [
      {"identifier": "61387142", "scheme": "ico"},
      {"identifier": "028txef36", "scheme": "ror"},
      {"identifier": "http://techlib.cz/", "scheme": "url"}
    ]
  }
}

`dateIssued` (required)

Publication date. Accepted formats: YYYY-MM-DD, YYYY-MM, YYYY.

"dateIssued": "2026-07-09"

`languages` (required)

Array of language objects. The first entry is used for DOI requests. Values come from /api/vocabularies/languages.

"languages": [{"id": "cs"}]

`resourceType` (required)

Type of resource. Values come from /api/vocabularies/resource-types (only entries with props.submission = true).

"resourceType": {"id": "book"}

`abstract` (optional)

Array of abstract objects in multiple languages. The value field supports HTML.

Field	Required	Notes
`lang`	yes	Language code
`value`	yes	Abstract text (HTML allowed)

"abstract": [
  {
    "lang": "cs",
    "value": "<p>Úvodní odstavec s <strong>tučným textem</strong>.</p>"
  },
  {
    "lang": "en",
    "value": "<p>Introductory paragraph with <strong>bold text</strong>.</p>"
  }
]

`additionalTitles` (optional)

Alternative, translated, or subtitle variants.

Field	Required	Notes
`title.lang`	yes	Language code
`title.value`	yes	Title text
`titleType`	yes	One of: `alternativeTitle`, `translatedTitle`, `subtitle`, `other`

"additionalTitles": [
  {
    "title": {"lang": "cs", "value": "podnázev"},
    "titleType": "subtitle"
  },
  {
    "title": {"lang": "en", "value": "DOI life cycle"},
    "titleType": "translatedTitle"
  }
]

`contributors` (optional)

Contributors other than creators (editors, data managers, etc.). Same structure as creators, plus a required role field. Role values come from /api/vocabularies/contributor-types.

{
  "person_or_org": {
    "type": "personal",
    "name": "Novák, Jan",
    "given_name": "Jan",
    "family_name": "Novák",
    "identifiers": [
      {"identifier": "57194547661", "scheme": "scopusId"}
    ]
  },
  "role": {"id": "data-manager"},
  "affiliations": [{"id": "amu"}]
}

`subjects` (optional)

Keywords/subjects, optionally tied to a controlled vocabulary.

Field	Required	Notes
`subject`	yes	Array of `{lang, value}` objects
`subjectScheme`	no	External vocabulary identifier (e.g. `"czenas"`)

Multiple language variants can sit within a single subject object.

"subjects": [
  {
    "subject": [{"lang": "cs", "value": "umělecké předměty"}],
    "subjectScheme": "czenas"
  },
  {
    "subject": [
      {"lang": "cs", "value": "záznam"},
      {"lang": "en", "value": "record"}
    ]
  },
  {
    "subject": [{"lang": "en", "value": "identifier"}]
  }
]

`series` (optional)

Series information.

Field	Required	Notes
`seriesTitle`	yes	Series name
`seriesVolume`	no	Volume designation

"series": [
  {"seriesTitle": "Název edice", "seriesVolume": "3"}
]

`externalLocation` (optional)

URL to an external resource location.

Field	Required	Notes
`externalLocationURL`	yes	Full URL
`externalLocationNote`	no	Description or note

"externalLocation": {
  "externalLocationURL": "https://repozitar.techlib.cz/entities/publication/a7ade0c2-2b88-4155-8c11-f16846c00d4c",
  "externalLocationNote": "Záznam v institucionálním repozitáři"
}

`objectIdentifiers` (optional)

Persistent identifiers for the resource.

Field	Required	Notes
`scheme`	yes	`DOI`, `Handle`, `ISSN`, `RIV`, `ISBN`
`identifier`	yes	Identifier value

DOI and Handle accept either a full URL or just prefix/id. ISBN is validated (10 or 13 digits with a matching check digit).

"objectIdentifiers": [
  {"scheme": "DOI", "identifier": "10.1234/abcd-1234"},
  {"scheme": "ISSN", "identifier": "1111-1111"},
  {"scheme": "ISBN", "identifier": "978-80-256-0048-1"}
]

`relatedItems` (optional)

Related resources — host publications, datasets, etc.

Required fields:

Field	Required	Notes
`itemTitle`	yes	Title of related item

Required for DOI requests:

Field	Notes
`itemResourceType.id`	From `/api/vocabularies/resource-types`
`itemRelationType.id`	From `/api/vocabularies/item-relation-types`

Optional fields:

Field	Type	Notes
`itemCreators`	array	Same structure as `creators`
`itemContributors`	array	Same structure as `contributors`
`itemPIDs`	array	Same structure as `objectIdentifiers`
`itemPublisher`	string	Publisher name
`itemYear`	integer	Publication year
`itemVolume`	string	Volume number
`itemIssue`	string	Issue number
`itemStartPage`	string	Starting page
`itemEndPage`	string	Ending page
`itemURL`	string	URL to the related item

"relatedItems": [
  {
    "itemTitle": "Související zdroj",
    "itemResourceType": {"id": "datasets"},
    "itemRelationType": {"id": "isRequiredBy"},
    "itemCreators": [
      {
        "person_or_org": {
          "type": "personal",
          "name": "Novák, Jan",
          "given_name": "Jan",
          "family_name": "Novák",
          "identifiers": [
            {"identifier": "0000-0001-5384-2656", "scheme": "orcid"},
            {"identifier": "57194547661", "scheme": "scopusId"}
          ]
        },
        "affiliations": [{"id": "ror:0285prp25"}]
      }
    ],
    "itemContributors": [
      {
        "person_or_org": {
          "type": "personal",
          "name": "Nováková, Jana",
          "given_name": "Jana",
          "family_name": "Nováková",
          "identifiers": [
            {"identifier": "0000-0002-5664-0109", "scheme": "orcid"}
          ]
        },
        "role": {"id": "editor"},
        "affiliations": [{"id": "ntm"}]
      }
    ],
    "itemPIDs": [
      {"scheme": "DOI", "identifier": "10.1234/5678"},
      {"scheme": "ISSN", "identifier": "1111-1111"}
    ],
    "itemPublisher": "ntk",
    "itemYear": 1997,
    "itemVolume": "1",
    "itemIssue": "10",
    "itemStartPage": "20",
    "itemEndPage": "30",
    "itemURL": "https://neco.cz"
  }
]

`subjectCategories` (optional)

Frascati/Ford classification, used for submitting results to RIV (Czech R&D IS). Values come from /api/vocabularies/subject-categories.

"subjectCategories": [
  {"id": "30307"},
  {"id": "30100"}
]

`events` (optional)

Conferences, workshops, and other events related to the resource.

Field	Required	Notes
`eventNameOriginal`	yes	Original event name
`eventDate`	yes	`YYYY-MM-DD` or `YYYY-MM-DD/YYYY-MM-DD`
`eventLocation.place`	yes	Venue / city
`eventNameAlternate`	no	Array of alternate names
`eventLocation.country.id`	no	From `/api/vocabularies/countries`

"events": [
  {
    "eventNameOriginal": "International Conference on Data Science 2024",
    "eventNameAlternate": ["ICDS 2024", "Data Science Conference"],
    "eventDate": "2024-09-15/2024-09-18",
    "eventLocation": {
      "country": {"id": "CZ"},
      "place": "Prague"
    }
  }
]

`funders` (optional)

Funding sources and grant/award information.

Field	Required	Notes
`funder.id`	yes	From `/api/vocabularies/funders`
`award.id`	no	From `/api/vocabularies/awards`
`award.number`	no	Grant number (required if `award.id` is absent)
`award.title`	no	Object `{lang: title}` (required if `award.id` is absent)

When an award is present but not identified by award.id, both award.number and award.title are required.

"funders": [
  {
    "funder": {"id": "MSM"},
    "award": {"id": "isvavai:MSM1486434701"}
  },
  {
    "funder": {"id": "KHP"},
    "award": {
      "number": "IP DKRVO",
      "title": {
        "cs": "nějaký grant",
        "en": "some grant"
      }
    }
  }
]

`notes` (optional)

Array of strings — additional notes or comments.

"notes": [
  "Data dostupná na vyžádání",
  "Další poznámka k záznamu"
]

`rights` (optional)

License/rights information. Values come from /api/vocabularies/rights.

"rights": {"id": "CC-BY-ND-4.0"}

`publishers` (optional, required for DOI)

Array of publisher names. When requesting DOI, only the first publisher is used in DOI metadata — put the primary publisher first.

"publishers": [
  "Národní technická knihovna",
  "Springer Nature"
]

`thesis` (optional)

Thesis-related metadata. This field is primarily intended for harvested records (harvests). All sub-fields are optional.

Field	Type	Notes
`dateDefended`	string	Date of thesis defence; accepted formats: `YYYY-MM-DD`, `YYYY-MM`, `YYYY`
`defended`	boolean	Whether the thesis was successfully defended
`degreeGrantors`	array	Degree-granting institutions; IDs from `/api/vocabularies/degree-grantors`
`studyFields`	array	Array of study field names (strings)

"thesis": {
  "dateDefended": "2023-06-15",
  "defended": true,
  "degreeGrantors": [
    {"id": "amu-hamu"}
  ],
  "studyFields": [
    "Informační studia a knihovnictví",
    "Počítačová věda"
  ]
}

DOI requirements

When requesting DOI assignment, extra fields become mandatory:

publishers — at least one; the first entry is used in DOI metadata
relatedItems[].itemResourceType and relatedItems[].itemRelationType — required for each related item

Vocabulary endpoints — quick reference

Dictionary fields reference values from internal vocabularies. Use these endpoints to list available values:

Vocabulary	Endpoint
Affiliations	`/api/vocabularies/affiliations`
Languages	`/api/vocabularies/languages`
Resource types	`/api/vocabularies/resource-types`
Contributor types	`/api/vocabularies/contributor-types`
Subject categories	`/api/vocabularies/subject-categories`
Countries	`/api/vocabularies/countries`
Funders	`/api/vocabularies/funders`
Awards	`/api/vocabularies/awards`
Item relation types	`/api/vocabularies/item-relation-types`
Rights / licenses	`/api/vocabularies/rights`
Degree grantors	`/api/vocabularies/degree-grantors`

Identifier schemes — quick reference

Context	Allowed schemes
Personal creator / contributor	`orcid`, `scopusId`, `researcherId`, `vedidk`
Organizational creator / contributor	`ico`, `ror`, `url`
Object identifiers	`DOI`, `Handle`, `ISSN`, `RIV`, `ISBN`

Minimal record

System fields

parent.communities

access

Metadata fields

title (required)

creators (required)

Personal creator

Organizational creator

dateIssued (required)

languages (required)

resourceType (required)

abstract (optional)

additionalTitles (optional)

contributors (optional)

subjects (optional)

series (optional)

externalLocation (optional)

objectIdentifiers (optional)

relatedItems (optional)

subjectCategories (optional)

events (optional)

funders (optional)

notes (optional)

rights (optional)

publishers (optional, required for DOI)

thesis (optional)