Schema URL

Type: object

A file with citation metadata for software or datasets.

Properties

authors person | entity[] required

The author(s) of the software or dataset.

minItems=1uniqueItems=true
cff-version string required

The version of CFF used for providing the citation metadata.

Examples: "1.2.0"
pattern=^1\.2\.0$
message string required

A message to the human reader of the file to let them know what to do with the citation metadata.

Default: "If you use this software, please cite it using the metadata from this file."
Examples: "If you use this software, please cite it using the metadata from this file.", "Please cite this software using these metadata.", "Please cite this software using the metadata from 'preferred-citation'."
minLength=1
title string required

The name of the software or dataset.

minLength=1
abstract string

A description of the software or dataset.

minLength=1
commit string

The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.

minLength=1
contact person | entity[]

The contact person, group, company, etc. for the software or dataset.

minItems=1uniqueItems=true
date-released string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples: "10.5281/zenodo.1003150"
pattern=^10\.\d{4,9}(\.\d+)?/[A-Za-z0-9:/_;\-\.\(\)\[\]\\]+$
identifiers identifier[]

The identifiers of the software or dataset.

minItems=1uniqueItems=true
keywords string[]

Keywords that describe the work.

minItems=1uniqueItems=true

An SPDX license identifier.

license-url string
format=uripattern=^(https|http|ftp|sftp)://.+
preferred-citation object

A reference to a work.

71 nested properties
authors person | entity[] required

The author(s) of a work.

minItems=1uniqueItems=true
title string required

The title of the work.

minLength=1
type string required

The type of the work.

Values: "art" "article" "audiovisual" "bill" "blog" "book" "catalogue" "conference-paper" "conference" "data" "database" "dictionary" "edited-work" "encyclopedia" "film-broadcast" "generic" "government-document" "grant" "hearing" "historical-work" "legal-case" "legal-rule" "magazine-article" "manual" "map" "multimedia" "music" "newspaper-article" "pamphlet" "patent" "personal-communication" "proceedings" "report" "serial" "slides" "software-code" "software-container" "software-executable" "software-virtual-machine" "software" "sound-recording" "standard" "statute" "thesis" "unpublished" "video" "website"
abbreviation string

The abbreviation of a work.

minLength=1
abstract string

The abstract of a work.

minLength=1
collection-doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples: "10.5281/zenodo.1003150"
pattern=^10\.\d{4,9}(\.\d+)?/[A-Za-z0-9:/_;\-\.\(\)\[\]\\]+$
collection-title string

The title of a collection or proceedings.

minLength=1
collection-type string

The type of a collection.

minLength=1
commit string

The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.

minLength=1
conference object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
contact person | entity[]

The contact person, group, company, etc. for a work.

minItems=1uniqueItems=true
copyright string

The copyright information pertaining to the work.

minLength=1
data-type string

The data type of a data set.

minLength=1
database string

The name of the database where a work was accessed/is stored.

minLength=1
database-provider object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
date-accessed string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-downloaded string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-published string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-released string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
department string

The department where a work has been produced.

minLength=1
doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples: "10.5281/zenodo.1003150"
pattern=^10\.\d{4,9}(\.\d+)?/[A-Za-z0-9:/_;\-\.\(\)\[\]\\]+$
edition string

The edition of the work.

minLength=1
editors person | entity[]

The editor(s) of a work.

minItems=1uniqueItems=true
editors-series person | entity[]

The editor(s) of a series in which a work has been published.

minItems=1uniqueItems=true
end integer | string

The end page of the work.

entry string

An entry in the collection that constitutes the work.

minLength=1
filename string

The name of the electronic file containing the work.

minLength=1
format string

The format in which a work is represented.

minLength=1
identifiers identifier[]

The identifier(s) of the work.

minItems=1uniqueItems=true
institution object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
isbn string

The ISBN of the work.

pattern=^[0-9\- ]{10,17}X?$
issn string

The ISSN of the work.

pattern=^\d{4}-\d{3}[0-9xX]$
issue string | number

The issue of a periodical in which a work appeared.

issue-date string

The publication date of the issue of a periodical in which a work appeared.

minLength=1
issue-title string

The name of the issue of a periodical in which the work appeared.

minLength=1
journal string

The name of the journal/magazine/newspaper/periodical where the work was published.

minLength=1
keywords string[]

Keywords pertaining to the work.

minItems=1uniqueItems=true
languages string[]

The language identifier(s) of the work according to ISO 639 language strings.

minItems=1uniqueItems=true

An SPDX license identifier.

license-url string
format=uripattern=^(https|http|ftp|sftp)://.+
loc-end integer | string

The line of code in the file where the work ends.

loc-start integer | string

The line of code in the file where the work starts.

location object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
medium string

The medium of the work.

minLength=1
month integer | string

The month in which a work has been published.

nihmsid string

The NIHMSID of a work.

