updated field names in the doc pages

This commit is contained in:
Claudio Atzori 2025-01-10 16:02:32 +01:00
parent 82f2e2d58a
commit 201683ae6f
12 changed files with 120 additions and 94 deletions

View File

@ -49,8 +49,8 @@ _Start Date: 2024-12-06 • Release Date: 2024-12-23 • Dataset release:
- `organization.pid` is updated to `organization.pids`
- `project.subject` is updated to `project.subjects`
- `project.funding` is updated to `project.fundings`
- `project.h2020Programme is updated to `project.h2020Programmes`
- `community.subject is updated to `community.subjects`
- `project.h2020Programme` is updated to `project.h2020Programmes`
- `community.subject` is updated to `community.subjects`
- relation types refer to "product" instead of "result".
- The complete OpenAIRE dataset is available at [10.5281/zenodo.14582029](https://doi.org/10.5281/zenodo.14582029),
while the other public depositions are being updated and will be soon available.

View File

@ -21,26 +21,26 @@ The OpenAIRE id of the data source, created according to the [OpenAIRE entity id
"id": "issn___print::22c514d022b199c346e7f29ca06efc95"
```
### originalId
### originalIds
_Type: String • Cardinality: MANY_
The list of original identifiers associated to the datasource.
```json
"originalId": [
"originalIds": [
"issn___print::2451-8271",
...
]
```
### pid
### pids
_Type: [ControlledField](other#controlledfield) • Cardinality: MANY_
The persistent identifiers for the datasource.
```json
"pid": [
"pids": [
{
"scheme": "DOI",
"value": "10.5281/zenodo.4707307"

View File

@ -73,13 +73,13 @@ The country where the organization is located.
}
```
### pid
### pids
_Type: [OrganizationPid](other#organizationpid) • Cardinality: MANY_
The list of persistent identifiers for the organization.
```json
"pid": [
"pids": [
{
"scheme": "ISNI",
"value": "0000 0004 0393 5688"

View File

@ -531,13 +531,13 @@ Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-term
}
```
### alternateIdentifier
### alternateIdentifiers
_Type: [AlternateIdentifier](#alternateidentifier) • Cardinality: MANY_
All the identifiers associated to the research product other than the authoritative ones.
```json
"alternateIdentifier": [
"alternateIdentifiers": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
@ -567,13 +567,13 @@ The license URL.
"license": "http://creativecommons.org/licenses/by-nc/4.0"
```
### pid
### pids
_Type: [ResultPid](#resultpid) • Cardinality: MANY_
The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) for more information.
```json
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -617,13 +617,13 @@ The specific sub-type of this instance (see https://api.openaire.eu/vocabularies
"type": "Article"
```
### url
### urls
_Type: String • Cardinality: MANY_
URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source.
```json
"url": [
"urls": [
"https://periodicos2.uesb.br/index.php/folio/article/view/4296",
...
]

View File

@ -55,13 +55,13 @@ The identifier of the research call.
"callIdentifier": "H2020-EINFRA-2017"`
```
### funding
### fundings
_Type: [Funding](other#funding) • Cardinality: MANY_
Funding information for the project.
```json
"funding": [
"fundings": [
{
"fundingStream": {
"description": "Horizon 2020 Framework Programme - Research and Innovation action",
@ -86,13 +86,13 @@ The money granted to the project.
}
```
### h2020programme
### h2020programmes
_Type: [H2020Programme](other#h2020programme) • Cardinality: MANY_
The H2020 programme funding the project.
```json
"h2020programme":[
"h2020programmes":[
{
"code": "H2020-EU.1.4.1.3.",
"description": "Development, deployment and operation of ICT-based e-infrastructures"
@ -141,13 +141,13 @@ The end year pf the project.
"endDate": "2021-02-28"
```
### subject
### subjects
_Type: String • Cardinality: MANY_
The subjects of the project
```json
"subject": [
"subjects": [
"Data and Distributed Computing e-infrastructures for Open Science",
...
]

View File

@ -42,13 +42,13 @@ as declared in the terms from the [dnet:result_typologies vocabulary](https://ap
"type": "publication"
```
### originalId
### originalIds
_Type: String • Cardinality: MANY_
Identifiers of the record at the original sources.
```json
"originalId": [
"originalIds": [
"oai:pubmedcentral.nih.gov:8024784",
"S0048733321000305",
"10.1016/j.respol.2021.104226",
@ -75,13 +75,13 @@ Explanatory or alternative name by which a research product is known.
"subTitle": "An analysis of cases from 1980 - 2020"
```
### author
### authors
_Type: [Author](other#author) • Cardinality: MANY_
The main researchers involved in producing the data, or the authors of the publication.
```json
"author": [
"authors": [
{
"fullName": "E. Richard Gold",
"rank": 1,
@ -114,13 +114,13 @@ The most open access right associated to the manifestations of this research pro
}
```
### contributor
### contributors
_Type: String • Cardinality: MANY_
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
```json
"contributor": [
"contributors": [
"University of Zurich",
"Wright, Aidan G C",
"Hallquist, Michael",
@ -128,14 +128,14 @@ The institution or person responsible for collecting, managing, distributing, or
]
```
### country
### countries
_Type: [ResultCountry](other#resultcountry) • Cardinality: MANY_
Country associated with the research product: it is the country of the organisation that manages the institutional repository or national aggregator or CRIS system from which this record was collected.
Country of affiliations of authors can be found instead in the affiliation relation.
```json
"country": [
"countries": [
{
"code": "CH",
"label": "Switzerland",
@ -148,7 +148,7 @@ Country of affiliations of authors can be found instead in the affiliation relat
]
```
### coverage
### coverages
_Type: String • Cardinality: MANY_
### dateOfCollection
@ -160,13 +160,13 @@ When OpenAIRE collected the record the last time.
"dateOfCollection": "2021-06-09T11:37:56.248Z"
```
### description
### descriptions
_Type: String • Cardinality: MANY_
A brief description of the resource and the context in which the resource was created.
```json
"description": [
"descriptions": [
"Open science partnerships (OSPs) are one mechanism to reverse declining efficiency. OSPs are public-private partnerships that openly share publications, data and materials.",
"There is growing concern that the innovation system's ability to create wealth and attain social benefit is declining in effectiveness. This article explores the reasons for this decline and suggests a structure, the open science partnership, as one mechanism through which to slow down or reverse this decline.",
"The article examines the empirical literature of the last century to document the decline. This literature suggests that the cost of research and innovation is increasing exponentially, that researcher productivity is declining, and, third, that these two phenomena have led to an overall flat or declining level of innovation productivity.",
@ -211,13 +211,13 @@ currently, the following types of indicators are supported:
}
```
### instance
### instances
_Type: [Instance](other#instance) • Cardinality: MANY_
Specific materialization or version of the research product. For example, you can have one research product with three instances: one is the pre-print, one is the post-print, one is the published version.
```json
"instance": [
"instances": [
{
"accessRight": {
"code": "c_abf2",
@ -225,7 +225,7 @@ Specific materialization or version of the research product. For example, you ca
"openAccessRoute": "gold",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
},
"alternateIdentifier": [
"alternateIdentifiers": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
@ -237,7 +237,7 @@ Specific materialization or version of the research product. For example, you ca
"currency": "EUR"
},
"license": "http://creativecommons.org/licenses/by-nc/4.0",
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -248,7 +248,7 @@ Specific materialization or version of the research product. For example, you ca
"publicationDate": "2021-01-01",
"refereed": "UNKNOWN",
"type": "Article",
"url": [
"urls": [
"http://europepmc.org/articles/PMC8024784"
]
},
@ -276,13 +276,13 @@ Timestamp of last update of the record in OpenAIRE.
"lastUpdateTimeStamp": 1652722279987
```
### pid
### pids
_Type: [ResultPid](other#resultpid) • Cardinality: MANY_
Persistent identifiers of the research product. See also the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) to learn more.
```json
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -313,19 +313,32 @@ The name of the entity that holds, archives, publishes prints, distributes, rele
"publisher": "Elsevier, North-Holland Pub. Co"
```
### source
### sources
_Type: String • Cardinality: MANY_
A related resource from which the described resource is derived. See definition of Dublin Core field [dc:source](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source).
```json
"source": [
"sources": [
"Research Policy",
"Crossref",
...
]
```
### formats
_Type: String • Cardinality: MANY_
The file format, physical medium, or dimensions of the resource.
```json
"formats": [
"application/pdf",
"text/html",
...
]
```
### subjects
_Type: [Subject](other#subject) • Cardinality: MANY_
@ -442,13 +455,13 @@ The version of the research data.
"version": "v1.3"
```
#### geolocation
#### geolocations
_Type: [GeoLocation](other#geolocation) • Cardinality: MANY_
The list of geolocations associated with the research data.
```json
"geolocation": [
"geolocations": [
{
"box": "18.569386 54.468973 18.066832 54.83707",
"place": "Tübingen, Baden-Württemberg, Southern Germany",
@ -462,13 +475,13 @@ The list of geolocations associated with the research data.
Metadata records about research software (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/software)).
#### documentationUrl
#### documentationUrls
_Type: String • Cardinality: MANY_
The URLs to the software documentation.
```json
"documentationUrl": [
"documentationUrls": [
"https://github.com/openaire/iis/blob/master/README.markdown",
...
]
@ -496,13 +509,13 @@ The programming language.
Metadata records about research products that cannot be classified as research literature, data or software (includes types of products listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/other)).
#### contactPerson
#### contactPeople
_Type: String • Cardinality: MANY_
Information on the person responsible for providing further information regarding the resource.
```json
"contactPerson": [
"contactPeople": [
"Noémie Dominguez",
...
]
@ -520,7 +533,7 @@ Information on the group responsible for providing further information regarding
]
```
#### tool
#### tools
_Type: String • Cardinality: MANY_
Information about tool useful for the interpretation and/or re-use of the research product.

View File

@ -49,8 +49,8 @@ _Start Date: 2024-12-06 • Release Date: 2024-12-23 • Dataset release:
- `organization.pid` is updated to `organization.pids`
- `project.subject` is updated to `project.subjects`
- `project.funding` is updated to `project.fundings`
- `project.h2020Programme is updated to `project.h2020Programmes`
- `community.subject is updated to `community.subjects`
- `project.h2020Programme` is updated to `project.h2020Programmes`
- `community.subject` is updated to `community.subjects`
- relation types refer to "product" instead of "result".
- The complete OpenAIRE dataset is available at [10.5281/zenodo.14582029](https://doi.org/10.5281/zenodo.14582029),
while the other public depositions are being updated and will be soon available.

View File

@ -21,26 +21,26 @@ The OpenAIRE id of the data source, created according to the [OpenAIRE entity id
"id": "issn___print::22c514d022b199c346e7f29ca06efc95"
```
### originalId
### originalIds
_Type: String • Cardinality: MANY_
The list of original identifiers associated to the datasource.
```json
"originalId": [
"originalIds": [
"issn___print::2451-8271",
...
]
```
### pid
### pids
_Type: [ControlledField](other#controlledfield) • Cardinality: MANY_
The persistent identifiers for the datasource.
```json
"pid": [
"pids": [
{
"scheme": "DOI",
"value": "10.5281/zenodo.4707307"

View File

@ -73,13 +73,13 @@ The country where the organization is located.
}
```
### pid
### pids
_Type: [OrganizationPid](other#organizationpid) • Cardinality: MANY_
The list of persistent identifiers for the organization.
```json
"pid": [
"pids": [
{
"scheme": "ISNI",
"value": "0000 0004 0393 5688"

View File

@ -531,13 +531,13 @@ Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-term
}
```
### alternateIdentifier
### alternateIdentifiers
_Type: [AlternateIdentifier](#alternateidentifier) • Cardinality: MANY_
All the identifiers associated to the research product other than the authoritative ones.
```json
"alternateIdentifier": [
"alternateIdentifiers": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
@ -567,13 +567,13 @@ The license URL.
"license": "http://creativecommons.org/licenses/by-nc/4.0"
```
### pid
### pids
_Type: [ResultPid](#resultpid) • Cardinality: MANY_
The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) for more information.
```json
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -617,13 +617,13 @@ The specific sub-type of this instance (see https://api.openaire.eu/vocabularies
"type": "Article"
```
### url
### urls
_Type: String • Cardinality: MANY_
URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source.
```json
"url": [
"urls": [
"https://periodicos2.uesb.br/index.php/folio/article/view/4296",
...
]

View File

@ -55,13 +55,13 @@ The identifier of the research call.
"callIdentifier": "H2020-EINFRA-2017"`
```
### funding
### fundings
_Type: [Funding](other#funding) • Cardinality: MANY_
Funding information for the project.
```json
"funding": [
"fundings": [
{
"fundingStream": {
"description": "Horizon 2020 Framework Programme - Research and Innovation action",
@ -86,13 +86,13 @@ The money granted to the project.
}
```
### h2020programme
### h2020programmes
_Type: [H2020Programme](other#h2020programme) • Cardinality: MANY_
The H2020 programme funding the project.
```json
"h2020programme":[
"h2020programmes":[
{
"code": "H2020-EU.1.4.1.3.",
"description": "Development, deployment and operation of ICT-based e-infrastructures"
@ -141,13 +141,13 @@ The end year pf the project.
"endDate": "2021-02-28"
```
### subject
### subjects
_Type: String • Cardinality: MANY_
The subjects of the project
```json
"subject": [
"subjects": [
"Data and Distributed Computing e-infrastructures for Open Science",
...
]

View File

@ -42,13 +42,13 @@ as declared in the terms from the [dnet:result_typologies vocabulary](https://ap
"type": "publication"
```
### originalId
### originalIds
_Type: String • Cardinality: MANY_
Identifiers of the record at the original sources.
```json
"originalId": [
"originalIds": [
"oai:pubmedcentral.nih.gov:8024784",
"S0048733321000305",
"10.1016/j.respol.2021.104226",
@ -75,13 +75,13 @@ Explanatory or alternative name by which a research product is known.
"subTitle": "An analysis of cases from 1980 - 2020"
```
### author
### authors
_Type: [Author](other#author) • Cardinality: MANY_
The main researchers involved in producing the data, or the authors of the publication.
```json
"author": [
"authors": [
{
"fullName": "E. Richard Gold",
"rank": 1,
@ -114,13 +114,13 @@ The most open access right associated to the manifestations of this research pro
}
```
### contributor
### contributors
_Type: String • Cardinality: MANY_
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
```json
"contributor": [
"contributors": [
"University of Zurich",
"Wright, Aidan G C",
"Hallquist, Michael",
@ -128,14 +128,14 @@ The institution or person responsible for collecting, managing, distributing, or
]
```
### country
### countries
_Type: [ResultCountry](other#resultcountry) • Cardinality: MANY_
Country associated with the research product: it is the country of the organisation that manages the institutional repository or national aggregator or CRIS system from which this record was collected.
Country of affiliations of authors can be found instead in the affiliation relation.
```json
"country": [
"countries": [
{
"code": "CH",
"label": "Switzerland",
@ -148,7 +148,7 @@ Country of affiliations of authors can be found instead in the affiliation relat
]
```
### coverage
### coverages
_Type: String • Cardinality: MANY_
### dateOfCollection
@ -160,13 +160,13 @@ When OpenAIRE collected the record the last time.
"dateOfCollection": "2021-06-09T11:37:56.248Z"
```
### description
### descriptions
_Type: String • Cardinality: MANY_
A brief description of the resource and the context in which the resource was created.
```json
"description": [
"descriptions": [
"Open science partnerships (OSPs) are one mechanism to reverse declining efficiency. OSPs are public-private partnerships that openly share publications, data and materials.",
"There is growing concern that the innovation system's ability to create wealth and attain social benefit is declining in effectiveness. This article explores the reasons for this decline and suggests a structure, the open science partnership, as one mechanism through which to slow down or reverse this decline.",
"The article examines the empirical literature of the last century to document the decline. This literature suggests that the cost of research and innovation is increasing exponentially, that researcher productivity is declining, and, third, that these two phenomena have led to an overall flat or declining level of innovation productivity.",
@ -211,13 +211,13 @@ currently, the following types of indicators are supported:
}
```
### instance
### instances
_Type: [Instance](other#instance) • Cardinality: MANY_
Specific materialization or version of the research product. For example, you can have one research product with three instances: one is the pre-print, one is the post-print, one is the published version.
```json
"instance": [
"instances": [
{
"accessRight": {
"code": "c_abf2",
@ -225,7 +225,7 @@ Specific materialization or version of the research product. For example, you ca
"openAccessRoute": "gold",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
},
"alternateIdentifier": [
"alternateIdentifiers": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
@ -237,7 +237,7 @@ Specific materialization or version of the research product. For example, you ca
"currency": "EUR"
},
"license": "http://creativecommons.org/licenses/by-nc/4.0",
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -248,7 +248,7 @@ Specific materialization or version of the research product. For example, you ca
"publicationDate": "2021-01-01",
"refereed": "UNKNOWN",
"type": "Article",
"url": [
"urls": [
"http://europepmc.org/articles/PMC8024784"
]
},
@ -276,13 +276,13 @@ Timestamp of last update of the record in OpenAIRE.
"lastUpdateTimeStamp": 1652722279987
```
### pid
### pids
_Type: [ResultPid](other#resultpid) • Cardinality: MANY_
Persistent identifiers of the research product. See also the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) to learn more.
```json
"pid": [
"pids": [
{
"scheme": "pmc",
"value": "PMC8024784"
@ -313,19 +313,32 @@ The name of the entity that holds, archives, publishes prints, distributes, rele
"publisher": "Elsevier, North-Holland Pub. Co"
```
### source
### sources
_Type: String • Cardinality: MANY_
A related resource from which the described resource is derived. See definition of Dublin Core field [dc:source](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source).
```json
"source": [
"sources": [
"Research Policy",
"Crossref",
...
]
```
### formats
_Type: String • Cardinality: MANY_
The file format, physical medium, or dimensions of the resource.
```json
"formats": [
"application/pdf",
"text/html",
...
]
```
### subjects
_Type: [Subject](other#subject) • Cardinality: MANY_
@ -442,13 +455,13 @@ The version of the research data.
"version": "v1.3"
```
#### geolocation
#### geolocations
_Type: [GeoLocation](other#geolocation) • Cardinality: MANY_
The list of geolocations associated with the research data.
```json
"geolocation": [
"geolocations": [
{
"box": "18.569386 54.468973 18.066832 54.83707",
"place": "Tübingen, Baden-Württemberg, Southern Germany",
@ -462,13 +475,13 @@ The list of geolocations associated with the research data.
Metadata records about research software (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/software)).
#### documentationUrl
#### documentationUrls
_Type: String • Cardinality: MANY_
The URLs to the software documentation.
```json
"documentationUrl": [
"documentationUrls": [
"https://github.com/openaire/iis/blob/master/README.markdown",
...
]
@ -496,13 +509,13 @@ The programming language.
Metadata records about research products that cannot be classified as research literature, data or software (includes types of products listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/other)).
#### contactPerson
#### contactPeople
_Type: String • Cardinality: MANY_
Information on the person responsible for providing further information regarding the resource.
```json
"contactPerson": [
"contactPeople": [
"Noémie Dominguez",
...
]
@ -520,7 +533,7 @@ Information on the group responsible for providing further information regarding
]
```
#### tool
#### tools
_Type: String • Cardinality: MANY_
Information about tool useful for the interpretation and/or re-use of the research product.