Schema Docs
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/DataCiteMetadata_4_6 |
Description: DataCite Metadata Schema
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + data |
No |
object |
No |
In #/$defs/Data |
TODO |
1. Property root > data
|
|
| Type |
object |
| Required |
Yes |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Data |
Description: TODO
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + id |
No |
string |
No |
- |
- |
| + type |
No |
string |
No |
- |
- |
| - attributes |
No |
object |
No |
In #/$defs/DataCiteAttributes |
DataCite Metadata Schema |
1.1. Property root > data > id
1.2. Property root > data > type
|
|
| Type |
string |
| Required |
Yes |
| Default |
"dois" |
1.3. Property root > data > attributes
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/DataCiteAttributes |
Description: DataCite Metadata Schema
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| - doi |
No |
string |
No |
- |
The full DOI (prefix + suffix) |
| - prefix |
No |
string |
No |
- |
The namespace prefix |
| - suffix |
No |
string |
No |
- |
The suffix portion of the DOI |
| - event |
No |
enum (of string) |
No |
- |
Indicates a state-change action for the DOI |
| + identifiers |
No |
array |
No |
- |
- |
| + creators |
No |
array |
No |
- |
The main researchers involved in producing the data, or the authors of the publication, in priority order. |
| + titles |
No |
array |
No |
- |
Names or titles by which a resource is known. May be the title of a dataset or the name of a piece of software or an instrument. |
| + publisher |
No |
object |
No |
In #/$defs/Publisher |
The name of the entity that holds, archives, publishes, prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role. |
| + publicationYear |
No |
object |
No |
In #/$defs/PublicationYear |
The year when the data was or will be made publicly available. |
| - subjects |
No |
array |
No |
- |
Subjects, keywords, classification codes, or key phrases describing the resource. |
| - contributors |
No |
array |
No |
- |
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource. |
| - dates |
No |
array |
No |
- |
Different dates relevant to the work. |
| - language |
No |
string |
No |
- |
The primary language of the resource |
| + types |
No |
object |
No |
In #/$defs/ResourceType |
A description of the resource. |
| - alternateIdentifiers |
No |
array |
No |
- |
An identifier other than the primary Identifier applied to the resource being registered. |
| - relatedIdentifiers |
No |
array |
No |
- |
Identifiers of related resources. |
| - sizes |
No |
array of string |
No |
- |
Size (e.g., bytes, pages, inches, etc.) or duration (extent), e.g., hours, minutes, days, etc., of a resource. |
| - formats |
No |
array of string |
No |
- |
Technical format of the resources. |
| - version |
No |
string |
No |
- |
The version number of the resources. |
| - rightsList |
No |
array |
No |
- |
Any rights information for this resource |
| - descriptions |
No |
array |
No |
- |
- |
| - geoLocations |
No |
array |
No |
- |
Spatial regions or named places where the data was gathered or about which the data is focused. |
| - fundingReferences |
No |
array |
No |
- |
Information about financial support (funding) for the resource being registered. |
| - relatedItems |
No |
array |
No |
- |
Informations about a resource related to the one being registered. |
1.3.1. Property root > data > attributes > doi
Description: The full DOI (prefix + suffix)
1.3.2. Property root > data > attributes > prefix
Description: The namespace prefix
1.3.3. Property root > data > attributes > suffix
Description: The suffix portion of the DOI
1.3.4. Property root > data > attributes > event
|
|
| Type |
enum (of string) |
| Required |
No |
Description: Indicates a state-change action for the DOI
Must be one of:
* "publish"
* "register"
* "hide"
1.3.5. Property root > data > attributes > identifiers
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Identifier |
The Identifier is a unique string that identifies a resource. |
1.3.5.1. root > data > attributes > identifiers > Identifier
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Identifier |
Description: The Identifier is a unique string that identifies a resource.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + identifierType |
No |
string |
No |
- |
- |
| + identifier |
No |
string |
No |
- |
- |
1.3.5.1.1. Property root > data > attributes > identifiers > identifiers items > identifierType
|
|
| Type |
string |
| Required |
Yes |
| Default |
"DOI" |
1.3.5.1.2. Property root > data > attributes > identifiers > identifiers items > identifier
1.3.6. Property root > data > attributes > creators
Description: The main researchers involved in producing the data, or the authors of the publication, in priority order.
|
Array restrictions |
| Min items |
1 |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Creator |
The main researcher involved in producing the data, or the author of the publication. |
1.3.6.1. root > data > attributes > creators > Creator
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Creator |
Description: The main researcher involved in producing the data, or the author of the publication.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + name |
No |
string |
No |
- |
The full name of the creator. |
| - nameType |
No |
enum (of string) |
No |
In #/$defs/NameType |
The type of name. |
| - givenName |
No |
string |
No |
- |
The personal or first name of the creator. |
| - familyName |
No |
string |
No |
- |
The surname or last name of the creator. |
| - nameIdentifiers |
No |
array |
No |
- |
Uniquely identifies an individual or legal entity, according to various schemes. |
| - affiliation |
No |
array |
No |
- |
The organizational or institutional affiliations of the creator. |
1.3.6.1.1. Property root > data > attributes > creators > creators items > name
Description: The full name of the creator.
1.3.6.1.2. Property root > data > attributes > creators > creators items > nameType
|
|
| Type |
enum (of string) |
| Required |
No |
| Defined in |
#/$defs/NameType |
Description: The type of name.
Must be one of:
* "Organizational"
* "Personal"
1.3.6.1.3. Property root > data > attributes > creators > creators items > givenName
Description: The personal or first name of the creator.
1.3.6.1.4. Property root > data > attributes > creators > creators items > familyName
Description: The surname or last name of the creator.
1.3.6.1.5. Property root > data > attributes > creators > creators items > nameIdentifiers
Description: Uniquely identifies an individual or legal entity, according to various schemes.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| NameIdentifier |
Uniquely identifies an individual or legal entity, according to various schemes. |
1.3.6.1.5.1. root > data > attributes > creators > creators items > nameIdentifiers > NameIdentifier
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/NameIdentifier |
Description: Uniquely identifies an individual or legal entity, according to various schemes.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| - nameIdentifier |
No |
string |
No |
- |
Uniquely identifies an individual or legal entity, according to various schemes. |
| + nameIdentifierScheme |
No |
string |
No |
- |
The name of the name identifier scheme. |
| - schemeURI |
No |
string |
No |
- |
The URI of the name identifier scheme. |
1.3.6.1.5.1.1. Property root > data > attributes > creators > creators items > nameIdentifiers > nameIdentifiers items > nameIdentifier
Description: Uniquely identifies an individual or legal entity, according to various schemes.
1.3.6.1.5.1.2. Property root > data > attributes > creators > creators items > nameIdentifiers > nameIdentifiers items > nameIdentifierScheme
Description: The name of the name identifier scheme.
1.3.6.1.5.1.3. Property root > data > attributes > creators > creators items > nameIdentifiers > nameIdentifiers items > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the name identifier scheme.
1.3.6.1.6. Property root > data > attributes > creators > creators items > affiliation
Description: The organizational or institutional affiliations of the creator.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Affiliation |
The organizational or institutional affiliation of the creator. |
1.3.6.1.6.1. root > data > attributes > creators > creators items > affiliation > Affiliation
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Affiliation |
Description: The organizational or institutional affiliation of the creator.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| - affiliationIdentifier |
No |
string |
No |
- |
Uniquely identifies the organizational affiliation of the creator. |
| - affiliationIdentifierScheme |
No |
string |
No |
- |
The name of the affiliation identifier scheme |
| - schemeURI |
No |
string |
No |
- |
The URI of the affiliation identifier scheme. |
1.3.6.1.6.1.1. Property root > data > attributes > creators > creators items > affiliation > affiliation items > affiliationIdentifier
Description: Uniquely identifies the organizational affiliation of the creator.
1.3.6.1.6.1.2. Property root > data > attributes > creators > creators items > affiliation > affiliation items > affiliationIdentifierScheme
Description: The name of the affiliation identifier scheme
1.3.6.1.6.1.3. Property root > data > attributes > creators > creators items > affiliation > affiliation items > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the affiliation identifier scheme.
1.3.7. Property root > data > attributes > titles
Description: Names or titles by which a resource is known. May be the title of a dataset or the name of a piece of software or an instrument.
|
Array restrictions |
| Min items |
1 |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Title |
A name or title by which a resource is known. May be the title of a dataset or the name of a piece of software or an instrument. |
1.3.7.1. root > data > attributes > titles > Title
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Title |
Description: A name or title by which a resource is known. May be the title of a dataset or the name of a piece of software or an instrument.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + title |
No |
string |
No |
- |
A name or title by which a resource is known |
| - lang |
No |
string |
No |
- |
The languages of the title. |
| - titleType |
No |
enum (of string) |
No |
- |
The type of Title (other than the Main Title). |
1.3.7.1.1. Property root > data > attributes > titles > titles items > title
Description: A name or title by which a resource is known
1.3.7.1.2. Property root > data > attributes > titles > titles items > lang
Description: The languages of the title.
1.3.7.1.3. Property root > data > attributes > titles > titles items > titleType
|
|
| Type |
enum (of string) |
| Required |
No |
Description: The type of Title (other than the Main Title).
Must be one of:
* "AlternativeTitle"
* "Subtitle"
* "TranslatedTitle"
* "Other"
1.3.8. Property root > data > attributes > publisher
|
|
| Type |
object |
| Required |
Yes |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Publisher |
Description: The name of the entity that holds, archives, publishes, prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + name |
No |
string |
No |
- |
The name of the entity that holds, archives, publishes, prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role. |
| - publisherIdentifier |
No |
string |
No |
- |
Uniquely identifies the publisher, according to various schemes. |
| - publisherIdentifierScheme |
No |
string |
No |
- |
The name of the publisher identifier scheme. |
| - schemeURI |
No |
string |
No |
- |
The URI of the publisher identifier scheme. |
| - lang |
No |
string |
No |
- |
The language used by the Publisher. |
1.3.8.1. Property root > data > attributes > publisher > name
Description: The name of the entity that holds, archives, publishes, prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
1.3.8.2. Property root > data > attributes > publisher > publisherIdentifier
Description: Uniquely identifies the publisher, according to various schemes.
1.3.8.3. Property root > data > attributes > publisher > publisherIdentifierScheme
Description: The name of the publisher identifier scheme.
1.3.8.4. Property root > data > attributes > publisher > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the publisher identifier scheme.
1.3.8.5. Property root > data > attributes > publisher > lang
Description: The language used by the Publisher.
1.3.9. Property root > data > attributes > publicationYear
|
|
| Type |
combining |
| Required |
Yes |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/PublicationYear |
Description: The year when the data was or will be made publicly available.
1.3.9.1. Property root > data > attributes > publicationYear > oneOf > item 0
|
|
| Type |
integer |
| Required |
No |
| Format |
int32 |
1.3.9.2. Property root > data > attributes > publicationYear > oneOf > item 1
| Restrictions |
|
| Must match regular expression |
^\d{4}$ Test |
1.3.10. Property root > data > attributes > subjects
Description: Subjects, keywords, classification codes, or key phrases describing the resource.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Subject |
Subject, keyword, classification code, or key phrase describing the resource. |
1.3.10.1. root > data > attributes > subjects > Subject
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Subject |
Description: Subject, keyword, classification code, or key phrase describing the resource.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + subject |
No |
string |
No |
- |
Subject, keyword, classification code, or key phrase describing the resource. |
| - subjectScheme |
No |
string |
No |
- |
The name of the subject scheme or classification code or authority if one is used. |
| - schemeURI |
No |
string |
No |
- |
The URI of the subject identifier scheme. |
| - valueURI |
No |
string |
No |
- |
The URI of the subject term. |
| - classificationCode |
No |
string |
No |
- |
The classification code used for the subject term in the subject schemes. |
| - lang |
No |
string |
No |
- |
The language used in the Subject. |
1.3.10.1.1. Property root > data > attributes > subjects > subjects items > subject
Description: Subject, keyword, classification code, or key phrase describing the resource.
1.3.10.1.2. Property root > data > attributes > subjects > subjects items > subjectScheme
Description: The name of the subject scheme or classification code or authority if one is used.
1.3.10.1.3. Property root > data > attributes > subjects > subjects items > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the subject identifier scheme.
1.3.10.1.4. Property root > data > attributes > subjects > subjects items > valueURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the subject term.
1.3.10.1.5. Property root > data > attributes > subjects > subjects items > classificationCode
Description: The classification code used for the subject term in the subject schemes.
1.3.10.1.6. Property root > data > attributes > subjects > subjects items > lang
Description: The language used in the Subject.
1.3.11. Property root > data > attributes > contributors
Description: The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Contributor |
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource. |
1.3.11.1. root > data > attributes > contributors > Contributor
|
|
| Type |
combining |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Contributor |
Description: The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
1.3.11.1.1. Property root > data > attributes > contributors > contributors items > allOf > Creator
Description: The main researcher involved in producing the data, or the author of the publication.
1.3.11.1.2. Property root > data > attributes > contributors > contributors items > allOf > item 1
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + contributorType |
No |
enum (of string) |
No |
In #/$defs/ContributorType |
The type of contributor of the resource |
1.3.11.1.2.1. Property root > data > attributes > contributors > contributors items > allOf > item 1 > contributorType
|
|
| Type |
enum (of string) |
| Required |
Yes |
| Defined in |
#/$defs/ContributorType |
Description: The type of contributor of the resource
Must be one of:
* "ContactPerson"
* "DataCollector"
* "DataCurator"
* "DataManager"
* "Distributor"
* "Editor"
* "HostingInstitution"
* "Producer"
* "ProjectLeader"
* "ProjectManager"
* "ProjectMember"
* "RegistrationAgency"
* "RegistrationAuthority"
* "RelatedPerson"
* "Researcher"
* "ResearchGroup"
* "RightsHolder"
* "Sponsor"
* "Supervisor"
* "Translator"
* "WorkPackageLeader"
* "Other"
1.3.12. Property root > data > attributes > dates
Description: Different dates relevant to the work.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Date |
Date relevant to the work. |
1.3.12.1. root > data > attributes > dates > Date
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Date |
Description: Date relevant to the work.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + date |
No |
string |
No |
- |
Date relevant to the work. |
| + dateType |
No |
enum (of string) |
No |
- |
The type of date |
| - dateInformation |
No |
string |
No |
- |
Specific information about the date, if appropriate. |
1.3.12.1.1. Property root > data > attributes > dates > dates items > date
|
|
| Type |
string |
| Required |
Yes |
| Format |
date |
Description: Date relevant to the work.
1.3.12.1.2. Property root > data > attributes > dates > dates items > dateType
|
|
| Type |
enum (of string) |
| Required |
Yes |
Description: The type of date
Must be one of:
* "Accepted"
* "Available"
* "Copyrighted"
* "Collected"
* "Coverage"
* "Created"
* "Issued"
* "Submitted"
* "Updated"
* "Valid"
* "Withdrawn"
* "Other"
Description: Specific information about the date, if appropriate.
1.3.13. Property root > data > attributes > language
Description: The primary language of the resource
1.3.14. Property root > data > attributes > types
|
|
| Type |
object |
| Required |
Yes |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/ResourceType |
Description: A description of the resource.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + resourceType |
No |
string |
No |
- |
A description of the resource. |
| + resourceTypeGeneral |
No |
enum (of string) |
No |
In #/$defs/ResourceTypeGeneral |
The general type of a resource. |
1.3.14.1. Property root > data > attributes > types > resourceType
Description: A description of the resource.
1.3.14.2. Property root > data > attributes > types > resourceTypeGeneral
|
|
| Type |
enum (of string) |
| Required |
Yes |
| Defined in |
#/$defs/ResourceTypeGeneral |
Description: The general type of a resource.
Must be one of:
* "Audiovisual"
* "Award"
* "Book"
* "BookChapter"
* "Collection"
* "ComputationalNotebook"
* "ConferencePaper"
* "ConferenceProceeding"
* "DataPaper"
* "Dataset"
* "Dissertation"
* "Event"
* "Image"
* "InteractiveResource"
* "Instrument"
* "Journal"
* "JournalArticle"
* "Model"
* "OutputManagementPlan"
* "PeerReview"
* "PhysicalObject"
* "Preprint"
* "Project"
* "Report"
* "Service"
* "Software"
* "Sound"
* "Standard"
* "StudyRegistration"
* "Text"
* "Workflow"
* "Other"
1.3.15. Property root > data > attributes > alternateIdentifiers
Description: An identifier other than the primary Identifier applied to the resource being registered.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| AlternateIdentifier |
An identifier other than the primary Identifier applied to the resource being registered. |
1.3.15.1. root > data > attributes > alternateIdentifiers > AlternateIdentifier
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/AlternateIdentifier |
Description: An identifier other than the primary Identifier applied to the resource being registered.
1.3.15.1.1. Property root > data > attributes > alternateIdentifiers > alternateIdentifiers items > alternateIdentifier
Description: An identifier other than the primary Identifier applied to the resource being registered
1.3.15.1.2. Property root > data > attributes > alternateIdentifiers > alternateIdentifiers items > alternateIdentifierType
Description: The general type of a resource.
Description: Identifiers of related resources.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| RelatedIdentifier |
Identifier of related resources. |
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedIdentifier |
Description: Identifier of related resources.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| - relatedIdentifier |
No |
string |
No |
- |
Identifier of related resources. |
| - relatedIdentifierType |
No |
enum (of string) |
No |
In #/$defs/RelatedIdentifierType |
The type of the RelatedIdentifier. |
| - relationType |
No |
enum (of string) |
No |
In #/$defs/RelationType |
Description of the relationship of the resource being registered (A) and the related resource (B). |
| - relatedMetadataScheme |
No |
string |
No |
- |
The name of the schemes. |
| - schemeURI |
No |
string |
No |
- |
The URI of the name identifier scheme. |
| - schemeType |
No |
string |
No |
- |
The type of the relatedMetadataScheme, linked with the schemeURI |
| - resourceTypeGeneral |
No |
enum (of string) |
No |
Same as resourceTypeGeneral |
The general type of a resource. |
1.3.16.1.1. If (relationType = null)
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
1.3.16.1.1.1. The following properties are required
- relatedMetadataScheme
- schemeURI
- schemeType
1.3.16.1.2. Else (i.e. relationType != null)
|
|
| Type |
combining |
| Required |
No |
| Additional properties |
Any type allowed |
1.3.16.1.2.1. Must not be
|
|
| Type |
combining |
| Required |
No |
| Additional properties |
Any type allowed |
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
1.3.16.1.2.1.1.1. The following properties are required
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
1.3.16.1.2.1.2.1. The following properties are required
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
1.3.16.1.2.1.3.1. The following properties are required
Description: Identifier of related resources.
|
|
| Type |
enum (of string) |
| Required |
No |
| Defined in |
#/$defs/RelatedIdentifierType |
Description: The type of the RelatedIdentifier.
Must be one of:
* "ARK"
* "arXiv"
* "bibcode"
* "CSTR"
* "DOI"
* "EAN13"
* "EISSN"
* "Handle"
* "IGSN"
* "ISBN"
* "ISSN"
* "ISTC"
* "LISSN"
* "LSID"
* "PMID"
* "PURL"
* "RRID"
* "UPC"
* "URL"
* "URN"
* "w3id"
|
|
| Type |
enum (of string) |
| Required |
No |
| Defined in |
#/$defs/RelationType |
Description: Description of the relationship of the resource being registered (A) and the related resource (B).
Must be one of:
* "IsCitedBy"
* "Cites"
* "IsSupplementTo"
* "IsSupplementedBy"
* "IsContinuedBy"
* "Continues"
* "IsDescribedBy"
* "Describes"
* "HasMetadata"
* "IsMetadataFor"
* "HasVersion"
* "IsVersionOf"
* "IsNewVersionOf"
* "IsPreviousVersionOf"
* "IsPartOf"
* "HasPart"
* "IsPublishedIn"
* "IsReferencedBy"
* "References"
* "IsDocumentedBy"
* "Documents"
* "IsCompiledBy"
* "Compiles"
* "IsVariantFormOf"
* "IsOriginalFormOf"
* "IsIdenticalTo"
* "IsReviewedBy"
* "Reviews"
* "IsDerivedFrom"
* "IsSourceOf"
* "IsRequiredBy"
* "Requires"
* "IsObsoletedBy"
* "Obsoletes"
* "IsCollectedBy"
* "Collects"
* "IsTranslationOf"
* "HasTranslation"
Description: The name of the schemes.
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the name identifier scheme.
Description: The type of the relatedMetadataScheme, linked with the schemeURI
Description: The general type of a resource.
1.3.17. Property root > data > attributes > sizes
|
|
| Type |
array of string |
| Required |
No |
Description: Size (e.g., bytes, pages, inches, etc.) or duration (extent), e.g., hours, minutes, days, etc., of a resource.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| sizes items |
- |
1.3.17.1. root > data > attributes > sizes > sizes items
|
|
| Type |
array of string |
| Required |
No |
Description: Technical format of the resources.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
1.3.19. Property root > data > attributes > version
Description: The version number of the resources.
1.3.20. Property root > data > attributes > rightsList
Description: Any rights information for this resource
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Right |
Any right information for this resource. |
1.3.20.1. root > data > attributes > rightsList > Right
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Right |
Description: Any right information for this resource.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + rights |
No |
string |
No |
- |
Any right information for this resource. |
| - rightsURI |
No |
string |
No |
- |
The URI of the license. |
| - rightsIdentifier |
No |
string |
No |
- |
A short, standardized version of the license name. |
| - rightsIdentifierScheme |
No |
string |
No |
- |
The name of the scheme. |
| - schemeURI |
No |
string |
No |
- |
The URI of the rightsIdentifierScheme. |
1.3.20.1.1. Property root > data > attributes > rightsList > rightsList items > rights
Description: Any right information for this resource.
1.3.20.1.2. Property root > data > attributes > rightsList > rightsList items > rightsURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the license.
1.3.20.1.3. Property root > data > attributes > rightsList > rightsList items > rightsIdentifier
Description: A short, standardized version of the license name.
1.3.20.1.4. Property root > data > attributes > rightsList > rightsList items > rightsIdentifierScheme
Description: The name of the scheme.
1.3.20.1.5. Property root > data > attributes > rightsList > rightsList items > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the rightsIdentifierScheme.
1.3.21. Property root > data > attributes > descriptions
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| Description |
All additional information that does not fit in any of the other categories. |
1.3.21.1. root > data > attributes > descriptions > Description
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/Description |
Description: All additional information that does not fit in any of the other categories.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + description |
No |
string |
No |
- |
All additional information that does not fit in any of the other categories. |
| + descriptionType |
No |
enum (of string) |
No |
- |
The type of the Description. |
1.3.21.1.1. Property root > data > attributes > descriptions > descriptions items > description
Description: All additional information that does not fit in any of the other categories.
1.3.21.1.2. Property root > data > attributes > descriptions > descriptions items > descriptionType
|
|
| Type |
enum (of string) |
| Required |
Yes |
Description: The type of the Description.
Must be one of:
* "Abstract"
* "Methods"
* "SeriesInformation"
* "TableOfContents"
* "TechnicalInfo"
* "Other"
1.3.22. Property root > data > attributes > geoLocations
Description: Spatial regions or named places where the data was gathered or about which the data is focused.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| GeoLocation |
Spatial region or named place where the data was gathered or about which the data is focused. |
1.3.22.1. root > data > attributes > geoLocations > GeoLocation
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/GeoLocation |
Description: Spatial region or named place where the data was gathered or about which the data is focused.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| - geoLocationPoint |
No |
object |
No |
In #/$defs/GeoLocationPoint |
A point location in space. |
| - geoLocationBox |
No |
object |
No |
In #/$defs/GeoLocationBox |
The spatial limits of a box. |
| - geoLocationPlace |
No |
string |
No |
- |
Description of a geographic location. |
| - geoLocationPolygon |
No |
array |
No |
- |
- |
1.3.22.1.1. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPoint
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/GeoLocationPoint |
Description: A point location in space.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + pointLongitude |
No |
number |
No |
- |
Longitudinal dimension of point. |
| + pointLatitude |
No |
number |
No |
- |
Latitudinal dimension of point. |
1.3.22.1.1.1. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPoint > pointLongitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Longitudinal dimension of point.
1.3.22.1.1.2. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPoint > pointLatitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Latitudinal dimension of point.
1.3.22.1.2. Property root > data > attributes > geoLocations > geoLocations items > geoLocationBox
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/GeoLocationBox |
Description: The spatial limits of a box.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + westBoundLongitude |
No |
number |
No |
- |
Western longitudinal dimension of box. |
| + eastBoundLongitude |
No |
number |
No |
- |
Eastern longitudinal dimension of box. |
| + southBoundLatitude |
No |
number |
No |
- |
Southern latitudinal dimension of box. |
| + northBoundLatitude |
No |
number |
No |
- |
Northern latitudinal dimension of box. |
1.3.22.1.2.1. Property root > data > attributes > geoLocations > geoLocations items > geoLocationBox > westBoundLongitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Western longitudinal dimension of box.
1.3.22.1.2.2. Property root > data > attributes > geoLocations > geoLocations items > geoLocationBox > eastBoundLongitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Eastern longitudinal dimension of box.
1.3.22.1.2.3. Property root > data > attributes > geoLocations > geoLocations items > geoLocationBox > southBoundLatitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Southern latitudinal dimension of box.
1.3.22.1.2.4. Property root > data > attributes > geoLocations > geoLocations items > geoLocationBox > northBoundLatitude
|
|
| Type |
number |
| Required |
Yes |
| Format |
float |
Description: Northern latitudinal dimension of box.
1.3.22.1.3. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPlace
Description: Description of a geographic location.
1.3.22.1.4. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPolygon
|
Array restrictions |
| Min items |
4 |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| GeoLocationPolygon |
A drawn polygon area, defined by a set of points and lines connecting the points in a closed chain. |
1.3.22.1.4.1. root > data > attributes > geoLocations > geoLocations items > geoLocationPolygon > GeoLocationPolygon
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/GeoLocationPolygon |
Description: A drawn polygon area, defined by a set of points and lines connecting the points in a closed chain.
1.3.22.1.4.1.1. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPolygon > geoLocationPolygon items > polygonPoint
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Same definition as |
geoLocationPoint |
Description: A point location in space.
1.3.22.1.4.1.2. Property root > data > attributes > geoLocations > geoLocations items > geoLocationPolygon > geoLocationPolygon items > inPolygonPoint
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Same definition as |
geoLocationPoint |
Description: A point location in space.
1.3.23. Property root > data > attributes > fundingReferences
Description: Information about financial support (funding) for the resource being registered.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| FundingReference |
Information about financial support (funding) for the resource being registered. |
1.3.23.1. root > data > attributes > fundingReferences > FundingReference
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/FundingReference |
Description: Information about financial support (funding) for the resource being registered.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + funderName |
No |
string |
No |
- |
Name of the funding provider. |
| - funderIdentifier |
No |
string |
No |
- |
Uniquely identifies a funding entity, according to various types |
| + funderIdentifierType |
No |
enum (of string) |
No |
- |
The type of the funderIdentifier. |
| - schemeURI |
No |
string |
No |
- |
The URI of the funder identifier scheme. |
| - awardNumber |
No |
string |
No |
- |
The code assigned by the funder to a sponsored award (grant). |
| - awardURI |
No |
string |
No |
- |
The URI leading to a page provided by the funder for more information about the award (grant). |
| - awardTitle |
No |
string |
No |
- |
The human readable title or name of the award (grant). |
1.3.23.1.1. Property root > data > attributes > fundingReferences > fundingReferences items > funderName
Description: Name of the funding provider.
1.3.23.1.2. Property root > data > attributes > fundingReferences > fundingReferences items > funderIdentifier
Description: Uniquely identifies a funding entity, according to various types
1.3.23.1.3. Property root > data > attributes > fundingReferences > fundingReferences items > funderIdentifierType
|
|
| Type |
enum (of string) |
| Required |
Yes |
Description: The type of the funderIdentifier.
Must be one of:
* "Crossref Funder ID"
* "GRID"
* "ISNI"
* "ROR"
* "Other"
1.3.23.1.4. Property root > data > attributes > fundingReferences > fundingReferences items > schemeURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the funder identifier scheme.
1.3.23.1.5. Property root > data > attributes > fundingReferences > fundingReferences items > awardNumber
Description: The code assigned by the funder to a sponsored award (grant).
1.3.23.1.6. Property root > data > attributes > fundingReferences > fundingReferences items > awardURI
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI leading to a page provided by the funder for more information about the award (grant).
1.3.23.1.7. Property root > data > attributes > fundingReferences > fundingReferences items > awardTitle
Description: The human readable title or name of the award (grant).
Description: Informations about a resource related to the one being registered.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| RelatedItem |
Information about a resource related to the one being registered. |
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedItem |
Description: Information about a resource related to the one being registered.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + relatedItemType |
No |
enum (of string) |
No |
Same as resourceTypeGeneral |
The general type of a resource. |
| + relationType |
No |
enum (of string) |
No |
Same as resourceTypeGeneral |
The general type of a resource. |
| - relatedItemIdentifier |
No |
object |
No |
In #/$defs/RelatedItemIdentifier |
The identifier for the related item. |
| - creators |
No |
array |
No |
- |
The institution or person responsible for creating the related resource. |
| + titles |
No |
array |
No |
- |
Title of the related item |
| - publicationYear |
No |
object |
No |
Same as publicationYear |
The year when the data was or will be made publicly available. |
| - volume |
No |
string |
No |
- |
Volume of the related item. |
| - issue |
No |
string |
No |
- |
Issue number or name of the related item. |
| - number |
No |
string |
No |
- |
Number of the resource within the related item, e.g., report number or article number. |
| - numberType |
No |
enum (of string) |
No |
- |
Type of the related item’s number, e.g., report number or article number. |
| - firstPage |
No |
string |
No |
- |
First page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings. |
| - lastPage |
No |
string |
No |
- |
Last page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings. |
| - publisher |
No |
string |
No |
- |
The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. |
| - edition |
No |
string |
No |
- |
Edition or version of the related item. |
| - contributors |
No |
array |
No |
- |
An institution or person identified as contributing to the development of the resource |
Description: The general type of a resource.
Description: The general type of a resource.
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedItemIdentifier |
Description: The identifier for the related item.
Description: The type of the RelatedIdentifier.
Description: The name of the schemes.
|
|
| Type |
string |
| Required |
No |
| Format |
uri |
Description: The URI of the name identifier scheme.
Description: The type of the relatedMetadataScheme, linked with the schemeURI
Description: The institution or person responsible for creating the related resource.
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| RelatedItemCreator |
The institution or person responsible for creating the related resource. |
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedItemCreator |
Description: The institution or person responsible for creating the related resource.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + name |
No |
string |
No |
- |
The full name of the related item creator |
| - nameType |
No |
enum (of string) |
No |
Same as nameType |
The type of name. |
| - givenName |
No |
string |
No |
- |
The personal or first name of the creator. |
| - familyName |
No |
string |
No |
- |
The surname or last name of the creator. |
Description: The full name of the related item creator
|
|
| Type |
enum (of string) |
| Required |
No |
| Same definition as |
nameType |
Description: The type of name.
Description: The personal or first name of the creator.
Description: The surname or last name of the creator.
Description: Title of the related item
|
Array restrictions |
| Min items |
1 |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| RelatedItemTitle |
Title of the related item. |
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedItemTitle |
Description: Title of the related item.
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + title |
No |
string |
No |
- |
Title of the related item. |
| - titleType |
No |
string |
No |
- |
Type of the related item title. |
Description: Title of the related item.
Description: Type of the related item title.
|
|
| Type |
combining |
| Required |
No |
| Additional properties |
Any type allowed |
| Same definition as |
publicationYear |
Description: The year when the data was or will be made publicly available.
Description: Volume of the related item.
Description: Issue number or name of the related item.
Description: Number of the resource within the related item, e.g., report number or article number.
|
|
| Type |
enum (of string) |
| Required |
No |
Description: Type of the related item’s number, e.g., report number or article number.
Must be one of:
* "Article"
* "Chapter"
* "Report"
* "Other"
1.3.24.1.11. Property root > data > attributes > relatedItems > relatedItems items > firstPage
Description: First page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings.
1.3.24.1.12. Property root > data > attributes > relatedItems > relatedItems items > lastPage
Description: Last page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings.
Description: The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
Description: Edition or version of the related item.
Description: An institution or person identified as contributing to the development of the resource
|
Array restrictions |
| Min items |
N/A |
| Max items |
N/A |
| Items unicity |
False |
| Additional items |
False |
| Tuple validation |
See below |
| Each item of this array must be |
Description |
| RelatedItemContributor |
An institution or person identified as contributing to the development of the resource. |
|
|
| Type |
combining |
| Required |
No |
| Additional properties |
Any type allowed |
| Defined in |
#/$defs/RelatedItemContributor |
Description: An institution or person identified as contributing to the development of the resource.
Description: The institution or person responsible for creating the related resource.
|
|
| Type |
object |
| Required |
No |
| Additional properties |
Any type allowed |
| Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
| + contributorType |
No |
enum (of string) |
No |
Same as contributorType |
The type of contributor of the resource |
Description: The type of contributor of the resource
Generated using json-schema-for-humans on 2025-11-07 at 00:41:11 +0100