minLength=1
notes string

Notes pertaining to the work.

minLength=1
number string | number

The accession number for a work.

number-volumes integer | string

The number of volumes making up the collection in which the work has been published.

pages integer | string

The number of pages of the work.

patent-states string[]

The states for which a patent is granted.

minItems=1uniqueItems=true
pmcid string

The PMCID of a work.

pattern=^PMC[0-9]{7}$
publisher object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
recipients entity | person[]

The recipient(s) of a personal communication.

minItems=1uniqueItems=true
repository string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-artifact string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-code string
format=uripattern=^(https|http|ftp|sftp)://.+
scope string

The scope of the reference, e.g., the section of the work it adheres to.

minLength=1
section string | number

The section of a work that is referenced.

senders entity | person[]

The sender(s) of a personal communication.

minItems=1uniqueItems=true
start integer | string

The start page of the work.

status string

The publication status of the work.

Values: "abstract" "advance-online" "in-preparation" "in-press" "preprint" "submitted"
term string

The term being referenced if the work is a dictionary or encyclopedia.

minLength=1
thesis-type string

The type of the thesis that is the work.

minLength=1
translators entity | person[]

The translator(s) of a work.

minItems=1uniqueItems=true
url string
format=uripattern=^(https|http|ftp|sftp)://.+
version string | number
volume integer | string

The volume of the periodical in which a work appeared.

volume-title string

The title of the volume in which the work appeared.

minLength=1
year integer | string

The year in which a work has been published.

year-original integer | string

The year of the original publication.

references reference[]

Reference(s) to other creative works.

minItems=1uniqueItems=true
repository string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-artifact string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-code string
format=uripattern=^(https|http|ftp|sftp)://.+
type string

The type of the work.

Default: "software"
Values: "dataset" "software"
url string
format=uripattern=^(https|http|ftp|sftp)://.+
version string | number

Definitions

address string

An address.

alias string

An alias.

city string

A city

commit string

The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.

country string

The ISO 3166-1 alpha-2 country code for a country.

date string
Examples:
  • "1900-01-01"
  • "2020-12-31"
doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples:
  • "10.5281/zenodo.1003150"
email string

An email address.

entity object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
fax string

A fax number.

identifier object | object | object | object

An identifier for a work.

identifier-description string

A description for a specific identifier value.

Examples:
  • "The version DOI for this version, which has a relation childOf with the concept DOI specified in the doi field in the root of this file."
  • "The identifier provided by Archival Repository, which points to this version of the software."
license license-enum | license-enum[]

An SPDX license identifier.

license-enum string
orcid string

Identifier for an author, see https://orcid.org.

person object

A person.

address string

An address.

minLength=1
affiliation string

The person's affilitation.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
family-names string

The person's family names.

minLength=1
fax string

A fax number.

minLength=1
given-names string

The person's given names.

minLength=1
name-particle string

The person's name particle, e.g., a nobiliary particle or a preposition meaning 'of' or 'from' (for example 'von' in 'Alexander von Humboldt').

Examples: "von"
minLength=1
name-suffix string

The person's name-suffix, e.g. 'Jr.' for Sammy Davis Jr. or 'III' for Frank Edwin Wright III.

Examples: "Jr.", "III"
minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
post-code string | number

A post code.

reference object

A reference to a work.

authors person | entity[] required

The author(s) of a work.

minItems=1uniqueItems=true
title string required

The title of the work.

minLength=1
type string required

The type of the work.

Values: "art" "article" "audiovisual" "bill" "blog" "book" "catalogue" "conference-paper" "conference" "data" "database" "dictionary" "edited-work" "encyclopedia" "film-broadcast" "generic" "government-document" "grant" "hearing" "historical-work" "legal-case" "legal-rule" "magazine-article" "manual" "map" "multimedia" "music" "newspaper-article" "pamphlet" "patent" "personal-communication" "proceedings" "report" "serial" "slides" "software-code" "software-container" "software-executable" "software-virtual-machine" "software" "sound-recording" "standard" "statute" "thesis" "unpublished" "video" "website"
abbreviation string

The abbreviation of a work.

minLength=1
abstract string

The abstract of a work.

minLength=1
collection-doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples: "10.5281/zenodo.1003150"
pattern=^10\.\d{4,9}(\.\d+)?/[A-Za-z0-9:/_;\-\.\(\)\[\]\\]+$
collection-title string

The title of a collection or proceedings.

minLength=1
collection-type string

The type of a collection.

minLength=1
commit string

The (e.g., Git) commit hash or (e.g., Subversion) revision number of the work.

minLength=1
conference object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
contact person | entity[]

The contact person, group, company, etc. for a work.

minItems=1uniqueItems=true
copyright string

The copyright information pertaining to the work.

minLength=1
data-type string

The data type of a data set.

minLength=1
database string

The name of the database where a work was accessed/is stored.

minLength=1
database-provider object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
date-accessed string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-downloaded string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-published string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-released string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
department string

The department where a work has been produced.

minLength=1
doi string

The DOI of the work (i.e., 10.5281/zenodo.1003150, not the resolver URL http://doi.org/10.5281/zenodo.1003150).

Examples: "10.5281/zenodo.1003150"
pattern=^10\.\d{4,9}(\.\d+)?/[A-Za-z0-9:/_;\-\.\(\)\[\]\\]+$
edition string

The edition of the work.

minLength=1
editors person | entity[]

The editor(s) of a work.

minItems=1uniqueItems=true
editors-series person | entity[]

The editor(s) of a series in which a work has been published.

minItems=1uniqueItems=true
end integer | string

The end page of the work.

entry string

An entry in the collection that constitutes the work.

minLength=1
filename string

The name of the electronic file containing the work.

minLength=1
format string

The format in which a work is represented.

minLength=1
identifiers identifier[]

The identifier(s) of the work.

minItems=1uniqueItems=true
institution object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
isbn string

The ISBN of the work.

pattern=^[0-9\- ]{10,17}X?$
issn string

The ISSN of the work.

pattern=^\d{4}-\d{3}[0-9xX]$
issue string | number

The issue of a periodical in which a work appeared.

issue-date string

The publication date of the issue of a periodical in which a work appeared.

minLength=1
issue-title string

The name of the issue of a periodical in which the work appeared.

minLength=1
journal string

The name of the journal/magazine/newspaper/periodical where the work was published.

minLength=1
keywords string[]

Keywords pertaining to the work.

minItems=1uniqueItems=true
languages string[]

The language identifier(s) of the work according to ISO 639 language strings.

minItems=1uniqueItems=true

An SPDX license identifier.

license-url string
format=uripattern=^(https|http|ftp|sftp)://.+
loc-end integer | string

The line of code in the file where the work ends.

loc-start integer | string

The line of code in the file where the work starts.

location object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
medium string

The medium of the work.

minLength=1
month integer | string

The month in which a work has been published.

nihmsid string

The NIHMSID of a work.

minLength=1
notes string

Notes pertaining to the work.

minLength=1
number string | number

The accession number for a work.

number-volumes integer | string

The number of volumes making up the collection in which the work has been published.

pages integer | string

The number of pages of the work.

patent-states string[]

The states for which a patent is granted.

minItems=1uniqueItems=true
pmcid string

The PMCID of a work.

pattern=^PMC[0-9]{7}$
publisher object

An entity, i.e., an institution, team, research group, company, conference, etc., as opposed to a single natural person.

15 nested properties
name string required

The entity's name.

minLength=1
address string

An address.

minLength=1
alias string

An alias.

minLength=1
city string

A city

minLength=1
country string

The ISO 3166-1 alpha-2 country code for a country.

Values: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
date-end string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
date-start string
Examples: "1900-01-01", "2020-12-31"
format=datepattern=^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
email string

An email address.

pattern=^[\S]+@[\S]+\.[\S]{2,}$
fax string

A fax number.

minLength=1
location string

The entity's location, e.g., when the entity is a conference.

minLength=1
orcid string

Identifier for an author, see https://orcid.org.

format=uripattern=https://orcid\.org/[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X]{1}
post-code string | number

A post code.

region string

A region.

minLength=1
tel string

A phone number.

minLength=1
website string
format=uripattern=^(https|http|ftp|sftp)://.+
recipients entity | person[]

The recipient(s) of a personal communication.

minItems=1uniqueItems=true
repository string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-artifact string
format=uripattern=^(https|http|ftp|sftp)://.+
repository-code string
format=uripattern=^(https|http|ftp|sftp)://.+
scope string

The scope of the reference, e.g., the section of the work it adheres to.

minLength=1
section string | number

The section of a work that is referenced.

senders entity | person[]

The sender(s) of a personal communication.

minItems=1uniqueItems=true
start integer | string

The start page of the work.

status string

The publication status of the work.

Values: "abstract" "advance-online" "in-preparation" "in-press" "preprint" "submitted"
term string

The term being referenced if the work is a dictionary or encyclopedia.

minLength=1
thesis-type string

The type of the thesis that is the work.

minLength=1
translators entity | person[]

The translator(s) of a work.

minItems=1uniqueItems=true
url string
format=uripattern=^(https|http|ftp|sftp)://.+
version string | number
volume integer | string

The volume of the periodical in which a work appeared.

volume-title string

The title of the volume in which the work appeared.

minLength=1
year integer | string

The year in which a work has been published.

year-original integer | string

The year of the original publication.

region string

A region.

swh-identifier string

The Software Heritage identifier (without further qualifiers such as origin, visit, anchor, path).

Examples:
  • "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"
  • "swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505"
  • "swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d"
  • "swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f"
  • "swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453"
tel string

A phone number.

url string
version string | number