D-Net
/
openaire-graph-docs
6
1
Fork 5
Code Issues 5 Pull Requests 2 Packages Projects Releases 69 Wiki Activity

Change research results to research products

This commit is contained in:
Serafeim Chatzopoulos 2024-01-17 14:39:34 +02:00
parent 096cbbb74e
commit 13c696b417
139 changed files with 148 additions and 6164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/apis/home.md
View File

@ -1,7 +1,7 @@
# Public APIs
The OpenAIRE Graph data are accessible through various public APIs. More specifically, the following APIs are currently provided:
* [Search API](./search-api) (an API to search for research results and projects)
* [Search API](./search-api) (an API to search for research products and projects)
* [ScholeXplorer API](https://api.scholexplorer.openaire.eu/swagger-ui/index.html?urls.primaryName=Scholexplorer%20API%20V2.0) (an API offering dataset-publication & dataset-dataset links)
* [DSpace & EPrints API](./dspace-eprints-api) (an API to offer custom access to metadata for projects funded by a selection of international funders for DSpace and EPrints platforms)
* [Broker API](./broker-api) (an API to enrich metadata for repositories, publishers, and aggregators)

2
docs/apis/search-api/results.md
View File

@ -1,4 +1,4 @@
# Searching for research results
# Searching for research products
## Endpoints

2
docs/apis/search-api/search-api.md
View File

@ -1,3 +1,3 @@
# Search API
The Search API allows developers to access metadata records of the OpenAIRE Graph by performing queries over research results (i.e., publications, data, software, other research products), and projects. The API is intended for metadata discovery and exploration only, hence it does not provide access to the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole graph, developers are encouraged to use the [OpenAIRE full Graph dataset](../../downloads/full-graph).
The Search API allows developers to access metadata records of the OpenAIRE Graph by performing queries over research products (i.e., publications, data, software, other research products), and projects. The API is intended for metadata discovery and exploration only, hence it does not provide access to the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole graph, developers are encouraged to use the [OpenAIRE full Graph dataset](../../downloads/full-graph).

4
docs/apis/specification-changelog.md
View File

@ -22,7 +22,7 @@
| 2021-02-01T08:55:35.496938Z | OAI-PMH shutdown announced for the end of April 2021 |
| 2021-01-15T18:56:04.748404Z | Updated documentation on OpenAIRE Research Graph Datasets |
| 2021-01-15T16:57:08.569766Z | Announcing the shutdown of the OAI-PMH publisher |
| 2019-01-25T15:36:27.264313Z | Added new parameter country for research results |
| 2019-01-25T15:36:27.264313Z | Added new parameter country for research products |
| 2018-10-17T10:39:56.570815Z | Software and Other research products are available via HTTP API. Documentation has been updated. |
| 2018-04-09T09:20:24.763966Z | Added section on terms of services and SLA in the specific API pages |
| 2018-04-09T08:26:18.897089Z | Added section for terms of use and SLA in the home page |
@ -80,7 +80,7 @@
| 2014-04-30T10:41:14.539090Z | Added and commented property to generate output in chunks |
| 2014-04-30T10:40:30.012256Z | mvn generates output with no chunks in a single file: api-doc.html |
| 2014-04-30T10:39:37.875730Z | Main docbook file renamed from book.xml to api-doc.xml |
| 2014-04-30T10:34:16.576722Z | updated OAI-PMH sets: now delivering only results and no other entities. |
| 2014-04-30T10:34:16.576722Z | updated OAI-PMH sets: now delivering only research products and no other entities. |
| 2014-04-15T09:53:22.158487Z | copied dnet-api-http-doc to new dnet40 codebase |
| 2014-04-10T09:55:41.690052Z | ignore |
| 2014-04-10T09:53:59.192401Z | removed target/*classes from svn |

BIN
docs/assets/img/data-model-3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 666 KiB

30
docs/changelog.md
View File

@ -30,12 +30,12 @@ _Start Date: 2023-12-18 • Release Date: 2024-01-06 • Dataset release:
#### Changed
This graph release also introduces new indicators to identify results published using specific open access models, in diamond journals, and those that received public funding. These indicators will also be added to the graph dataset in Zenodo. In details:
This graph release also introduces new fields to identify reseach products published using specific open access models, in diamond journals, and those that received public funding. These fields will also be added to the graph dataset in Zenodo. In details:
- `result.isGreen (true, false)`: indicates whether or not the scientific result was published following the green open access model;
- `result.openAccesColor (bronze, gold, hybrid)`: indicates the specific open access model used for the publication;
- `result.isInDiamondJournal (true, false)`: indicates whether or not the result was published in a diamond journal;
- `result.publicly-funded (true, false)`: indicates whether or not the grants acknowledged by the publication come from public funds.
- `ResearchProduct.isGreen (true, false)`: indicates whether or not the researh product was published following the green open access model;
- `ResearchProduct.openAccesColor (bronze, gold, hybrid)`: indicates the specific open access model used for the publication;
- `ResearchProduct.isInDiamondJournal (true, false)`: indicates whether or not the research product was published in a diamond journal;
- `ResearchProduct.publicly-funded (true, false)`: indicates whether or not the grants acknowledged by the publication come from public funds.
### v6.2.2
_Start Date: 2023-11-07 • Release Date: 2023-11-23 • Dataset release: **no**_
@ -58,7 +58,7 @@ _Start Date: 2023-11-07 • Release Date: 2023-11-23 • Dataset release:
_Start Date: 2023-09-11 • Release Date: 2023-10-15 • Dataset release: **no**_
#### Added
- Affiliation (result to organization) relations from Crossref
- Affiliation (research product to organization) relations from Crossref
- Links to the full text of research products
- Cleaning for author and publisher names (get rid of tabs, CR characters, \n(s), escape double quotes)
@ -75,8 +75,8 @@ _Start Date: 2023-07-26 • Release Date: 2023-08-16 • Dataset release:
#### Changed
- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType
- BIP! indicators are now serialised as an array; see the updated model [here](/data-model/entities/other#bipindicators)
- [Relationship data model](./data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType
- BIP! indicators are now serialised as an array; see the updated model [here](./data-model/entities/other#bipindicators)
- Crossref dump from June 2023
- ORCID works without a DOI from June 2023
- Usage counts from June 2023
@ -139,8 +139,8 @@ _Start Date: 2023-02-13 • Release Date: 2023-03-01 • Dataset release:
- Revised SDG classification: improved coverage (+600K classified DOIs)
- General increase of the funded scientific outputs, thanks to the full text mining scanning new OpenAccess publications
- Integrated contents from
- [EMBL-EBIs Protein Data Bank in Europe](/graph-production-workflow/aggregation/non-compatible-sources/ebi)
- [UniProtKB/Swiss-Prot](/graph-production-workflow//aggregation/non-compatible-sources/uniprot)
- [EMBL-EBIs Protein Data Bank in Europe](./graph-production-workflow/aggregation/non-compatible-sources/ebi)
- [UniProtKB/Swiss-Prot](./graph-production-workflow/aggregation/non-compatible-sources/uniprot)
#### Changed
@ -172,14 +172,14 @@ _Start Date: 2022-12-19 • Release Date: 2022-12-28 • Dataset release:
#### Added
- [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result
- [Beginner's kit](/downloads/beginners-kit) in the Downloads section
- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types)
- [Impact & Usage indicators](./data-model/entities/research-product.md#indicators) at the level of the research product
- [Beginner's kit](./downloads/beginners-kit) in the Downloads section
- New relationship types were introduced; see the complete list [here](./data-model/relationships/relationship-types)
#### Changed
- FOS and SDGs were removed from the [result subjects](/data-model/entities/result#subjects)
- Measures were removed from the [result instance](/data-model/entities/result#instance)
- FOS and SDGs were removed from the [ResearchProduct.subjects](./data-model/entities/research-product#subjects)
- Measures were removed from the [ResearchProduct.instance](./data-model/entities/research-product#instance)
- Updated DOIBoost to include publications from Crossref and the works from ORCID with a DOI until November 2022
- Added ORCID works without a DOI from November 2022

12
docs/data-model/data-model.md
View File

@ -5,18 +5,18 @@ The OpenAIRE Graph comprises several types of [entities](../category/entities) a
The latest version of the JSON schema can be found on the [Downloads](../downloads/full-graph) section.
<p align="center">
<img loading="lazy" alt="Data model" src={require('../assets/img/data-model-2.png').default} width="80%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
<img loading="lazy" alt="Data model" src={require('../assets/img/data-model-3.png').default} width="80%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
The figure above, presents the graph's data model.
Its main entities are described in brief below:
* [Results](/data-model/entities/result) represent the outcomes (or products) of research activities.
* [Data Sources](/data-model/entities/data-source) are the sources from which the metadata of graph objects are collected.
* [Organizations](/data-model/entities/organization) correspond to companies or research institutions involved in projects,
* [Research products](./entities/research-product) represent the outcomes (or products) of research activities.
* [Data sources](./entities/data-source) are the sources from which the metadata of graph objects are collected.
* [Organizations](./entities/organization) correspond to companies or research institutions involved in projects,
responsible for operating data sources or consisting the affiliations of Product creators.
* [Projects](/data-model/entities/project) are research project grants funded by a Funding Stream of a Funder.
* [Communities](/data-model/entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances).
* [Projects](./entities/project) are research project grants funded by a Funding Stream of a Funder.
* [Communities](./entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances).
:::note Further reading

2
docs/data-model/entities/data-source.md
View File

@ -64,7 +64,7 @@ The datasource type; see the vocabulary [dnet:datasource_typologies](https://api
### openairecompatibility
_Type: String &bull; Cardinality: ONE_
The OpenAIRE compatibility of the ingested results, indicates which guidelines they are compliant according to the vocabulary [dnet:datasourceCompatibilityLevel](https://api.openaire.eu/vocabularies/dnet:datasourceCompatibilityLevel).
The OpenAIRE compatibility of the ingested research products, indicates which guidelines they are compliant according to the vocabulary [dnet:datasourceCompatibilityLevel](https://api.openaire.eu/vocabularies/dnet:datasourceCompatibilityLevel).
```json
"openairecompatibility": "collected from a compatible aggregator"

36
docs/data-model/entities/other.md
View File

@ -20,7 +20,7 @@ Indicates the OpenAccess status. Values are set according to the [Unpaywall meth
```
## AlternateIdentifier
Type used to represent the information associated to persistent identifiers associated to the result that have not been forged by an authority for that pid type. For example we collect metadata from an institutional repository that provides as identifier for the result also the doi.
Type used to represent the information associated to persistent identifiers associated to the research product that have not been forged by an authority for that pid type. For example we collect metadata from an institutional repository that provides as identifier for the research product also the DOI.
### scheme
_Type: String &bull; Cardinality: ONE_
@ -63,7 +63,7 @@ The quantity of money.
## Author
Represents the result author.
Represents the research product author.
### fullname
_Type: String &bull; Cardinality: ONE_
@ -95,7 +95,7 @@ Author's family name.
### rank
_Type: String &bull; Cardinality: ONE_
Author's order in the list of authors for the given result.
Author's order in the list of authors for the given research product.
```json
"rank": 1
@ -167,7 +167,7 @@ The author's pid value in that scheme.
```
## BestAccessRight
Indicates the most open access rights \*available among the result Instances.
Indicates the most open access rights \*available among the research product instances.
\* where the openness is defined by the ordering of the access right terms in the following.
```
@ -251,7 +251,7 @@ The actual indicator score.
```
## Container
This field has information about the conference or journal where the result has been presented or published.
This field has information about the conference or journal where the research product has been presented or published.
### name
_Type: String &bull; Cardinality: ONE_
@ -533,7 +533,7 @@ The description of the programme.
```
## Instance
An instance is one specific materialization or version of the result. For example, you can have one result with three instances as result of deduplication:
An instance is one specific materialization or version of the research product. For example, you can have one research product with three instances due to deduplication:
* one is the pre-print
* one is the post-print
@ -558,7 +558,7 @@ Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-term
### alternateIdentifier
_Type: [AlternateIdentifier](#alternateidentifier) &bull; Cardinality: MANY_
All the identifiers associated to the result other than the authoritative ones.
All the identifiers associated to the research product other than the authoritative ones.
```json
"alternateIdentifier": [
@ -655,14 +655,14 @@ URLs to the instance. They may link to the actual full-text or to the landing pa
## Indicator
These are indicators computed for a specific OpenAIRE result.
These are indicators computed for a specific OpenAIRE research product.
Each Indicator object is composed of the following properties:
### bipIndicators
_Type: [BipIndicator](#bipindicator) &bull; Cardinality: MANY_
These impact-based indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), estimate the impact of a result.
These impact-based indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), estimate the impact of a research product.
For details about their calculation, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators).
@ -710,7 +710,7 @@ Please refer [here](/graph-production-workflow/indicators-ingestion/usage-counts
}
```
## Language
Represents information for the language of the result
Represents information for the language of the research product.
### code
_Type: String &bull; Cardinality: ONE_
@ -775,13 +775,13 @@ Trust, expressed as a number in the range [0-1].
```
## ResultCountry
It is for the country associated to the result.
This is the country associated to the research product.
It is a subclass of [Country](#country) and extends it with provenance information.
### provenance
_Type: [Provenance](#provenance-2) &bull; Cardinality: ONE_
Indicates the reason why this country is associated to this result.
Indicates the reason why this country is associated to this research product.
```json
"provenance": {
@ -791,14 +791,14 @@ Indicates the reason why this country is associated to this result.
```
## ResultPid
Type used to represent the information associated to persistent identifiers for the result that have been forged by an authority for that pid type.
Type used to represent the information associated to persistent identifiers for the research product that have been forged by an authority for that pid type.
<!-- <span className="todo">Seems to be similar to the AlternateIdentifier. What is the difference?</span> -->
### scheme
_Type: String &bull; Cardinality: ONE_
The scheme of the persistent identifier for the result (i.e. doi). If the pid is here it means the information for the pid has been collected from an authority for that pid type (i.e. Crossref/Datacite for doi). The set of authoritative pid is: `doi` when collected from Crossref or Datacite, `pmid` when collected from EuroPubmed, `arxiv` when collected from arXiv, `handle` from the repositories.
The scheme of the persistent identifier for the research product (i.e. doi). If the pid is here it means the information for the pid has been collected from an authority for that pid type (i.e. Crossref/Datacite for doi). The set of authoritative pid is: `doi` when collected from Crossref or Datacite, `pmid` when collected from EuroPubmed, `arxiv` when collected from arXiv, `handle` from the repositories.
```json
"scheme": "doi"
@ -814,7 +814,7 @@ The value expressed in the scheme (i.e. 10.1000/182).
```
## Subject
Represents keywords associated to the result.
Represents keywords associated to the research product.
### subject
_Type: [SubjectSchemeValue](#subjectschemevalue) &bull; Cardinality: ONE_
@ -863,12 +863,12 @@ The value for the subject in the selected scheme. When the scheme is 'keyword',
## UsageCounts
The usage counts indicator computed for this result.
The usage counts indicator computed for this research product.
### views
_Type: String &bull; Cardinality: ONE_
The number of views for this result.
The number of views for this research product.
```json
"views": "10"
@ -877,7 +877,7 @@ The number of views for this result.
### downloads
_Type: String &bull; Cardinality: ONE_
The number of downloads for this result.
The number of downloads for this research product.
```json
"downloads": "5"

2
docs/data-model/entities/project.md
View File

@ -4,7 +4,7 @@ sidebar_position: 4
# Projects
Of crucial interest to OpenAIRE is also the identification of the funders (e.g. European Commission, WellcomeTrust, FCT Portugal, NWO The Netherlands) that co-funded the projects that have led to a given result. Projects are characterized by a list of funding streams (e.g. FP7, H2020 for the EC), which identify the strands of fundings. Funding streams can be nested to form a tree of sub-funding streams.
Of crucial interest to OpenAIRE is also the identification of the funders (e.g. European Commission, WellcomeTrust, FCT Portugal, NWO The Netherlands) that co-funded the projects that have led to a given research product. Projects are characterized by a list of funding streams (e.g. FP7, H2020 for the EC), which identify the strands of fundings. Funding streams can be nested to form a tree of sub-funding streams.
---

34
docs/data-model/entities/result.md → docs/data-model/entities/research-product.md
View File

@ -2,12 +2,12 @@
sidebar_position: 1
---
# Results
# Research products
Results are intended as digital objects, described by metadata, resulting from a scientific process.
In this page, we descibe the properties of the `Result` object.
Research products are intended as digital objects, described by metadata, resulting from a scientific process.
In this page, we descibe the properties of the `ResearchProduct` object.
Moreover, there are the following sub-types of a `Result`, that inherit all its properties and further extend it:
Moreover, there are the following sub-types of a `ResearchProduct`, that inherit all its properties and further extend it:
* [Publication](#publication)
* [Dataset](#dataset)
* [Software](#software)
@ -15,7 +15,7 @@ Moreover, there are the following sub-types of a `Result`, that inherit all its
---
## The `Result` object
## The `ResearchProduct` object
### id
_Type: String &bull; Cardinality: ONE_
@ -29,7 +29,7 @@ Main entity identifier, created according to the [OpenAIRE entity identifier and
### type
_Type: String &bull; Cardinality: ONE_
Type of the result. Possible types:
Type of the research products. Possible types:
* `publication`
* `dataset`
@ -59,7 +59,7 @@ Identifiers of the record at the original sources.
### maintitle
_Type: String &bull; Cardinality: ONE_
A name or title by which a scientific result is known. May be the title of a publication, of a dataset or the name of a piece of software.
A name or title by which a research product is known. May be the title of a publication, of a dataset or the name of a piece of software.
```json
"maintitle": "The fall of the innovation empire and its possible rise through open science"
@ -69,7 +69,7 @@ A name or title by which a scientific result is known. May be the title of a pub
_Type: String &bull; Cardinality: ONE_
Explanatory or alternative name by which a scientific result is known.
Explanatory or alternative name by which a research product is known.
```json
"subtitle": "An analysis of cases from 1980 - 2020"
@ -104,7 +104,7 @@ The main researchers involved in producing the data, or the authors of the publi
### bestaccessright
_Type: [BestAccessRight](other#bestaccessright) &bull; Cardinality: ONE_
The most open access right associated to the manifestations of this research results.
The most open access right associated to the manifestations of this research product.
```json
"bestaccessright": {
@ -131,8 +131,8 @@ The institution or person responsible for collecting, managing, distributing, or
### country
_Type: [ResultCountry](other#resultcountry) &bull; Cardinality: MANY_
Country associated with the result because 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 rel.
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": [
@ -177,7 +177,7 @@ A brief description of the resource and the context in which the resource was cr
### embargoenddate
_Type: String &bull; Cardinality: ONE_
Date when the embargo ends and this result turns Open Access.
Date when the embargo ends and this research product turns Open Access.
```json
"embargoenddate": "2017-01-01"
@ -186,7 +186,7 @@ Date when the embargo ends and this result turns Open Access.
### indicators
_Type: [Indicator](other#indicator-1) &bull; Cardinality: ONE_
The indicators computed for this result;
The indicators computed for this research product;
currently, the following types of indicators are supported:
* [Impact indicators by BIP!](other#bipindicators)
@ -231,7 +231,7 @@ currently, the following types of indicators are supported:
### instance
_Type: [Instance](other#instance) &bull; Cardinality: MANY_
Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version.
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": [
@ -296,7 +296,7 @@ Timestamp of last update of the record in OpenAIRE.
### pid
_Type: [ResultPid](other#resultpid) &bull; Cardinality: MANY_
Persistent identifiers of the result. See also the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) to learn more.
Persistent identifiers of the research product. See also the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) to learn more.
```json
"pid": [
@ -315,7 +315,7 @@ Persistent identifiers of the result. See also the [OpenAIRE entity identifier a
### publicationdate
_Type: String &bull; Cardinality: ONE_
Main date of the research product: typically the publication or issued date. In case of a research result with different versions with different dates, the date of the result is selected as the most frequent well-formatted date. If not available, then the most recent and complete date among those that are well-formatted. For statistics, the year is extracted and the result is counted only among the result of that year. Example: Pre-print date: 2019-02-03, Article date provided by repository: 2020-02, Article date provided by Crossref: 2020, OpenAIRE will set as date 2019-02-03, because it’s the most recent among the complete and well-formed dates. If then the repository updates the metadata and set a complete date (e.g. 2020-02-12), then this will be the new date for the result because it becomes the most recent most complete date. However, if OpenAIRE then collects the pre-print from another repository with date 2019-02-03, then this will be the “winning date” because it becomes the most frequent well-formatted date.
Main date of the research product: typically the publication or issued date. In case of a research product with different versions with different dates, the date of the research product is selected as the most frequent well-formatted date. If not available, then the most recent and complete date among those that are well-formatted. For statistics, the year is extracted and the research product is counted only among the research products of that year. Example: Pre-print date: 2019-02-03, Article date provided by repository: 2020-02, Article date provided by Crossref: 2020, OpenAIRE will set as date 2019-02-03, because it’s the most recent among the complete and well-formed dates. If then the repository updates the metadata and set a complete date (e.g. 2020-02-12), then this will be the new date for the research product because it becomes the most recent most complete date. However, if OpenAIRE then collects the pre-print from another repository with date 2019-02-03, then this will be the “winning date” because it becomes the most frequent well-formatted date.
```json
"publicationdate": "2021-03-18"
@ -376,7 +376,7 @@ Metadata records about research literature (includes types of publications liste
#### container
_Type: [Container](other#container) &bull; Cardinality: ONE_
Container has information about the conference or journal where the result has been presented or published.
Container has information about the conference or journal where the research product has been presented or published.
```json
"container": {

46
docs/data-model/relationships/relationship-types.md
View File

@ -6,31 +6,31 @@ Note: the labels used to specify the semantic of the relationships are (for the
| # | Source entity type | Target entity type | Relation name / inverse | Provenance |
|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:|
| 1 | [Project](/data-model/entities/project) | [Result](/data-model/entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user |
| 1 | [Project](/data-model/entities/project) | [ResearchProduct](../../data-model/entities/research-product) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user |
| 2 | [Project](/data-model/entities/project) | [Organization](/data-model/entities/organization) | hasParticipant / isParticipant | Harvested |
| 3 | [Project](/data-model/entities/project) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 4 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE |
| 5 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSupplementTo / IsSupplementedBy | Harvested |
| 6 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 7 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPartOf / HasPart | Harvested |
| 8 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDocumentedBy / Documents | Harvested |
| 9 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsObsoletedBy / Obsoletes | Harvested |
| 10 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSourceOf / IsDerivedFrom | Harvested |
| 11 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCompiledBy / Compiles | Harvested |
| 12 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRequiredBy / Requires | Harvested |
| 13 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE |
| 14 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReferencedBy / References | Harvested |
| 15 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReviewedBy / Reviews | Harvested |
| 16 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested |
| 17 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsVersionOf / HasVersion | Harvested |
| 18 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested |
| 19 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested |
| 20 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsContinuedBy / Continues | Harvested |
| 21 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDescribedBy / Describes | Harvested |
| 22 | [Result](/data-model/entities/result) | [Organization](/data-model/entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE |
| 23 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE |
| 24 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isProvidedBy / provides | Harvested |
| 25 | [Result](/data-model/entities/result) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 4 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE |
| 5 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsSupplementTo / IsSupplementedBy | Harvested |
| 6 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 7 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsPartOf / HasPart | Harvested |
| 8 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsDocumentedBy / Documents | Harvested |
| 9 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsObsoletedBy / Obsoletes | Harvested |
| 10 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsSourceOf / IsDerivedFrom | Harvested |
| 11 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsCompiledBy / Compiles | Harvested |
| 12 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsRequiredBy / Requires | Harvested |
| 13 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE |
| 14 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsReferencedBy / References | Harvested |
| 15 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsReviewedBy / Reviews | Harvested |
| 16 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsOriginalFormOf / IsVariantFormOf | Harvested |
| 17 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsVersionOf / HasVersion | Harvested |
| 18 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsIdenticalTo / IsIdenticalTo | Harvested |
| 19 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsPreviousVersionOf / IsNewVersionOf | Harvested |
| 20 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsContinuedBy / Continues | Harvested |
| 21 | [ResearchProduct](../../data-model/entities/research-product) | [ResearchProduct](../../data-model/entities/research-product) | IsDescribedBy / Describes | Harvested |
| 22 | [ResearchProduct](../../data-model/entities/research-product) | [Organization](/data-model/entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE |
| 23 | [ResearchProduct](../../data-model/entities/research-product) | [Data source](/data-model/entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE |
| 24 | [ResearchProduct](../../data-model/entities/research-product) | [Data source](/data-model/entities/data-source) | isProvidedBy / provides | Harvested |
| 25 | [ResearchProduct](../../data-model/entities/research-product) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 26 | [Organization](/data-model/entities/organization) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 27 | [Organization](/data-model/entities/organization) | [Organization](/data-model/entities/organization) | IsChildOf / IsParentOf | Linked by user |
| 28 | [Data source](/data-model/entities/data-source) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |

2
docs/downloads/alternative-model/communityInstance.md
View File

@ -6,7 +6,7 @@ sidebar_position: 1
# CommunityInstance
It is a subclass of [Instance](../../data-model/entities/result#instance) extended with information regarding the collection and hosting source for this materialization of the result.
It is a subclass of [Instance](../../data-model/entities/research-product#instance) extended with information regarding the collection and hosting source for this materialization of the research product.
### hostedby
_Type: [CfHbKeyValue](./cfhb) &bull; Cardinality: ONE_

4
docs/downloads/alternative-model/context.md
View File

@ -6,7 +6,7 @@ sidebar_position: 1
# Context
Information related to research initiative/community (RI/RC) related to the result.
Information related to research initiative/community (RI/RC) related to the research product.
### code
_Type: String &bull; Cardinality: ONE_
@ -31,7 +31,7 @@ Label of the RI/RC.
### provenance
_Type: [Provenance](/data-model/entities/other#provenance-2) &bull; Cardinality: MANY_
Why this result is associated to the RI/RC.
Why this research product is associated to the RI/RC.
```json

7
docs/downloads/alternative-model/extendedresult.md → docs/downloads/alternative-model/extended-research-product.md
View File

@ -5,11 +5,10 @@ sidebar_position: 1
---
# Extended Result
# Extended Research Product
It is a subclass of [Result](/data-model/entities/result) extended with information regarding projects (and funders), research communities/infrastructure and related data sources.
It is a subclass of [ResearchProduct](../../data-model/entities/research-product) extended with information regarding projects (and funders), research communities/infrastructure and related data sources.
### projects
@ -17,7 +16,7 @@ It is a subclass of [Result](/data-model/entities/result) extended with informat
_Type: [Project](project.md) &bull; Cardinality: MANY_
List of projects (i.e. grants) that (co-)funded the production of the research results.
List of projects (i.e. grants) that (co-)funded the production of the research products.
```json

6
docs/downloads/alternative-model/project.md
View File

@ -9,7 +9,7 @@ sidebar_position: 1
# Project
The information about the projects related to the result.
The information about the projects related to a research product.
### id
@ -99,7 +99,7 @@ Information about the funder funding the project.
_Type [Provenance](../../data-model/entities/other#provenance-2) &bull; Cardinality: ONE_
The reason why the project is associated to the result.
The reason why the project is associated to the research product.
```json
@ -119,7 +119,7 @@ The reason why the project is associated to the result.
_Type [Validated](validated.md) &bull; Cardinality: ONE_
Specifies it the association between the project and the result was validated.
Specifies whether the association between the project and the research product was validated.
```json

4
docs/downloads/alternative-model/validated.md
View File

@ -7,7 +7,7 @@ sidebar_position: 1
# Validated
Information about the validtion of the association between the result and the funding information.
Information about the validtion of the association between the research product and the funding information.
### validationDate
@ -15,7 +15,7 @@ Information about the validtion of the association between the result and the fu
_Type: String &bull; Cardinality: ONE_
When OpenAIRE collected the association between the funding and the result from an authoritative source (i.e. Sygma).
When OpenAIRE collected the association between the funding and the research product from an authoritative source (i.e. Sygma).
```json

6
docs/downloads/subgraphs.md
View File

@ -61,10 +61,10 @@ Please refer [here](#alternative-sub-graph-data-model) for details on the data m
It should be noted that the datasets for research communities, infrastructures, and products related to projects do not strictly follow the main data model of the OpenAIRE Graph. In particular, they differ in the following:
* only research products are included (no relations, and entities different from results)
* the results are extended with information that can be inferred in the whole dataset namely:
* only research products are included (no relations or other entities)
* the research products are extended with information that can be inferred in the whole dataset namely:
* funding information if present
* associated research community/infrastructure
* associated data sources
So they have just one entity type, that is the [Extended Result](alternative-model/extendedresult.md).
So they have just one entity type, that is the [Extended Research Product](./alternative-model/extended-research-product.md).

2
docs/graph-production-workflow/aggregation/aggregation.md
View File

@ -38,7 +38,7 @@ Objects and relationships in the OpenAIRE Graph are extracted from information p
- *Hybrid repositories/archives*: information systems where scientists deposit metadata and file of any kind of scientific products, incuding scientific literature, research data and research software (e.g. Zenodo)
- *Aggregator services*: Information systems that collect descriptive metadata about publications or datasets from multiple sources in order to enable cross-data source discovery of given research products. Examples are DataCite, BASE, DOAJ;
- *Entity Registries*: Information systems created with the intent of maintaining authoritative registries of given entities in the scholarly communication, such as OpenDOAR for the institutional repositories, re3data for the data repositories, CORDA and other funder databases for projects and funding information;
- *CRIS*: Information systems adopted by research and academic organizations to keep track of their research administration records and relative results; examples of CRIS content are articles or datasets funded by projects, their principal investigators, facilities acquired thanks to funding, etc..
- *CRIS*: Information systems adopted by research and academic organizations to keep track of their research administration records and relative research products; examples of CRIS content are articles or datasets funded by projects, their principal investigators, facilities acquired thanks to funding, etc..
- *Research Graphs*: services that maintain an information space of (possibly interlinked) scholalrly communication objects. Examples are CrossRef, ScholeXplorer and OpenAIRE itself.
## How does OpenAIRE collect metadata records?

10
docs/graph-production-workflow/aggregation/non-compatible-sources/datacite.md
View File

@ -35,7 +35,7 @@ The metadata collection process identifies the most recent record date available
The table below describes the mapping from the XML baseline records to the OpenAIRE Graph dump format.
| OpenAIRE Result field path | Datacite record JSON path | # Notes |
| OpenAIRE Research Product field path | Datacite record JSON path | # Notes |
|--------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | `\attributes\doi` | id in the form `doi_________::md5(doi)` |
| <ul><li>`instance`</li> <li>`instance.type`</li></ul> | <ul><li>`\attributes\types\resourceType`</li> <li> `\attributes\types\resourceTypeGeneral` </li> <li>`attributes\types\schemaOrg`</li></ul> | Use the vocabulary **_dnet:publication_resource_** to find a synonym to one of these terms and get the `instance.type`. |
@ -69,9 +69,9 @@ The table below describes the mapping from the XML baseline records to the OpenA
| OpenAIRE Relation Semantic and inverse | Datacite record JSON path | Source/Target type | #Notes |
|----------------------------------------|---------------------------------------|---------------------|------------------------------------------------------------------------------------------------------------|
| `isProducedBy/produces` | `attributes\fundingReferences` | `result/project` | only when the fundingReferences matches the pattern `(info:eu-repo/grantagreement/ec/h2020/)(\d{6})(.*)` |
| `IsProvidedBy/provides` | | `result/datasource` | Datasource is always set to `Datacite` |
| `isHostedBy/host` | `\attributes\relationships\client\id` | `result/datasource` | we defined a curated map clientId/Datasource if we found a match we create an _hostedBy Relation_ |
| `isRelatedTo` | `\attribute\relatedIdentifiers` | `result/result` | we create relationships whenever the pid of the target is resolved on the Research Graph |
| `isProducedBy/produces` | `attributes\fundingReferences` | `ResearchProduct/Project` | only when the fundingReferences matches the pattern `(info:eu-repo/grantagreement/ec/h2020/)(\d{6})(.*)` |
| `IsProvidedBy/provides` | | `ResearchProduct/Datasource` | Datasource is always set to `Datacite` |
| `isHostedBy/host` | `\attributes\relationships\client\id` | `ResearchProduct/Datasource` | we defined a curated map clientId/Datasource if we found a match we create an _hostedBy Relation_ |
| `isRelatedTo` | `\attribute\relatedIdentifiers` | `ResearchProduct/ResearchProduct` | we create relationships whenever the pid of the target is resolved on the Research Graph |

16
docs/graph-production-workflow/aggregation/non-compatible-sources/doiboost.md
View File

@ -10,7 +10,7 @@ Each Crossref record is enriched with:
* the following information from MAG:
* abstracts
* MAG identifiers of authors
* affiliation (result - organization) relationships
* affiliation (research product - organization) relationships
* subjects (MAG FieldsOfStudy)
* conference or journal information
@ -66,13 +66,13 @@ Records in Crossref are ruled out according to the following criteria
* `10.7554/elife.21052.049`
* `10.1371/journal.pcbi.1005379.s006`
Records with `type=dataset` are mapped into OpenAIRE results of type dataset. All others are mapped as OpenAIRE results of type publication.
Records with `type=dataset` are mapped into OpenAIRE research products of type dataset. All others are mapped as OpenAIRE research products of type publication.
### Mapping Crossref properties into the OpenAIRE Graph
Properties in OpenAIRE results are set based on the logic described in the following table:
Properties in OpenAIRE research products are set based on the logic described in the following table:
| OpenAIRE Result field path | Crossref path(s) | Notes |
| OpenAIRE Research Product field path | Crossref path(s) | Notes |
|----------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | `doi` | id in the form `doi_________::md5(doi)` |
| `dateofcollection` | `indexed.datetime` | |
@ -119,7 +119,7 @@ Properties in OpenAIRE results are set based on the logic described in the follo
| `instance.pid.value` | `doi` | The doi is normalised and lower-cased |
| `instance.publicationdate` | `issued.datetime` or, if not available, `created.datetime` | |
| `instance.refereed` | | set to `peerReviewed` only if `relation.has-review.id` is not empty, `UNKNOWN` otherwise. |
| `instance.type` | `subtype` | mapped using the [OpenAIRE vocabulary for result typologies](https://api.openaire.eu/vocabularies/dnet:result_typologies) |
| `instance.type` | `subtype` | mapped using the [OpenAIRE vocabulary for research products typologies](https://api.openaire.eu/vocabularies/dnet:result_typologies) |
| `instance.url` | `doi` | Full URL of the DOI |
All other fields of the Json schema not mentioned in the table contain empty values.
@ -133,7 +133,7 @@ Possible improvements:
### Map Crossref links to projects/funders
Links to funding available in Crossref are mapped as funding relationships (`result -- isProducedBy -- project`) applying the following mapping:
Links to funding available in Crossref are mapped as funding relationships (`ResearchProduct -- isProducedBy -- Project`) applying the following mapping:
| Funder | Grant code | Link to |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
@ -166,9 +166,9 @@ The fields we consider from UnpayWall are:
* `best_oa_location`
* `oa_status`
The results of Crossref that intersect by DOI with UnpayWall records are enriched with one additional `instance` with the following properties:
The records of Crossref that intersect by DOI with UnpayWall records are enriched with one additional `instance` with the following properties:
| OpenAIRE Result field path | Unpaywall field path | Notes |
| OpenAIRE Research Product field path | Unpaywall field path | Notes |
|----------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `instance` | | created only if `is_oa` and a `best_oa_location` is available |
| `instance.accessright` | | default value `Open Access`: we do not add instances if UnpayWall says there is no open version |

4
docs/graph-production-workflow/aggregation/non-compatible-sources/ebi.md
View File

@ -74,7 +74,7 @@ We filter all the target links with pid type **ena**, **pdb** or **uniprot**
For each target we construct a Bioentity with the following mapping
| OpenAIRE Result field path | EBI record field xpath | Notes |
| OpenAIRE Research Product field path | EBI record field xpath | Notes |
|-----------------------------|----------------------------------------------------------|---------------------------------------------------------------|
| `id` | `target/identifier/ID` and `target/identifier/IDScheme` | id in the form `SCHEMA_________::md5(pid)` |
| `pid` | `target/identifier/ID` and `target/identifier/IDScheme` | `classid = classname = schema` |
@ -91,4 +91,4 @@ For each target we construct a Bioentity with the following mapping
### Relation Mapping
| OpenAIRE Relation Semantic and inverse | Source/Target type | Notes |
|----------------------------------------|---------------------|--------------------------------------------------------------------------|
| `IsRelatedTo` | `result/result` | we create relationships between the BioEntity and the pubmed publication |
| `IsRelatedTo` | `ResearchProduct/ResearchProduct` | we create relationships between the BioEntity and the pubmed publication |

2
docs/graph-production-workflow/aggregation/non-compatible-sources/pubmed.md
View File

@ -14,7 +14,7 @@ Pubmed exposes an entry point FTP with all the updates for each one. [ftp baseli
The table below describes the mapping from the XML baseline records to the OpenAIRE Graph dump format.
| OpenAIRE Result field path | PubMed record field xpath | Notes |
| OpenAIRE Research Product field path | PubMed record field xpath | Notes |
|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Publication Mapping** | | |
| `id` | `//PMID` | id in the form `pmid_________::md5(pmid)` |

2
docs/graph-production-workflow/aggregation/non-compatible-sources/uniprot.md
View File

@ -10,7 +10,7 @@ From this dataset, only the protein records linked to a PubMed publication are e
The table below describes the mapping from the TEXT metadata format to the OpenAIRE Graph Dataset format.
You can check an example of the text metadata [here](https://rest.uniprot.org/uniprotkb/A0A0C5B5G6.txt)
| OpenAIRE Result field path | FASTA record field xpath | Notes |
| OpenAIRE Research Product field path | FASTA record field xpath | Notes |
|------------------------------|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **BIOEntity Mapping** | | |
| `id` | `LINE Starts with AC` | id in the form `uniprot_____::md5(id)` |

2
docs/graph-production-workflow/cleaning.md
View File

@ -27,7 +27,7 @@ A vocabulary is a data structure that defines a list of terms, and for each term
[...]
```
Each vocabulary is typically used to control and harmonise the values available in a specific field characterising the bibliographic records. The example above provides a preview of the vocabulary used to clean the [result's instance typology](/data-model/entities/result#instance).
Each vocabulary is typically used to control and harmonise the values available in a specific field characterising the bibliographic records. The example above provides a preview of the vocabulary used to clean the [research product's instance typology](../data-model/entities/research-product#instance).
The content of the vocabularies can be accessed on [api.openaire.eu/vocabularies](https://api.openaire.eu/vocabularies/).

10
docs/graph-production-workflow/deduction-and-propagation/bulk-tagging.md
View File

@ -2,23 +2,23 @@
The Deduction process (also known as “bulk tagging”) enriches each record with new information that can be derived from the existing property values.
This process is used to associate results to community/research initiatives that are part of OpenAIRE.
This process is used to associate research products to community/research initiatives that are part of OpenAIRE.
As of November 2022, three procedures are in place to relate a research product to a research initiative, infrastructure (RI) or community (RC) based on:
* subjects: it is possible to specify a list of subjects that are relevant for the RC/RI. Every time one of the subjects is found among the subjects of a result, the result is linked to the RC/RI.
* subjects: it is possible to specify a list of subjects that are relevant for the RC/RI. Every time one of the subjects is found among the subjects of a research products, the research products is linked to the RC/RI.
<p align="center">
<img loading="lazy" alt="Bulktagging Subject" src={require('../../assets/img/enrichment/bulktagging_subject.png').default} width="50%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* data sources: it is possible to list a set of data sources relevant for the RC/RI. All the results collected from these data sources will be linked to the RC/RI
* data sources: it is possible to list a set of data sources relevant for the RC/RI. All research products collected from these data sources will be linked to the RC/RI
<p align="center">
<img loading="lazy" alt="Bulktagging Data source" src={require('../../assets/img/enrichment/bulktagging_datasource.png').default} width="50%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
When only some results collected from a datasource are relevant for the RC/RI, it is possible to specify a set of selection constraints (SC) that have to be verified before linking the result to the
community. The selection constraint has the form <strong>SC = S1 or S2 or ... or Sn</strong>. The generic Si has the form <strong>Si = s<sub>i1</sub> and s<sub>i2</sub> and ...and s<sub>in</sub></strong> and each s<sub>ij</sub> is a condition on a specific field of the result. The set of fields that can be specified is <strong>F={title, author, contributor, description, orcid}</strong>,
When only some research products collected from a datasource are relevant for the RC/RI, it is possible to specify a set of selection constraints (SC) that have to be verified before linking the research product to the
community. The selection constraint has the form <strong>SC = S1 or S2 or ... or Sn</strong>. The generic Si has the form <strong>Si = s<sub>i1</sub> and s<sub>i2</sub> and ...and s<sub>in</sub></strong> and each s<sub>ij</sub> is a condition on a specific field of the research product. The set of fields that can be specified is <strong>F={title, author, contributor, description, orcid}</strong>,
while the set of condition can be among <strong>V={contains, equals, not_contains, not_equals, contains_ignorecase, equals_ignorecase, not_contains_ignorecase, not_equal_ignorecase}</strong>, and the value is free text.
A possible selection criteria can be: “All the products whose contributor contains DARIAH “

24
docs/graph-production-workflow/deduction-and-propagation/propagation.md
View File

@ -5,30 +5,30 @@ relationships and values between the involved entities
As of November 2022, the following procedures are in place:
* Country propagation: updates the property “country” of a results. This happens when the result is collected from an institutional datasource or when the datasource hosting the result is inserted in a whitelist. For all the results whose hosting datasource verifies one of the conditions above, the country of the organization providing the datasource is added to the country of the result: e.g. publication collected from an institutional repository maintained by an italian university will be enriched with the property “country = IT”.
* Country propagation: updates the property “country” of a research product. This happens when the research product is collected from an institutional datasource or when the datasource hosting the research product is inserted in a whitelist. For all the research products whose hosting datasource verifies one of the conditions above, the country of the organization providing the datasource is added to the country of the research product: e.g. publication collected from an institutional repository maintained by an italian university will be enriched with the property “country = IT”.
<p align="center">
<img loading="lazy" alt="Country Propagation" src={require('../../assets/img/enrichment/propagation_country.png').default} width="50%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* Project propagation: adds a "isProducedBy" relationship (and its inverse) between a Project P and Result R1, if R1 has a strong semantic relationship with another Result R2 and P produces R2: e.g. publication linked to project P “is supplemented by” a dataset D. Dataset D will get the link to project P. The relationships considered for this procedure are “isSupplementedBy” and “isSupplementTo”.
* Project propagation: adds a "isProducedBy" relationship (and its inverse) between a Project P and research product R1, if R1 has a strong semantic relationship with another research product R2 and P produces R2: e.g. publication linked to project P “is supplemented by” a dataset D. Dataset D will get the link to project P. The relationships considered for this procedure are “isSupplementedBy” and “isSupplementTo”.
<p align="center">
<img loading="lazy" alt="Project Propagation" src={require('../../assets/img/enrichment/propagation_resulttoproject.png').default} width="40%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* Result to RC/RI through organization propagation. The manager of the RC/RI can specify a set of organizations whose product are relevant for the
* Research product to RC/RI through organization propagation. The manager of the RC/RI can specify a set of organizations whose product are relevant for the
community.
Each result having such a relation of affiliation with at least one organization relevant for the RC/RI will be linked to it.
Each research product having such a relation of affiliation with at least one organization relevant for the RC/RI will be linked to it.
<p align="center">
<img loading="lazy" alt="Result to community through organization propagation" src={require('../../assets/img/enrichment/propagation_resulttocommunitythroughorganization.png').default}
<img loading="lazy" alt="Research product to community through organization propagation" src={require('../../assets/img/enrichment/propagation_resulttocommunitythroughorganization.png').default}
width="50%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* Result to RC/RI through semantic relation: extends the set of products linked to a RC/RI by exploiting strong semantic relationships between the results;
e.g. if a result R1 is associated to the community C and is supplemented by a result R2 then the result R2 will be linked to the community. The relationships considered for this procedure are “isSupplementedBy” and “supplements”.
* Research product to RC/RI through semantic relation: extends the set of products linked to a RC/RI by exploiting strong semantic relationships between the research products;
e.g. if a research product R1 is associated to the community C and is supplemented by a research product R2 then R2 will be linked to the community. The relationships considered for this procedure are “isSupplementedBy” and “supplements”.
<p align="center">
<img loading="lazy" alt="Result to community through semantic relation propagation" src={require('../../assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png').default} width="40%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
<img loading="lazy" alt="Research product to community through semantic relation propagation" src={require('../../assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png').default} width="40%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* ORCID identifiers to result through semantic relation. This propagation enriches the results by adding ORCID identifiers to authors. The added ORCID will be marked as "potential" since they have been inserted through propagation.
The process considers the set of overlapping authors between results (R1 and R2) linked with a strong semantic relationship (IsSupplementedBy, IsSupplementTo).
* ORCID identifiers to research product through semantic relation. This propagation enriches the research products by adding ORCID identifiers to authors. The added ORCID will be marked as "potential" since they have been inserted through propagation.
The process considers the set of overlapping authors between research products (R1 and R2) linked with a strong semantic relationship (IsSupplementedBy, IsSupplementTo).
For each author A in the overlapping set, if R1 provides the ORCID value for A and R2 does not, then the author A in R2 will be enriched with the information of the ORCID found in R1.
<p align="center">
@ -36,14 +36,14 @@ For each author A in the overlapping set, if R1 provides the ORCID value for A a
</p>
* affiliation to organization through institutional repository. This propagation adds one "hasAuthorInstitution" relationship (and its inverse)
between a Result R and Organization O,
between a research product R and Organization O,
if R was collected from a datasource D with type institutional repository, and D was provided by O.
<p align="center">
<img loading="lazy" alt="Affiliation propagation through institutional repository" src={require('../../assets/img/enrichment/propagation_affiliationistrepo.png').default} width="40%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
* affiliation to organization through semantic relation. This propagation adds one "hasAuthorInstitution" relationship (and its inverse) between a
Result R and an Organization O,
research product R and an Organization O,
if R has an affiliation relation with an organization O1 that is in relation "isChildOf" with O.
<p align="center">

6
docs/graph-production-workflow/deduplication/research-products.md
View File

@ -2,12 +2,12 @@
sidebar_position: 1
---
# Research results
# Research products
Duplicates among research results are identified among results of the same type (publications, datasets, software, other research products). If two duplicate results are aggregated one as a dataset and one as a software, for example, they will never be compared and they will never be identified as duplicates.
Duplicates among research products are identified among results of the same type (publications, datasets, software, other research products). If two duplicate research products are aggregated one as a dataset and one as a software, for example, they will never be compared and they will never be identified as duplicates.
OpenAIRE supports different deduplication strategies based on the type of results.
The next sections describe how each stage of the deduplication workflow is faced for research results.
The next sections describe how each stage of the deduplication workflow is faced for research products.
### Candidate identification (clustering)

4
docs/graph-production-workflow/finalisation.md
View File

@ -7,12 +7,12 @@ The output of this final step is the final version of the OpenAIRE Graph.
## Filtering
Bibliographic records that do not meet minimal requirements for being part of the OpenAIRE Graph are eliminated during this phase.
Currently, the only criteria applied horizontally to the entire graph aims at excluding scientific results whose title is not meaningful for citation purposes.
Currently, the only criteria applied horizontally to the entire graph aims at excluding research products whose title is not meaningful for citation purposes.
Then, different criteria are applied in the pre-processing of specific sub-collections:
* [Crossref filtering](/graph-production-workflow/aggregation/non-compatible-sources/doiboost#crossref-filtering)
## Country cleaning
This phase is responsible for removing the country information from result records that match specific criteria. The need for this phase is driven by the fact that some datasources, although referred of national pertinence, they contain material that is not always related to the given country.
This phase is responsible for removing the country information from research products that match specific criteria. The need for this phase is driven by the fact that some datasources, although referred of national pertinence, they contain material that is not always related to the given country.

2
docs/graph-production-workflow/graph-production-workflow.md
View File

@ -1,6 +1,6 @@
# Graph production workflow
OpenAIRE collects metadata records from more than 70K scholarly communication sources from all over the world, including Open Access institutional repositories, data archives, journals. All the metadata records (i.e. descriptions of research products) are put together in a data lake, together with records from Crossref, Unpaywall, ORCID, ROR, and information about projects provided by national and international funders. Dedicated inference algorithms applied to metadata and to the full-texts of Open Access publications enrich the content of the data lake with links between research results and projects, author affiliations, subject classification, links to entries from domain-specific databases. Duplicated organisations and results are identified and merged together to obtain an open, trusted, public resource enabling explorations of the scholarly communication landscape like never before.
OpenAIRE collects metadata records from more than 70K scholarly communication sources from all over the world, including Open Access institutional repositories, data archives, journals. All the metadata records (i.e. descriptions of research products) are put together in a data lake, together with records from Crossref, Unpaywall, ORCID, ROR, and information about projects provided by national and international funders. Dedicated inference algorithms applied to metadata and to the full-texts of Open Access publications enrich the content of the data lake with links between research products and projects, author affiliations, subject classification, links to entries from domain-specific databases. Duplicated organisations and research products are identified and merged together to obtain an open, trusted, public resource enabling explorations of the scholarly communication landscape like never before.
<p align="center">
<img loading="lazy" alt="Data provision" src={require('../assets/img/architecture.png').default} width="100%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>

2
docs/graph-production-workflow/indexing.md
View File

@ -2,7 +2,7 @@
The final version of the OpenAIRE Graph is indexed on a Solr server that is used by the OpenAIRE portals ([EXPLORE](https://explore.openaire.eu), [CONNECT](https://connect.openaire.eu), [PROVIDE](https://provide.openaire.eu)) and APIs, the latter adopted by several third-party applications and organizations, such as:
* The OpenAIRE Graph APIs and Portals will offer to the EOSC (European Open Science Cloud) an Open Science Resource Catalogue, keeping an up to date map of all research results (publications, datasets, software), services, organizations, projects, funders in Europe and beyond.
* The OpenAIRE Graph APIs and Portals will offer to the EOSC (European Open Science Cloud) an Open Science Resource Catalogue, keeping an up to date map of all research products (publications, datasets, software), services, organizations, projects, funders in Europe and beyond.
* DSpace & EPrints repositories can install the OpenAIRE plugin to expose OpenAIRE compliant metadata records via their OAI-PMH endpoint and offer to researchers the possibility to link their depositions to the funding project, by selecting it from the list of project provided by OpenAIRE.

2
docs/graph-production-workflow/indicators-ingestion/impact-indicators.md
View File

@ -1,6 +1,6 @@
# Impact indicators
This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [bipIndicators](/data-model/entities/other#bipindicators) property (found under the [indicators](/data-model/entities/result#indicators) property of the result).
This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [bipIndicators](../../data-model/entities/other#bipindicators) property (found under the [indicators](../../data-model/entities/research-product#indicators) property of the reseach product).
It should be noted that the impact indicators are being calculated on the level of the research output.
Below we explain their main intuition, the way they are calculated, and their most important limitations, in an attempt help avoiding common pitfalls and misuses.

2
docs/graph-production-workflow/indicators-ingestion/indicators-ingestion.md
View File

@ -2,7 +2,7 @@ import DocCardList from '@theme/DocCardList';
# Indicators ingestion
In this step, results are enriched with Impact and Usage Statistics indicators.
In this step, research products are enriched with Impact and Usage Statistics indicators.
The former are provided by [BIP!](https://bip.imsi.athenarc.gr/) while the latter are computed by OpenAIRE's [UsageCounts service](https://usagecounts.openaire.eu/).
<DocCardList />

4
docs/graph-production-workflow/merge-by-id.md
View File

@ -11,13 +11,13 @@ across the various datasources.
This phase is therefore responsible to compensate for such inconsistencies and performs
a global grouping of every record available in the graph:
- entities are grouped by [`id`](../data-model/entities/result#id)
- entities are grouped by [`id`](../data-model/entities/research-product#id)
- relations are grouped by [`source`, `target`, `reltype`](../data-model/relationships/relationship-object)
This ensures that the same record, possibly assigned to different types by different
mappings, appears only once in the graph and under a single typing. In case of clashing
identifiers, the properties are merged (including the provencance information), considering
the following precedence order for the result typing:
the following precedence order for the research product typing:
```
publication > dataset > software > other

2
sidebars.js
View File

@ -31,7 +31,7 @@ const sidebars = {
description: 'The main entities of the OpenAIRE Graph are listed below.'
},
items: [
{ type: 'doc', id: 'data-model/entities/result' },
{ type: 'doc', id: 'data-model/entities/research-product' },
{ type: 'doc', id: 'data-model/entities/data-source' },
{ type: 'doc', id: 'data-model/entities/organization' },
{ type: 'doc', id: 'data-model/entities/project' },

8
versioned_docs/version-7.0.0/apis/_category_.json
View File

@ -1,8 +0,0 @@
{
"label": "Public API",
"position": 4,
"link": {
"type": "doc",
"id": "api"
}
}

308
versioned_docs/version-7.0.0/apis/authentication.md
View File

@ -1,308 +0,0 @@
# Guide for authenticated requests
The OpenAIRE APIs can be accessed over HTTPS both by authenticated and non authenticated requests.
You can use authenticated requests to increase the rate limit of your requests (please refer [here](./terms#authentication--limits) for the current API rate limits).
There are 2 main modes that you can use to authenticate API requests:
* [Personal access tokens](#personal-access-token)
* [Registered services](#registered-services)
In the following, we elaborate on these modes.
## Personal access token
To access the OpenAIRE APIs with better rate limits you can use your personal access token. To have access to the following functionalities you need to login to OpenAIRE. In case you are not already a member you will need to register first and provide your [Personal information](https://develop.openaire.eu/personal-info).
:::info New!
The registration process has been updated! In order to visit the Personal Token and Registered Services functionalities you need to fill in the Personal Information form available [here](https://develop.openaire.eu/personal-info). This update will not affect the operation of your existing services. However, if you want to register a new service or access/modify an existing one, you will need to provide your personal information first.
:::
### How to create your personal access token
To create your personal access token go to [your personal access token page](https://develop.openaire.eu/personal-token) and copy it!
:::info
Your access token is valid for an hour.
:::
:::caution
Do not share your personal access token. Send your personal access token over HTTPS.
:::
### How to use your personal access token
To access the OpenAIRE APIs send your personal access token using the Authorization header.
```js
GET https://api.openaire.eu/{resourceServicePath}
Authorization: Bearer {ACCESS_TOKEN}
```
### An hour is not enough? What to do.
To prolong your access to our APIs you can use a **refresh token** that allows you to programmatically issue a new access token.
To get your refresh tokeng go to [your personal access token page](https://develop.openaire.eu/personal-token) and click the **"Get a refresh token"** button to get your refresh token.
OpenAIRE refresh token expires after 1 month.
In case you already have a refresh token a new one will be issued and the old one will no longer be valid.
Please copy your refresh token and store it confidentially. You will not be able to retrieve it. Do not share your refresh token. Send your refresh token over HTTPS.
Since the OpenAIRE refresh token expires after one month, when a client gets a refresh token, this token must be stored securely to keep it from being used by potential attackers. If a refresh token is leaked, it may be used to obtain new access tokens and access protected resources until a new one is issued or it expires.
To get a personal access token using your refresh token you need to make the following request:
```js
GET https://services.openaire.eu/uoa-user-management/api/users/getAccessToken?refreshToken={your_refresh_token}
```
The response has the following format:
```json
{
"access_token": "...",
"token_type": "Bearer",
"refresh_token": "...",
"expires_in": "...",
"scope": "...",
"id_token": "..."
}
```
## Registered services
If you have a service (client) that you want to interact with the OpenAIRE APIs you need to register it.
:::info
You can register up to 5 services.
:::
We offer two ways of authenticting your service: the Basic Authentication and the Advanced Authentication.
### Which one is for me?
| | How | Client Credential Issuer | Authentication Method |
| --- | --- | --- | --- |
| **Basic** | Client ID & Client Secret | OpenAIRE AAI server | Client Secret (Basic) |
| **Advanced** | Private Key signed JWT | Service owner | Private Key JWT Client Authentication |
For the **Basic Authentication** method the OpenAIRE AAI server generates a pair of _Client ID_ and _Client Secret_ credentials for your service upon its registration. The service sends the client id and client secret when authenticating to the OpenAIRE AAI Server to obtain the access token for the OpenAIRE APIs. The OpenAIRE AAI server checks whether the client id and client secret sent is valid. [Continue reading for the Basic Authentication](#basic-service-authentication-and-registration).
For the **Advanced Authentication** method your service does not send a client secret but it uses a _self signed client assertion_ to authenticate to the OpenAIRE AAI server in order to obtain the access token for the OpenAIRE APIs. The client assertion is a JWT that must be signed with RSASSA using SHA-256 hash algorithm. The OpenAIRE AAI server validates the client assertion using the public key that you have provided upon the service registration. [Continue reading for the Advanced Authentication](#advanced-service-authentication-and-registration).
:::info
The Advanced Authentication method allows the OpenAIRE AAI server to verify that the client authentication request at the token endpoint was signed by your service and not altered in any way. This is more computation intensive compared to the Basic Authentication but it ensures non-repudiation. On the other hand, the Basic Authentication is more lightweight and easy to deploy but it does not provide signature verification, and there is always a possibility of the Client ID/secret credentials being stolen. Note that tThe Advanced authentication method gives a higher level of security to the process as long as it is used correctly, i.e. when the signed JWT has a short duration. When the duration of the JWT is long, the process is no different from the basic one.
:::
### Basic service authentication and registration
To have access to the following functionalities you need to login to OpenAIRE. In case you are not already a member you will need to register first and provide your [Personal information](https://develop.openaire.eu/personal-info).
:::info New!
The registration process has been updated! In order to visit the Personal Token and Registered Services functionalities you need to fill in the Personal Information form available [here](https://develop.openaire.eu/personal-info). This update will not affect the operation of your existing services. However, if you want to register a new service or access/modify an existing one, you will need to provide your personal information first.
:::
For the **Basic Authentication** method the OpenAIRE AAI server generates a pair of _Client ID_ and _Client Secret_ for your service upon its registration. The service uses the client id and client secret to obtain the access token for the OpenAIRE APIs. The OpenAIRE AAI server checks whether the client id and client secret sent is valid.
#### How to register your service
To register your service you need to:
1. Go to your [Registered Services](https://develop.openaire.eu/apis) page and click the **\+ New Service** button.
2. Provide the mandatory information for your service.
3. Select the **Basic** Security level.
4. Click the **Create** button.
Once your service is created, the _Client ID_ and _Client Secret_ will appear on your screen. Click "OK" and your new service will be appear in the list of your [Registered Services](https://develop.openaire.eu/apis) page.
#### How to make a request
##### Step 1. Request for an access token
To make an access token request use the _Client ID_ and _Client Secret_ of your service.
```js
curl -u {CLIENT_ID}:{CLIENT_SECRET} \
-X POST 'https://aai.openaire.eu/oidc/token' \
-d 'grant_type=client_credentials'
```
where **{CLIENT_ID}** and **{CLIENT_SECRET}** are the _Client ID_ and _Client Secret_ assigned to your service upon registration.
The response is:
```json
{
"access_token": ...,
"token_type": "Bearer",
"expires_in": ...
}
```
Store the access token confidentially on the service side.
##### Step 2. Make a request
To access the OpenAIRE APIs send the access token returned in **Step 1**.
```js
GET https://api.openaire.eu/{resourceServicePath}
Authorization: Bearer {ACCESS_TOKEN}
```
### Advanced service authentication and registration
To have access to the following functionalities you need to login to OpenAIRE. In case you are not already a member you will need to register first and provide your [Personal information](https://develop.openaire.eu/personal-info).
:::info New!
The registration process has been updated! In order to visit the Personal Token and Registered Services functionalities you need to fill in the Personal Information form available [here](https://develop.openaire.eu/personal-info). This update will not affect the operation of your existing services. However, if you want to register a new service or access/modify an existing one, you will need to provide your personal information first.
:::
For the **Advanced Authentication** method your service does not send a client secret but it uses a _self signed client assertion_ to obtain the access token for the OpenAIRE APIs. The client assertion is a JWT that must be signed with RSASSA using SHA-256 hash algorithm. The OpenAIRE AAI server validates the client assertion using the public key that you have provided upon the service registration.
#### Prepare to register your service
Before you register your service you need to prepare a pair of a private key and a public key on your side.
:::info
We accept keys signed with RSASSA using SHA-256 hash algorithm.
:::
To create the key pair you have the following options:
* Use OpenAIRE authorization server built in tool. You can access the service here: [https://aai.openaire.eu/oidc/generate-oidc-keystore](https://aai.openaire.eu/oidc/generate-oidc-keystore).
The response is your **Public and Private Keypair** and has the following format:
```json
{
"p" : ...,
"kty" : "RSA",
"q" : ...,
"d" : ...,
"e" : "AQAB",
"kid" : ...,
"qi" : ...,
"dp" : ...,
"alg" : "RS256",
"dq" : ...,
"n" : ....
}
```
Use the public key parameters (kty, e, kid, alg, n) to create your **Public Key** in the following format:
```json
{
"kty": "RSA",
"e": "AQAB",
"kid": ...,
"alg": "RS256",
"n": ...
}
```
:::info
Store both the **Public and Private keypair** and the **Public key**. You will need them to register your service.
:::
:::caution
Store the **Public and Private keypair** confidentially on the service side.
:::
* Use openssl and then convert the keys to jwk format using PEM to JWK scripts, such as [https://github.com/danedmunds/pem-to-jwk](https://github.com/danedmunds/pem-to-jwk). Alternatively, the client application can read the key pair in PEM format and then convert them, using JWK libraries. Use the public key parameters (kty, e, kid, alg, n) to the service registration.
:::info
You can also provide a public key in JWK format that can be accessed using a link.
:::
#### How to register your service
To register your service you need to:
1. Go to your [Registered Services](https://develop.openaire.eu/apis) page and click the **\+ New Service** button.
2. Provide the mandatory information for your service.
3. Select the **Advanced** Security level.
4. Use the public key parameters (kty, e, kid, alg, n) you previously produced to declare your **"Public Key"** **"By value"** in the following format:
```json
{
"kty": "RSA",
"e": "AQAB",
"kid": ...,
"alg": "RS256",
"n": ...
}
```
**\- OR -**
If your service has a public key in JWK format that can be accessed using a link, you can set **“Public Key”** to **“By URL”**.
5. Click the **Create** button.
Once your service is created it will appear in the list of your [Registered Services](https://develop.openaire.eu/apis) page, with the **Service Id** that was automatically assigned to it by the AAI OpenAIRE service.
#### How to make a request
##### Step 1. Create and sign a JWT
Your service must create and sign a JWT and include it in the request to token endpoint as described in the [OpenID Connect Core 1.0, 9. Client Authentication](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication).
To create a JWT you can use [https://mkjose.org/](https://mkjose.org/). To do so you need to create a **payload** that should contain the following claims:
```json
{
"iss": "{SERVICE_ID}",
"sub": "{SERVICE_ID}",
"aud": "https://aai.openaire.eu/oidc/token",
"jti": "{RANDOM_STRING}",
"exp": {EXPIRATION_TIME_OF_SIGNED_JWT}
}
```
* **iss**, _(required)_ the “issuer” claim identifies the principal that issued the JWT. The value is the **Service Id** that was created when you registered your service.
* **sub**, _(required)_ the “subject” claim identifies the principal that is the subject of the JWT. The value is the **Service Id** that was created when you registered your service.
* aud, _(required)_ the “audience” claim identifies the recipients that the JWT is intended for. The value is **https://aai.openaire.eu/oidc/token**>.
* **jti**, _(required)_ The “JWT ID” claim provides a unique identifier for the JWT. The value is a random string.
* **exp**, _(required)_ the “expiration time” claim identifies the expiration time on or after which the JWT **MUST NOT** be accepted for processing. The value is a timestamp in **epoch format**.
Fill in the payload in the form available at [https://mkjose.org/](https://mkjose.org/), select the Signing Algorithm to be **RS256 using SHA-256** and paste the **Public and Private Keypair** previously created.
To check your JWT you can go to [https://jwt.io/](https://jwt.io/). The **header** should contain the following claims:
```json
{
"alg": "RS256",
"kid": ...
}
```
where **kid** is the one of your **Public and Private Keypair** you used to sign the JWT in **Step 1**.
:::caution
Store the signed key confidentially on the service side. You will need it in Step 2.
:::
##### Step 2. Request for an access token
To make an access token request use the _signed JWT_ that you created in **Step 1**. The OpenAIRE AAI server will check if the signed JWT is valid using the public key that you declared in the **"How to register your service"** process.
```js
curl -k -X POST "https://aai.openaire.eu/oidc/token" \
-d "grant_type=client_credentials" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion={signedJWT}"
```
where **{signedJWT}** is the signed JWT created in **Step 1**.
The response is:
```json
{
"access_token": {ACCESS_TOKEN}
"token_type":"Bearer",
"expires_in": ...,
"scope":"openid"
}
```
Store the access token confidentially on the service side.
##### Step 3. Make a request
To access the OpenAIRE APIs send the access token returned in **Step 2**.
```js
GET https://test.openaire.eu/{resourceServicePath}
Authorization: Bearer {ACCESS_TOKEN}
```

50
versioned_docs/version-7.0.0/apis/broker-api.md
View File

@ -1,50 +0,0 @@
# Broker API
## Introduction
The Broker Service is available to use via the OpenAIRE Content Provider Dashboard. Thanks to the Broker, repositories, publishers or aggregators can exchange metadata and enrich their local metadata collection by subscribing to notifications of different types. The Broker is able to notify providers when the OpenAIRE Graph contains information that is not available in the original collection of the data source. In particular, the data source manager can subscribe via the [Content Provider Dashboard](https://provide.openaire.eu) and be notified about:
* Additional PIDs of its publications (e.g. DOIs)
* Links to projects
* ORCID that can be associated to an author of datasource publications
* Links to Open Access versions
* Additional classification subjects (e.g. subjects from standard schemes like ACM, JEL and DDC)
* Abstracts identified in duplicate publications
* Missing publication dates
All Repository managers approaching the Content Provider Dashboard will be offered the possibility to preview a set of enrichments relative to their repository that OpenAIRE can derive from the Graph. More specifically, enrichments will be organized into categories named topics and representing the different types of enrichments OpenAIRE can build. For each topic the preview consists of 100 “enrichment events”, a subset of all the possible enrichments pertinent to a given repository in the OpenAIRE Graph, that the user can explore by applying filters on different criteria and the total number of events that can be potentially built is highlighted in the UI. Repository managers can create subscriptions for specific topics and that include the filtering criteria they used to analyze the enrichments preview, or can subscribe to all the available topics with no restrictions at once. Once the repository manager creates a subscription, the algorithm analyzing the OpenAIRE Graph will produce the full set of enrichments for the manager's repository, possibly far beyond the 100 enrichments available in the preview. The enrichments will be made available as notifications in a dedicated section in the Content Provider Dashboard UI to be further checked as well as through the broker service API for programmatic access. Notifications will be sent to subscribers every time the OpenAIRE Graph will be updated and analyzed to derive the enrichments.
## Usage Example
The following commands indicate how the broker API documented at [api.openaire.eu/broker](https://api.openaire.eu/broker/swagger-ui/index.html) can be used to access the set of enrichments:
1. Get the list of subscriptions for a given subscriber, e.g.
```js
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/subscriptions?email=[subscriber_email]'
```
2. Extract the subscription ID and use it to access the 1st page of enrichment notification records
```js
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/bySubscriptionId/[sub-1234]'
```
3. Extract the scroll ID from the response to request subsequent pages
```js
curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/[scroll_id]'
```
To simplify accessing the enrichment notification records, please check the OpenAIRE broker cmdline client available on [GitHub](https://github.com/openaire/broker-cmdline-client).
## Terms of Use and SLA
APIs are free-to-use (no sign-up needed) by any third-party service
**Metadata license is CC-BY**: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as data source.
**Quality of Service**: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the [data center](http://icm.edu.pl/en/centre-of-technology/) facilities of the [Interdisciplinary Centre for Mathematical and Computational Modelling](http://icm.edu.pl/en/) (ICM).
**APIs rate limits**: please check [here](./authentication).

61
versioned_docs/version-7.0.0/apis/dspace-eprints-api.md
View File

@ -1,61 +0,0 @@
# Dspace & EPrints API
<!-- Bulk access to projects -->
The APIs offer custom access to metadata about projects funded by a selection of international funders for the **DSpace** and **EPrints** platforms. The currently supported funders and relative codes are:
* **FP7:** The 7th Framework Programme funded by the European Commission
* **H2020:** Horizon2020 Programme funded by the European Commission
* **HE:** Horizon Europe Programme funded by the European Commission
* **AKA:** Academy of Finland
* **ARC:** Australian Research Council
* **FWF:** Austrian Science Foundation
* **CHISTERA:** CHIST-ERA
* **CIHR:** Canadian Institutes of Health Research
* **HRZZ:** Croatian Science Foundation
* **EEA:** European Environemnt Agency
* **ANR:** French National Research Agency
* **FCT:** The funding programme of Fundação para a Ciência e a Tecnologia, the national funding agency of Portugal
* **MESTD:** The Ministry of Education, Science and Technological Development of Serbia
* **MZOS:** Ministry of Science, Education and Sports of the Republic of Croatia
* **NHMRC:** Australian National Health and Medical Research Council
* **NIH:** US National Institutes of Health
* **NSF:** US National Science Foundation
* **NSERC:** Natural Sciences and Engineering Research Council of Canada
* **NWO:** The Netherlands Organisation for Scientific Research
* **SFI:** Science Foundation Ireland
* **SSHRC:** Social Sciences and Humanities Research Council
* **SNSF:** Swiss National Science Foundation
* **TARA:** Tara Expeditions Foundation
* **TUBITAK:** The National funder of Turkey
* **UKRI:** United Kingdom Research and Innovation
* **WT:** Wellcome Trust
## DSpace/ePrints
DSpace endpoint: http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL
ePrints endpoint: http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL
The URLs embed the parameters needed to collect projects funded by specific funding stream, where the pattern is FundingStream/FundingSubStream/FundingSubSubStream.
Additional parameters can be concatenated to the URL to refine the results by date (date must be in the form `YYYY-MM-DD`):
* startFrom
* startUntil
* endFrom
* endUntil
## Examples
Get Wellcome Trust projects for EPrints: [http://api.openaire.eu/projects/eprints/WT/ALL/ALL](http://api.openaire.eu/projects/eprints/WT/ALL/ALL)
Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: [http://api.openaire.eu/projects/eprints/FP7/SP2/ALL](http://api.openaire.eu/projects/eprints/FP7/SP2/ALL)
Get EC-FP7 projects for DSpace that started after the given date: [http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01](http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01).
## Terms of Use and SLA
APIs are free-to-use (no sign-up needed) by any third-party service.
**Metadata license is CC-BY**: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as data source.
**Quality of Service**: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the [data center](http://icm.edu.pl/en/centre-of-technology/) facilities of the [Interdisciplinary Centre for Mathematical and Computational Modelling](http://icm.edu.pl/en/) (ICM).
**APIs rate limits**: please check [here](./authentication).

9
versioned_docs/version-7.0.0/apis/home.md
View File

@ -1,9 +0,0 @@
# Public APIs
The OpenAIRE Graph data are accessible through various public APIs. More specifically, the following APIs are currently provided:
* [Search API](./search-api) (an API to search for research results and projects)
* [ScholeXplorer API](https://api.scholexplorer.openaire.eu/swagger-ui/index.html?urls.primaryName=Scholexplorer%20API%20V2.0) (an API offering dataset-publication & dataset-dataset links)
* [DSpace & EPrints API](./dspace-eprints-api) (an API to offer custom access to metadata for projects funded by a selection of international funders for DSpace and EPrints platforms)
* [Broker API](./broker-api) (an API to enrich metadata for repositories, publishers, and aggregators)
It is also worth mentioning that, between 2015 and 2023 a LOD API was being provided but the respective service has been discontinued. Old LOD datasets can be found on Zenodo [here](https://zenodo.org/records/4587369).

31
versioned_docs/version-7.0.0/apis/search-api/projects.md
View File

@ -1,31 +0,0 @@
# Searching for projects
## Endpoints
For research projects: http://api.openaire.eu/search/projects
## Parameters
| Parameter | Option | Description |
| --- | --- | --- |
| page | integer | Page number of the search results. |
| size | integer | Number of results per page. |
| format | json \| xml \| csv \| tsv | The format of the response. The default is xml. |
| model | openaire \| sygma | The data model of the response. Default is openaire. Model sygma is a simplified version of the openaire model. For sygma, only the xml format is available. The relative XML schema is available [here](https://www.openaire.eu/schema/sygma/oaf_sygma_v2.1.xsd). |
| sortBy | `sortBy=field,[ascending\|descending]`; **'field'** is one of: `projectstartdate`, `projectstartyear`, `projectenddate`, `projectendyear`, `projectduration` | The sorting order of the specified field. |
| hasECFunding | true \| false | If hasECFunding is true gets the entities funded by the EC. If hasECFunding is false gets the entities related to projects not funded by the EC. |
| hasWTFunding | true \| false | If hasWTFunding is true gets the entities funded by Wellcome Trust. The results are the same as those obtained with `funder=wt`. If hasWTFunding is false gets the entities related to projects not funded by Wellcome Trust. |
| funder | WT \| EC \| ARC \| ANDS \| NSF \| FCT \| NHMRC | Search for entities by funder. |
| fundingStream | ... | Search for entities by funding stream. |
| FP7scientificArea | ... | Search for FP7 entities by scientific area. |
| keywords | White-space separated list of keywords. | N/A |
| sortBy | `sortBy=field,[ascending\|descending]`; **'field'** is one of: `projectstartdate`, `projectstartyear`, `projectenddate`, `projectendyear`, `projectduration` | The sorting order of the specified field. |
| grantID | Comma separated list of grant identifiers. | Gets the project with the given grant identifier, if any. |
| openairePublicationID | Comma separated list of OpenAIRE identifiers. | Gets the publication with the given openaire identifier, if any. |
| name | White-space separated list of keywords. | Gets the projects whose names contain the given list of keywords. Using double quotes `"` you get an exact match, if any. |
| acronym | N/A | Gets the project with the given acronym, if any. |
| callID | N/A | Search for projects by call identifier. |
| startYear | Year formatted as `YYYY` | Gets the projects that started in the given year. |
| endYear | Year formatted as `YYYY`. | Gets the projects that ended in the given year. |
| participantCountries | Comma separeted list of 2 letter country codes. | Search for projects by participant countries. |
| participantAcronyms | White space separeted list of acronyms of institutions. | Search for projects by participant institutions. |

172
versioned_docs/version-7.0.0/apis/search-api/response-metadata-format.md
View File

@ -1,172 +0,0 @@
# Response metadata format
In this page, we elaborate on the metadata response format, as well as response headers and errors.
## Main response
The OpenAIRE Search API supports the following types of response formats:
* XML
* JSON
* CSV
* TSV
In the next paragraphs, we elaborate on the respective metadata formats.
### XML/JSON
The default format of delivered records is oaf (OpenAIRE Format - current version 1.0):
* XML schema: https://www.openaire.eu/schema/1.0/oaf-1.0.xsd
* Documentation: https://www.openaire.eu/schema/1.0/doc/oaf-1.0.html
For the list of changes [click here](https://www.openaire.eu/openaire-xml-schema-change-announcement).
Note that latest versions of the XML schema and documentation are also available at the following permanent links:
* XML schema: https://www.openaire.eu/schema/latest/oaf.xsd
* Documentation: https://www.openaire.eu/schema/latest/doc/oaf.html
Older versions:
* oaf v0.3 [XML schema](https://www.openaire.eu/schema/0.3/oaf-0.3.xsd) and [documentation](https://www.openaire.eu/schema/0.3/doc/oaf-0.3.html)
* oaf v0.2 [XML schema](https://www.openaire.eu/schema/0.2/oaf-0.2.xsd) and [documentation](https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html)
* oaf v0.1 [XML schema](https://www.openaire.eu/schema/0.1/oaf-0.1.xsd) and [documentation](https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html)
### CSV/TSV
The API returns in comma-separated files (CSV) or tab-separated files (TSV) the following fields:
* Title
* AUthors
* Publicatioy year
* DOI
* Download from
* Publication type
* Journal
* Funder
* Project name (GA Number)
* Access
## Headers
| Name | Description |
| --- | --- |
| x-ratelimit-limit | The maximum number of requests allowed for the client in one time window. |
| x-ratelimit-used | The number of requests already made by the client in the current time window. |
The OpenAIRE APIs use a sliding time window of one hour.
## Errors
### General
404 - Not found
```json
{
"error": "Not found",
"description": "Invald request path."
}
```
429 - Rate limit abuse
```json
{
"error": "Too many requests",
"description": "Request rate exceeded. Slow down."
}
```
### Only for authenticated requests
400 - Missing grant type
```json
{
"error": "invalid_request",
"error_description": "Missing grant type"
}
```
400 - Wrong grant type
```json
{
"error": "unsupported_grant_type",
"error_description": "Unsupported grant type: ..."
}
```
400 - Missing Refresh Token
```json
{
"status" : "error",
"code" : "400",
"message" : "Bad Request",
"description" : "Missing refreshToken parameter"
}
```
401 - Missing username or/and password
```json
{
"error": "unauthorized",
"error_description": "Client id must not be empty!"
}
```
401 - Wrong username or/and password
```json
{
"error": "unauthorized",
"error_description": "Bad credentials"
}
```
401 - Invalid Refresh Token (for authenticated requests)
```json
{
"status" : "error",
"code" : "401",
"message" : "Unauthorised",
"description" : "Invalid refreshToken token"
}
```
401 - Invalid client assertion
```json
{
"error":"invalid_client",
"error_description":"Bad client credentials"
}
```
401 - Client assertion for missing service
```json
{
"error":"invalid_client",
"error_description":"Could not find client {SERVICE_ID}"
}
```
401 - Expired signed jwt
```json
{
"error":"unauthorized",
"error_description":"Assertion Token in expired: {EXPIRATION_TIME}"
}
```
403 - Invalid Access Token
```json
{
"error": "Token invalid",
"description": "Authorization header value invalid."
}
```

98
versioned_docs/version-7.0.0/apis/search-api/results.md
View File

@ -1,98 +0,0 @@
# Searching for research results
## Endpoints
For research products: https://api.openaire.eu/search/researchProducts
By specific type:
* publications: https://api.openaire.eu/search/publications
* research data: https://api.openaire.eu/search/datasets
* research software: https://api.openaire.eu/search/software
* other research products: https://api.openaire.eu/search/other
## General parameters
Endpoint: https://api.openaire.eu/search/researchProducts
| Parameter | Option | Description |
| --- | --- | --- |
| page | integer | Page number of the search results. |
| size | integer | Number of results per page. |
| format | json \| xml \| csv \| tsv | The format of the response. The default is xml. |
| model | openaire \| sygma | The data model of the response. Default is openaire. Model sygma is a simplified version of the openaire model. For sygma, only the xml format is available. The relative XML schema is available [here](https://www.openaire.eu/schema/sygma/oaf_sygma_v2.1.xsd). |
| sortBy | `sortBy=field,[ascending\|descending]`; **'field'** is one of: `dateofcollection`,`resultstoragedate`,`resultstoragedate`, `resultembargoenddate`,`resultembargoendyear`,`resultdateofacceptance`, `resultacceptanceyear`,`influence`,`popularity`, `citationCount`,`impulse` <br/>Multiple sorting is supported by repeating the `sortBy` parameter. | The sorting order of the specified field. |
| hasECFunding | true \| false | If hasECFunding is true gets the entities funded by the EC. If hasECFunding is false gets the entities related to projects not funded by the EC. |
| hasWTFunding | true \| false | If hasWTFunding is true gets the entities funded by Wellcome Trust. The results are the same as those obtained with `funder=wt`. If hasWTFunding is false gets the entities related to projects not funded by Wellcome Trust. |
| funder | WT \| EC \| ARC \| ANDS \| NSF \| FCT \| NHMRC | Search for entities by funder. |
| fundingStream | ... | Search for entities by funding stream. |
| FP7scientificArea | ... | Search for FP7 entities by scientific area. |
| keywords | White-space separated list of keywords. | N/A |
| doi | Comma separated list of DOIs. <br/>Alternatively, it is possible to repeat the parameter for each requested doi. | Gets the research products with the given DOIs, if any. |
| orcid | Comma separated list of ORCID iDs of authors. <br/>Alternatively, it is possible to repeat the parameter for each author ORCID iD. | Gets the research products linked to the given ORCID iD of an author, if any. |
| fromDateAccepted | Date formatted as `YYYY-MM-DD` | Gets the research products whose date of acceptance is greater than or equal the given date. |
| toDateAccepted | Date formatted as `YYYY-MM-DD` | Gets the research products whose date of acceptance is less than or equal the given date. |
| title | White-space separated list of keywords. | Gets the research products whose titles contain the given list of keywords. |
| author | White-space separated list of names and/or surnames. | Search for research products by authors. |
| OA | true \| false | If OA is true gets Open Access research products. If OA is false gets the non Open Access research products |
| projectID | The given grant identifier of the project | Search for research products of the project with the specified projectID |
| country | 2 letter country code | Search for research products associated to the country code |
| influence <br/> | Accepted values: <br/>`C1` for top 0.01% in terms of influence <br/>`C2` for top 0.1% in terms of influence <br/>`C3` for top 1% in terms of influence <br/>`C4` for top 10% in terms of influence <br/>`C5` for average/low in terms of influence <br/> <br/>Comma separated list of values or repeat of the parameter for each value will form a query with OR semantics, eg. `?influence=C1&influence=C2` | Search for research products based on their influence. |
| popularity <br/> | Accepted values: <br/>`C1` for top 0.01% in terms of popularity <br/>`C2` for top 0.1% in terms of popularity <br/>`C3` for top 1% in terms of popularity <br/>`C4` for top 10% in terms of popularity <br/>`C5` for average/low in terms of popularity <br/> <br/>Comma separated list of values or repeat of the parameter for each value will form a query with OR semantics, eg. `?popularity=C1&popularity=C2` | Search for research products based on their popularity. |
| impulse <br/> | Accepted values: <br/>`C1` for top 0.01% in terms of impulse <br/>`C2` for top 0.1% in terms of impulse <br/>`C3` for top 1% in terms of impulse <br/>`C4` for top 10% in terms of impulse <br/>`C5` for average/low in terms of impulse <br/> <br/>Comma separated list of values or repeat of the parameter for each value will form a query with OR semantics, eg. `?impulse=C1&impulse=C2` | Search for research products based on their impulse. |
| citationCount <br/> | Accepted values: <br/>`C1` for top 0.01% in terms of citation count <br/>`C2` for top 0.1% in terms of citation count <br/>`C3` for top 1% in terms of citation count <br/>`C4` for top 10% in terms of citation count <br/>`C5` for average/low in terms of citation count <br/> <br/>Comma separated list of values or repeat of the parameter for each value will form a query with OR semantics, eg. `?citationCount=C1&citationCount=C2` | Search for research products based on their number of citations. |
| openaireProviderID | Comma separated list of identifiers. | Search for research products by openaire data provider identifier. <br/>Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
| openaireProjectID | Comma separated list of identifiers. <br/>Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. | Search for research products by openaire project identifier. Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics. |
| hasProject | true \| false | If hasProject is true gets the research products that have a link to a project. If hasProject is false gets the publications with no links to projects. |
| FP7ProjectID | ... | Search for research products associated to a FP7 project with the given grant number. It is equivalent to a query by `funder=FP7&projectID={grantID}` |
## Parameters for publications
Endpoint: https://api.openaire.eu/search/publications
You can use all the [general research products parameters](#general-parameters) as well as those in the following table.
| Parameter | Option | Description |
| --- | --- | --- |
| instancetype | Comma separated list of publication types. Check [here](http://api.openaire.eu/vocabularies/dnet:publication_resource) to see the possible values | Gets the publication of the given type, if any. |
| originalId | Comma separated list of original identifiers as we get them from the data source. <br/>Alternatively, it is possible to repeat the parameter for each requested identifier. | Gets the publication with the given openaire identifier, if any. |
| sdg | The number of the Sustainable Development Goals `[1-17]`. <br/>Check [here](https://sdgs.un.org/goals) to see the Sustainable Developemnt Goals. | Gets the publications that are classified with the respective Sustainable Development Goal number. |
| fos | The Field of Science classification value. <br/>Check [here](/resources/athenarc_fos_hierarchy.json) to see the Field of Science classification values | Gets the publications that are classified with the respective Field of Science classification value. |
| openairePublicationID | Comma separated list of OpenAIRE identifiers. <br/>Alternatively, it is possible to repeat the parameter for each requested identifier. | Gets the publication with the given openaire identifier, if any. |
| peerReviewed | Accepted values: <br/>true \| false | Specify if the publications are peerReviewed or not. |
| diamondJournal | Accepted values: <br/>true \| false | Specify if the publications are published in a diamond journal or not. |
| publiclyFunded | Accepted values: <br/>true \| false | Specify if the publications are publicly funded or not. |
| green | Accepted values: <br/>true \| false | Specify if the publications are green open access or not. |
| openAccessColor | Accepted values: <br/>`gold`\| `bronze`\| `hybrid` <br/>Comma separated list of values or repeat of the parameter for each value will form a query with OR semantics, eg. `?openAccessColor=gold&openAccessColor=hybrid` | Specify the open access color of a publication. |
## Parameters for research data
Endpoint: https://api.openaire.eu/search/datasets
You can use all the [general research products parameters](#general-parameters) as well as those in the following table.
| Parameter | Option | Description |
| --- | --- | --- |
| openaireDatasetID | Comma separated list of OpenAIRE identifiers. <br/>Alternatively, it is possible to repeat the parameter for each requested identifier. | Gets the research data with the given openaire identifier, if any. |
## Parameters for research software
Endpoint: https://api.openaire.eu/search/software
You can use all the [general research products parameters](#general-parameters) as well as those in the following table.
| Parameter | Option | Description |
| --- | --- | --- |
| openaireSoftwareID | Comma separated list of OpenAIRE identifiers. <br/>Alternatively, it is possible to repeat the parameter for each requested identifier. | Gets the research software with the given openaire identifier, if any. |
## Parameters for other research products
Endpoint: https://api.openaire.eu/search/other
You can use all the [general research products parameters](#general-parameters) as well as those in the following table.
| Parameter | Option | Description |
| --- | --- | --- |
| openaireOtherID | Comma separated list of OpenAIRE identifiers. <br/>Alternatively, it is possible to repeat the parameter for each requested identifier. | Gets the other research products with the given openaire identifier, if any. |

3
versioned_docs/version-7.0.0/apis/search-api/search-api.md
View File

@ -1,3 +0,0 @@
# Search API
The Search API allows developers to access metadata records of the OpenAIRE Graph by performing queries over research results (i.e., publications, data, software, other research products), and projects. The API is intended for metadata discovery and exploration only, hence it does not provide access to the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole graph, developers are encouraged to use the [OpenAIRE full Graph dataset](../../downloads/full-graph).

93
versioned_docs/version-7.0.0/apis/specification-changelog.md
View File

@ -1,93 +0,0 @@
# APIs specification changelog
| Date | Description |
| --- | --- |
| 2024-01-09T11:14:10.524604Z | New parameters for publications. Now you can specifυ if they are peer reviewed, in diamond journal, publicly funded, green and specify their OA colour. |
| 2023-11-30T11:39:10.159187Z | Added impact factor parameters. Now you can sort results and query by impact, influence, impulse and citation count. |
| 2023-11-29T12:26:17.660379Z | New registration and token process available at https://develop.openaire.eu. Updated documentation |
| 2023-05-25T09:16:19.903365Z | new instancetype parameter added |
| 2022-09-29T07:03:32.109909Z | updated URLs to the broker swagger UI |
| 2022-09-28T20:35:13.116653Z | updated URLs to the broker swagger UI |
| 2022-07-28T12:02:06.271154Z | Updated list of funders supported by the API for bulk access to projects: EC Horizon Europe also included |
| 2022-05-11T10:01:33.969973Z | New end point for researchProducts in selective access! FOS and SDG classifications available for publication requests |
| 2022-03-29T15:03:29.583536Z | Graph dataset: add new Scholix version 4 |
| 2021-11-12T12:04:52.900385Z | originalId parameter added |
| 2021-10-18T15:31:18.446582Z | OAI-PMH publisher completely dismissed as announced in January 2021 |
| 2021-10-12T07:46:48.032978Z | orcid parameter added in selective access |
| 2021-04-08T10:28:02.371361Z | Authenticated requests to our APIs are now enabled. |
| 2021-02-26T16:28:15.364435Z | NEWS: new dataset available with research products with project funding information |
| 2021-02-17T07:39:46.051129Z | WIP: broker API documentation |
| 2021-02-11T09:06:41.608115Z | Broker API documentation |
| 2021-02-10T10:17:39.504429Z | Authentication documentation added + broker card + broker dummy page |
| 2021-02-01T08:55:35.496938Z | OAI-PMH shutdown announced for the end of April 2021 |
| 2021-01-15T18:56:04.748404Z | Updated documentation on OpenAIRE Research Graph Datasets |
| 2021-01-15T16:57:08.569766Z | Announcing the shutdown of the OAI-PMH publisher |
| 2019-01-25T15:36:27.264313Z | Added new parameter country for research results |
| 2018-10-17T10:39:56.570815Z | Software and Other research products are available via HTTP API. Documentation has been updated. |
| 2018-04-09T09:20:24.763966Z | Added section on terms of services and SLA in the specific API pages |
| 2018-04-09T08:26:18.897089Z | Added section for terms of use and SLA in the home page |
| 2018-03-21T15:31:13.490821Z | dded page with list of changes generated from the svn log |
| 2018-03-21T14:58:14.569096Z | Added APi rate limits |
| 2018-03-21T14:46:32.362617Z | ignore intellij settings |
| 2018-02-01T14:44:00.743257Z | Latest schema version is 1.0 |
| 2018-01-30T10:29:03.037760Z | removed authorOpenaireId parameter + change the message to say the schema is already changed |
| 2018-01-26T13:09:17.887663Z | Removed openaireAuthorID from API documentation |
| 2018-01-11T14:41:29.910148Z | Rephrase LOD to Linked Open Data |
| 2018-01-11T13:56:40.051318Z | add LOD box in overview.html |
| 2018-01-11T13:48:19.812005Z | Adding warning for schema change |
| 2017-10-23T14:21:15.794995Z | intellij file |
| 2017-10-09T10:43:56.532687Z | Added HTML files for api documentation based on uikit |
| 2017-10-06T12:08:16.603152Z | deleting old API documentation: new will be committed soon by Katerina |
| 2017-10-06T12:04:55.560134Z | copied from dnet40 |
| 2017-05-26T11:44:59.926816Z | removed warning for fundingStream queries |
| 2017-05-25T12:36:43.800409Z | warning and location of the api in the prod infra |
| 2017-03-29T13:58:34.013071Z | reformatted xml and new generated HTML |
| 2017-03-29T13:57:23.196971Z | changed pubdate |
| 2017-03-29T13:46:08.349593Z | added link to the OpenAIRE helpdesk |
| 2017-03-29T13:39:44.386894Z | fixed param hasWTFunding (instead of hasUKFunding) + list of supported funders |
| 2017-03-29T13:37:43.381141Z | param name is dateOfAcceptance not of collection |
| 2017-02-22T09:31:34.767373Z | #2630: informing that incremental harvesting is not supported and updated list of interesting OAI sets |
| 2016-01-18T10:38:57.125792Z | commented warning section |
| 2015-09-15T09:04:00.819955Z | added this week in the warning week |
| 2015-09-15T09:02:37.458839Z | updated supported funders and removed section about the TSV as it is only to be used by NOADs |
| 2015-09-15T08:56:37.943151Z | removed organizations OAI set in the examples. Added FP7Publications. |
| 2015-09-15T08:54:41.579385Z | Updated links to the guidelines |
| 2015-09-15T08:53:06.677011Z | OAI-PMH discards duplicates now |
| 2015-08-26T08:51:32.795385Z | added schema 0.3 as the latest schema |
| 2015-05-18T12:10:24.329058Z | csvn and tsv formats available for search api |
| 2015-03-20T10:54:31.069584Z | fixed tsv URL |
| 2015-03-20T10:49:46.639336Z | updated date |
| 2015-03-20T10:49:11.327980Z | added documentation for the projects2tsv endpoint |
| 2015-03-19T11:18:36.226626Z | minor changes to a couple of sentences |
| 2015-03-13T17:35:01.980176Z | updated the generated html |
| 2015-03-13T17:33:41.882951Z | added list of avaialble funding streams and those that are coming soon |
| 2015-03-13T17:33:02.339565Z | openaire compliance of OAI-PMH |
| 2015-02-04T14:16:56.528188Z | #1062: OAI-PMH and HTTP numbers are not the same becuase of duplicates |
| 2014-12-03T15:17:27.207961Z | #1031: title of eprints/dspace export |
| 2014-11-13T16:11:13.633046Z | Updated date and generated new html |
| 2014-11-13T16:08:12.045544Z | Fixed documentation about datasets |
| 2014-11-11T18:43:18.738678Z | Fixed documentation for publications |
| 2014-11-11T17:09:19.351093Z | added sortby parameter |
| 2014-09-17T09:05:38.726757Z | created tag folder for release |
| 2014-08-04T10:59:48.089720Z | Updated pubdate |
| 2014-08-04T10:58:22.814919Z | Overview cleanup |
| 2014-08-04T10:50:54.515588Z | added links to the latest available schema and documentation |
| 2014-07-24T14:09:49.733958Z | #690: HTTP API documentation for project and other updates. |
| 2014-06-06T08:41:45.731338Z | #550: making it clear we are delivering metadata only. Clenaup. |
| 2014-05-14T16:38:30.702554Z | updated date |
| 2014-05-14T16:35:05.787718Z | re-added OAI set for projects |
| 2014-04-30T10:42:18.355154Z | updated oxygen project with the correct tree structure |
| 2014-04-30T10:41:14.539090Z | Added and commented property to generate output in chunks |
| 2014-04-30T10:40:30.012256Z | mvn generates output with no chunks in a single file: api-doc.html |
| 2014-04-30T10:39:37.875730Z | Main docbook file renamed from book.xml to api-doc.xml |
| 2014-04-30T10:34:16.576722Z | updated OAI-PMH sets: now delivering only results and no other entities. |
| 2014-04-15T09:53:22.158487Z | copied dnet-api-http-doc to new dnet40 codebase |
| 2014-04-10T09:55:41.690052Z | ignore |
| 2014-04-10T09:53:59.192401Z | removed target/*classes from svn |
| 2014-04-09T10:46:05.757155Z | mavenized project. Generates html running mvn docbkx:generate-html. results are then in target/docbkx |
| 2014-04-09T09:18:26.268418Z | added links to xsd and xsd doc in the overview chapter |
| 2014-04-08T12:55:01.169556Z | ticket #300: updated doc for APIs |
| 2014-03-10T18:13:38.784171Z | not a maven project |
| 2014-03-10T18:13:18.180379Z | basic structure for API doc |
| 2014-03-10T13:50:02.957489Z | added files as generated by the archetype docbkx-quickstart-archetype v2.0.15 |
| 2014-03-10T13:45:30.505315Z | created module for HTTP API docbook |

17
versioned_docs/version-7.0.0/apis/terms.md
View File

@ -1,17 +0,0 @@
# Terms of use
## Authentication & limits
The OpenAIRE APIs are free-to-use by any third-party service and can be accessed over HTTPS both by authenticated and unauthenticated requests. The rate limit for the former type of requests is up to 7200 requests per hour, while the latter is up to 60 requests per hour.
To make an authenticated request, you must first [register](https://services.openaire.eu/uoa-user-management/register.jsp). Then, you can go to the [personal access token page](https://develop.openaire.eu/user-info?errorCode=1&redirectUrl=%2Fpersonal-token) in your account, copy your token and use it for up to one hour, [find out more](./authentication).
Our OAuth 2.0 implementation, conforms to the OpenID Connect specification, and is [OpenID Certified](https://openid.net/certification/). OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol. For more information about OAuth2.0 please visit the [OAuth2.0 official site](https://oauth.net/2/). For more information about OpenID Connect please visit the [OpenID Connect official site](https://openid.net/connect/). Also, check [here](http://www.openaire.eu/privacy-policy) for more information on our Privacy Policy.
## Quality of service
OpenAIRE API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the data center facilities of the Interdisciplinary Centre for Mathematical and Computational Modelling (ICM).
## License
OpenAIRE Graph license is CC-BY: the records returned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as a data source.

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-1.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 70 KiB

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-1.zip
View File

Binary file not shown.

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-2.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 60 KiB

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-2.zip
View File

Binary file not shown.

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-3.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 72 KiB

BIN
versioned_docs/version-7.0.0/assets/badges/openaire-badge-3.zip
View File

Binary file not shown.

BIN
versioned_docs/version-7.0.0/assets/img/aggregation.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 96 KiB

BIN
versioned_docs/version-7.0.0/assets/img/architecture.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 394 KiB

BIN
versioned_docs/version-7.0.0/assets/img/data-model-2.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 623 KiB

BIN
versioned_docs/version-7.0.0/assets/img/data-model.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 256 KiB

BIN
versioned_docs/version-7.0.0/assets/img/decisiontree-dataset-orp.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 68 KiB

BIN
versioned_docs/version-7.0.0/assets/img/decisiontree-organization.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 51 KiB

BIN
versioned_docs/version-7.0.0/assets/img/decisiontree-publication.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 74 KiB

BIN
versioned_docs/version-7.0.0/assets/img/decisiontree-software.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 32 KiB

BIN
versioned_docs/version-7.0.0/assets/img/dedup-relation-fixup.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 387 KiB

BIN
versioned_docs/version-7.0.0/assets/img/dedup-results.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 54 KiB

BIN
versioned_docs/version-7.0.0/assets/img/deduplication-workflow.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 34 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/bulktagging_datasource.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 32 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/bulktagging_selconstraints.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 90 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/bulktagging_subject.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 30 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/bulktagging_zenodo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 30 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/organization_tree.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 53 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_affiliationistrepo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 43 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_country.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 41 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_orcid.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 38 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_organizationsemrel.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 37 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_resulttocommunitythroughorganization.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 38 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 41 KiB

BIN
versioned_docs/version-7.0.0/assets/img/enrichment/propagation_resulttoproject.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 43 KiB

185
versioned_docs/version-7.0.0/changelog.md
View File

@ -1,185 +0,0 @@
---
sidebar_position: 12
---
# Versions & changelog
## Versioning
Our versioning policy follows the [Semantic Versioning specification](https://semver.org/).
In our case, given a version `MAJOR.MINOR.PATCH`, we increment the:
* `MAJOR` version when the data model of the Graph changes
* `MINOR` version when the pipeline (e.g., different deduplication method, different implementation for an enrichment process) or major data sources change
* `PATCH` version when the graph data are updated
## Changelog
This section documents all notable changes for each graph version.
---
### v7.0.0
_Start Date: 2023-12-18 &bull; Release Date: 2024-01-06 &bull; Dataset release: **yes**_
#### Added
- the scientific products increased by ~3Mi records (+1.26%)
- the number of relations increased by 28.6Mi (+1%)
- the funded contents increased by 5%, from 3.6Mi to 3,8Mi. Funders that recorded the highest increase include, for example, EC with +120K linked research products, and SFI with +1K products.
#### Changed
This graph release also introduces new indicators to identify results published using specific open access models, in diamond journals, and those that received public funding. These indicators will also be added to the graph dataset in Zenodo. In details:
- `result.isGreen (true, false)`: indicates whether or not the scientific result was published following the green open access model;
- `result.openAccesColor (bronze, gold, hybrid)`: indicates the specific open access model used for the publication;
- `result.isInDiamondJournal (true, false)`: indicates whether or not the result was published in a diamond journal;
- `result.publicly-funded (true, false)`: indicates whether or not the grants acknowledged by the publication come from public funds.
### v6.2.2
_Start Date: 2023-11-07 &bull; Release Date: 2023-11-23 &bull; Dataset release: **no**_
#### Added
- Imported Opencitation's POCI dataset, containing citations among publications in PubMed
- Imported Affiliations from Crossref and from PubMed
- Imported Software Heritage identifiers for Software records
- Extended coverage of Irish funders imported from Crossref
- Peer reviewed material identified with a revised heuristic that allowed to improve the coverage
- Project references identified by TDM increased by ~10%
- Introduced new Field of Science classifications for ~40Mi publications
#### Changed
- Updated Crossref publications to include contents until October 2023
- Updated Datacite contents until October 2023
- Indicators regarding data source downloads and views taken by usage counts from September 2023
### v6.1.1
_Start Date: 2023-09-11 &bull; Release Date: 2023-10-15 &bull; Dataset release: **no**_
#### Added
- Affiliation (result to organization) relations from Crossref
- Links to the full text of research products
- Cleaning for author and publisher names (get rid of tabs, CR characters, \n(s), escape double quotes)
#### Changed
- Projects without a grant code are removed
- Crossref dump from July 2023
- ORCID works without a DOI from March 2023
- Usage counts from July 2023
- Datacite contents from early July 2023
- OpenCitations relations from December 2022
### v6.0.0
_Start Date: 2023-07-26 &bull; Release Date: 2023-08-16 &bull; Dataset release: **yes**_
#### Changed
- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType
- BIP! indicators are now serialised as an array; see the updated model [here](/data-model/entities/other#bipindicators)
- Crossref dump from June 2023
- ORCID works without a DOI from June 2023
- Usage counts from June 2023
- Datacite contents from June 2023
- OpenCitations relations from January 2023
- BIP! indicators from June 2023
- New Datasources/Services were added, collected from an updated EOSC Service catalogue endpoint
### v5.2.0
_Start Date: 2023-07-03 &bull; Release Date: 2023-07-17 &bull; Dataset release: **no**_
#### Added
- Citations imported from Crossref & MAG
- FoS and SDG classifications introduced for ~16Mi research products
#### Changed
- Removed the numerical prefix from the OpenAIRE identifiers (```"20|openorgs____::..." --> "openorgs____::..."```)
- Dataset file names in the Zenodo depositions changed from `dump` to `dataset`
- Crossref dump from May 2023
- ORCID works without a DOI from June 2023
- Usage counts from April 2023
- Datacite contents from June 2023
- OpenCitations relations from January 2023
- Deduplication of the datasource
- Avoid duplicated organisation PIDs
### v5.1.3
_Start Date: 2023-05-22 &bull; Release Date: 2023-06-12 &bull; Dataset release: **no**_
#### Added
- Datasource and project level usage counts
#### Changed
- Crossref dump from April 2023
- ORCID works without a DOI from May 2023
- Usage counts from April 2023
- Datacite contents from May 2023
- OpenCitations relations from January 2023
- Deduplication of the datasource
### v5.1.2
_Start Date: 2023-03-20 &bull; Release Date: 2023-04-04 &bull; Dataset release: **no**_
#### Changed
- Crossref dump from February 2023
- ORCID works without a DOI from March 2023
- Usage counts from February 2023 (+76% Downloads per Datasource for 2023)
- Datacite contents from mid March 2023
- OpenCitations relations from January 2023
### v5.1.1
_Start Date: 2023-02-13 &bull; Release Date: 2023-03-01 &bull; Dataset release: **no**_
#### Added
- Revised SDG classification: improved coverage (+600K classified DOIs)
- General increase of the funded scientific outputs, thanks to the full text mining scanning new OpenAccess publications
- Integrated contents from
- [EMBL-EBIs Protein Data Bank in Europe](/graph-production-workflow/aggregation/non-compatible-sources/ebi)
- [UniProtKB/Swiss-Prot](/graph-production-workflow//aggregation/non-compatible-sources/uniprot)
#### Changed
- Crossref dump from January 2023
- ORCID works without a DOI from January 2023
- Usage counts from January 2023
- Datacite contents from mid February 2023
- OpenCitations relations from December 2022
### v5.1.0
_Start Date: 2023-01-16 &bull; Release Date: 2023-01-30 &bull; Dataset release: **no**_
#### Added
- Revised SDG classification: better accuracy, lower coverage (will improve in the next months)
#### Changed
- Crossref dump from December 2022
- ORCID works without a DOI from January 2023
- Usage counts from December 2022
- DataCite contents from January 2023
---
### v5.0.0
_Start Date: 2022-12-19 &bull; Release Date: 2022-12-28 &bull; Dataset release: **yes**_
#### Added
- [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result
- [Beginner's kit](/downloads/beginners-kit) in the Downloads section
- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types)
#### Changed
- FOS and SDGs were removed from the [result subjects](/data-model/entities/result#subjects)
- Measures were removed from the [result instance](/data-model/entities/result#instance)
- Updated DOIBoost to include publications from Crossref and the works from ORCID with a DOI until November 2022
- Added ORCID works without a DOI from November 2022

8
versioned_docs/version-7.0.0/data-model/_category_.json
View File

@ -1,8 +0,0 @@
{
"label": "Data model",
"position": 3,
"link": {
"type": "doc",
"id": "data-model"
}
}

25
versioned_docs/version-7.0.0/data-model/data-model.md
View File

@ -1,25 +0,0 @@
# Data model
The OpenAIRE Graph comprises several types of [entities](../category/entities) and [relationships](/category/relationships) among them.
The latest version of the JSON schema can be found on the [Downloads](../downloads/full-graph) section.
<p align="center">
<img loading="lazy" alt="Data model" src={require('../assets/img/data-model-2.png').default} width="80%" className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module"/>
</p>
The figure above, presents the graph's data model.
Its main entities are described in brief below:
* [Results](/data-model/entities/result) represent the outcomes (or products) of research activities.
* [Data Sources](/data-model/entities/data-source) are the sources from which the metadata of graph objects are collected.
* [Organizations](/data-model/entities/organization) correspond to companies or research institutions involved in projects,
responsible for operating data sources or consisting the affiliations of Product creators.
* [Projects](/data-model/entities/project) are research project grants funded by a Funding Stream of a Funder.
* [Communities](/data-model/entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances).
:::note Further reading
A detailed report on the OpenAIRE Graph Data Model can be found on [Zenodo](https://zenodo.org/record/2643199).
:::

8
versioned_docs/version-7.0.0/data-model/entities/_category_.json
View File

@ -1,8 +0,0 @@
{
"label": "Entities",
"position": 1,
"link": {
"type": "generated-index",
"description": "The main entities of the OpenAIRE Graph are listed below."
}
}

82
versioned_docs/version-7.0.0/data-model/entities/community.md
View File

@ -1,82 +0,0 @@
---
sidebar_position: 6
---
# Communities
Research communities and research initiatives are intended as groups of people with a common research intent and can be of two types: ​research initiatives or ​research communities​:
* Research initiatives are intended to capture a view of the information space that is "research impact"-oriented, i.e. all products generated due to my research initiative;
* Research communities the latter “research activity” oriented, i.e. all products that may be of interest or related to my research initiative.
For example, the organizations supporting a research infrastructure fall in the first category, while the researchers involved in a discipline fall in the second.
## The `Community` object
### id
_Type: String &bull; Cardinality: ONE_
The OpenAIRE id for the community/research infrastructure, created according to the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers).
```json
"id": "context_____::5b7f9fa40bdc12072249204cedfa7808"
```
### acronym
_Type: String &bull; Cardinality: ONE_
The acronym of the community.
```json
"acronym": "covid-19"
```
### description
_Type: String &bull; Cardinality: ONE_
Description of the research community/research infrastructure
```json
"description": "This portal provides access to publications, research data, projects and software that may be relevant to the Corona Virus Disease (COVID-19). The OpenAIRE COVID-19 Gateway aggregates COVID-19 related records, links them and provides a single access point for discovery and navigation. We tag content from the OpenAIRE Graph (10,000+ data sources) and additional sources. All COVID-19 related research results are linked to people, organizations and projects, providing a contextualized navigation."
```
### name
_Type: String &bull; Cardinality: ONE_
The long name of the community.
```json
"name": "Corona Virus Disease"
```
### subject
_Type: String &bull; Cardinality: MANY_
The list of the subjects associated to the research community (only appies to research communities).
```json
"subject": [
"COVID19",
"SARS-CoV",
"HCoV-19",
...
]
```
### type
_Type: String &bull; Cardinality: ONE_
The type of the community; one of `{ Research Community, Research infrastructure }`.
```json
"type": "Research Community"
```
### zenodo_community
_Type: String &bull; Cardinality: ONE_
The URL of the Zenodo community associated to the Research community/Research infrastructure.
```json
"zenodo_community": "https://zenodo.org/communities/covid-19"
```

294
versioned_docs/version-7.0.0/data-model/entities/data-source.md
View File

@ -1,294 +0,0 @@
---
sidebar_position: 2
---
# Data sources
OpenAIRE entity instances are created out of data collected from various data sources of different kinds, such as publication repositories, dataset archives, CRIS systems, funder databases, etc. Data sources export information packages (e.g., XML records, HTTP responses, RDF data, JSON) that may contain information on one or more of such entities and possibly relationships between them.
For example, a metadata record about a project carries information for the creation of a Project entity and its participants (as Organization entities). It is important, once each piece of information is extracted from such packages and inserted into the OpenAIRE information space as an entity, for such pieces to keep provenance information relative to the originating data source. This is to give visibility to the data source, but also to enable the reconstruction of the very same piece of information if problems arise.
---
## The `DataSource` object
### id
_Type: String &bull; Cardinality: ONE_
The OpenAIRE id of the data source, created according to the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers).
```json
"id": "issn___print::22c514d022b199c346e7f29ca06efc95"
```
### originalId
_Type: String &bull; Cardinality: MANY_
The list of original identifiers associated to the datasource.
```json
"originalId": [
"issn___print::2451-8271",
...
]
```
### pid
_Type: [ControlledField](other#controlledfield) &bull; Cardinality: MANY_
The persistent identifiers for the datasource.
```json
"pid": [
{
"scheme": "DOI",
"value": "10.5281/zenodo.4707307"
},
...
]
```
### datasourcetype
_Type: [ControlledField](other#controlledfield) &bull; Cardinality: ONE_
The datasource type; see the vocabulary [dnet:datasource_typologies](https://api.openaire.eu/vocabularies/dnet:datasource_typologies).
```json
"datasourcetype": {
"scheme": "pubsrepository::journal",
"value": "Journal"
}
```
### openairecompatibility
_Type: String &bull; Cardinality: ONE_
The OpenAIRE compatibility of the ingested results, indicates which guidelines they are compliant according to the vocabulary [dnet:datasourceCompatibilityLevel](https://api.openaire.eu/vocabularies/dnet:datasourceCompatibilityLevel).
```json
"openairecompatibility": "collected from a compatible aggregator"
```
### officialname
_Type: String &bull; Cardinality: ONE_
The official name of the datasource.
```json
"officialname": "Recent Patents and Topics on Medical Imaging"
```
### englishname
_Type: String &bull; Cardinality: ONE_
The English name of the datasource.
```json
"englishname": "Recent Patents and Topics on Medical Imaging"
```
### websiteurl
_Type: String &bull; Cardinality: ONE_
The URL of the website of the datasource.
```json
"websiteurl": "http://dspace.unict.it/"
```
### logourl
_Type: String &bull; Cardinality: ONE_
The URL of the logo for the datasource.
```json
"logourl": "https://impactum-journals.uc.pt/public/journals/26/pageHeaderLogoImage_en_US.png"
```
### dateofvalidation
_Type: String &bull; Cardinality: ONE_
The date of validation against the OpenAIRE guidelines for the datasource records.
```json
"dateofvalidation": "2016-10-10"
```
### description
_Type: String &bull; Cardinality: ONE_
The description for the datasource.
```json
"description": "Recent Patents on Medical Imaging publishes review and research articles, and guest edited single-topic issues on recent patents in the field of medical imaging. It provides an important and reliable source of current information on developments in the field. The journal is essential reading for all researchers involved in Medical Imaging."
```
### subjects
_Type: String &bull; Cardinality: MANY_
List of subjects associated to the datasource
```json
"subjects": [
"Medicine",
"Imaging",
...
]
```
### languages
_Type: String &bull; Cardinality: MANY_
The languages present in the data source's content, as defined by OpenDOAR.
```json
"languages":[
"eng",
...
]
```
### contenttypes
_Type: String &bull; Cardinality: MANY_
Types of content in the data source, as defined by OpenDOAR
```json
"contenttypes": [
"Journal articles",
...
]
```
### releasestartdate
_Type: String &bull; Cardinality: ONE_
Releasing date of the data source, as defined by re3data.org.
```json
"releasestartdate": "2010-07-24"
```
### releaseenddate
_Type: String &bull; Cardinality: ONE_
Date when the data source went offline or stopped ingesting new research data. As defined by re3data.org
```json
"releaseenddate": "2016-03-28"
```
### accessrights
_Type: String &bull; Cardinality: ONE_
Type of access to the data source, as defined by re3data.org. Possible values: `{ open, restricted, closed }`.
```json
"accessrights": "open"
```
### uploadrights
_Type: String &bull; Cardinality: ONE_
Type of data upload, as defined by re3data.org; one of `{ open, restricted, closed }`.
```json
"uploadrights": "closed"
```
### databaseaccessrestriction
_Type: String &bull; Cardinality: ONE_
Access restrictions to the research data repository. Allowed values are: `{ feeRequired, registration, other }`.
This field only applies for re3data data source; see [re3data schema specification](https://gfzpublic.gfz-potsdam.de/rest/items/item_758898_6/component/file_775891/content) for more details.
```json
"databaseaccessrestriction": "registration"
```
### datauploadrestriction
_Type: String &bull; Cardinality: ONE_
Upload restrictions applied by the datasource, as defined by re3data.org. One of `{ feeRequired, registration, other }`.
This field only applies for re3data data source; see [re3data schema specification](https://gfzpublic.gfz-potsdam.de/rest/items/item_758898_6/component/file_775891/content) for more details.
```json
"datauploadrestriction": "feeRequired registration"
```
### versioning
_Type: Boolean &bull; Cardinality: ONE_
Whether the research data repository supports versioning:
`yes` if the data source supports versioning, `no` otherwise.
This field only applies for re3data data source; see [re3data schema specification](https://gfzpublic.gfz-potsdam.de/rest/items/item_758898_6/component/file_775891/content) for more details.
```json
"versioning": true
```
### citationguidelineurl
_Type: String &bull; Cardinality: ONE_
The URL of the data source providing information on how to cite its items. The DataCite citation format is recommended (http://www.datacite.org/whycitedata).
This field only applies for re3data data source; see [re3data schema specification](https://gfzpublic.gfz-potsdam.de/rest/items/item_758898_6/component/file_775891/content) for more details.
```json
"citationguidelineurl": "https://physionet.org/about/#citation"
```
### pidsystems
_Type: String &bull; Cardinality: ONE_
The persistent identifier system that is used by the data source. As defined by re3data.org.
```json
"pidsystems": "hdl"
```
### certificates
_Type: String &bull; Cardinality: ONE_
The certificate, seal or standard the data source complies with. As defined by re3data.org.
```json
"certificates": "WDS"
```
### policies
_Type: String &bull; Cardinality: MANY_
Policies of the data source, as defined in OpenDOAR.
### journal
_Type: [Container](other#container) &bull; Cardinality: ONE_
Information about the journal, if this data source is of type Journal.
```json
"container": {
"edition": "",
"iss": "5",
"issnLinking": "",
"issnOnline": "1873-7625",
"issnPrinted":"2451-8271",
"name": "Recent Patents and Topics on Imaging",
"sp": "12",
"ep": "22",
"vol": "50"
}
```
### missionstatementurl
_Type: String &bull; Cardinality: ONE_
The URL of a mission statement describing the designated community of the data source. As defined by re3data.org
```json
"missionstatementurl": "https://www.sigma2.no/content/nird-research-data-archive"
```

94
versioned_docs/version-7.0.0/data-model/entities/organization.md
View File

@ -1,94 +0,0 @@
---
sidebar_position: 3
---
# Organizations
Organizations include companies, research centers or institutions involved as project partners or as responsible of operating data sources. Information about organizations are collected from funder databases like CORDA, registries of data sources like OpenDOAR and re3Data, and CRIS systems, as being related to projects or data sources.
---
## The `Organization` object
### id
_Type: String &bull; Cardinality: ONE_
The OpenAIRE id for the organization, created according to the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers).
```json
"id": "openorgs____::b84450f9864182c67b8611b5593f4250"
```
### legalshortname
_Type: String &bull; Cardinality: ONE_
The legal name in short form of the organization.
```json
"legalshortname": "ARC"
```
### legalname
_Type: String &bull; Cardinality: ONE_
The legal name of the organization.
```json
"legalname": "Athena Research and Innovation Center In Information Communication & Knowledge Technologies"
```
### alternativenames
_Type: String &bull; Cardinality: MANY_
Alternative names that identify the organization.
```json
"alternativenames": [
"Athena Research and Innovation Center In Information Communication & Knowledge Technologies",
"Athena RIC",
"ARC",
...
]
```
### websiteurl
_Type: String &bull; Cardinality: ONE_
The websiteurl of the organization.
```json
"websiteurl": "https://www.athena-innovation.gr/el/announce/pressreleases.html"
```
### country
_Type: [Country](other#country) &bull; Cardinality: ONE_
The country where the organization is located.
```json
"country":{
"code": "GR",
"label": "Greece"
}
```
### pid
_Type: [OrganizationPid](other#organizationpid) &bull; Cardinality: MANY_
The list of persistent identifiers for the organization.
```json
"pid": [
{
"scheme": "ISNI",
"value": "0000 0004 0393 5688"
},
{
"scheme": "GRID",
"value":
"grid.19843.37"
},
...
]
```

884
versioned_docs/version-7.0.0/data-model/entities/other.md
View File

@ -1,884 +0,0 @@
---
sidebar_position: 7
---
# Other component objects
Here, we describe other component objects that are used as part of the main graph entities.
## AccessRight
Subclass of [BestAccessRight](#bestaccessright), indicates information about rights held in and over the resource and the open Access Route.
### openAccessRoute
_Type: One of `{ gold, green, hybrid, bronze }` &bull; Cardinality: ONE_
Indicates the OpenAccess status. Values are set according to the [Unpaywall methodology](https://support.unpaywall.org/support/solutions/articles/44001777288-what-do-the-types-of-oa-status-green-gold-hybrid-and-bronze-mean-).
```json
"openAccessRoute": "gold"
```
## AlternateIdentifier
Type used to represent the information associated to persistent identifiers associated to the result that have not been forged by an authority for that pid type. For example we collect metadata from an institutional repository that provides as identifier for the result also the doi.
### scheme
_Type: String &bull; Cardinality: ONE_
Vocabulary reference.
```json
"scheme": "doi"
```
### value
_Type: String &bull; Cardinality: ONE_
Value from the given scheme/vocabulary.
```json
"value": "10.1016/j.respol.2021.104226"
```
## APC
Indicates the money spent to make a book or article available in Open Access. Sources for this information includes the OpenAPC initiative.
### currency
_Type: String &bull; Cardinality: ONE_
The system of money in which the amount is expressed (Euro, USD, etc).
```json
"currency": "EU"
```
### amount
_Type: String &bull; Cardinality: ONE_
The quantity of money.
```json
"amount": "1000"
```
## Author
Represents the result author.
### fullname
_Type: String &bull; Cardinality: ONE_
Author's full name.
```json
"fullname": "Turunen, Heidi"
```
### name
_Type: String &bull; Cardinality: ONE_
Author's given name.
```json
"name": "Heidi"
```
### surname
_Type: String &bull; Cardinality: ONE_
Author's family name.
```json
"surname": "Turunen"
```
### rank
_Type: String &bull; Cardinality: ONE_
Author's order in the list of authors for the given result.
```json
"rank": 1
```
### pid
_Type: [AuthorPid](#authorpid) &bull; Cardinality: ONE_
Persistent identifier associated with this author.
```json
"pid": {
"id": {
"scheme": "orcid",
"value": "0000-0001-7169-1177"
},
"provenance": {
"provenance": "Harvested",
"trust": "0.9"
}
}
```
## AuthorPid
The author's persistent identifier.
### id
_Type: [AuthorPidSchemaValue](#authorpidschemavalue) &bull; Cardinality: ONE_
```json
"id": {
"scheme": "orcid",
"value": "0000-0001-7169-1177"
}
```
### provenance
_Type: [Provenance](#provenance-2) &bull; Cardinality: ONE_
The reason why the pid was associated to the author.
```json
"provenance": {
"provenance": "Inferred by OpenAIRE",
"trust": "0.85"
}
```
## AuthorPidSchemaValue
Type used to represent the scheme and value for the author's pid.
### schema
_Type: String &bull; Cardinality: ONE_
The author's pid scheme. OpenAIRE currently supports ORCID.
```json
"scheme": "orcid"
```
### value
_Type: String &bull; Cardinality: ONE_
The author's pid value in that scheme.
```json
"value": "0000-1111-2222-3333"
```
## BestAccessRight
Indicates the most open access rights \*available among the result Instances.
\* where the openness is defined by the ordering of the access right terms in the following.
```
OPEN SOURCE > OPEN > EMBARGO (6MONTHS) > EMBARGO (12MONTHS) > RESTRICTED > CLOSED > UNKNOWN
```
### code
_Type: String &bull; Cardinality: ONE_
COAR access mode code: http://vocabularies.coar-repositories.org/documentation/access_rights/.
```json
"code": "c_16ec"
```
### label
_Type: String &bull; Cardinality: ONE_
Label for the access mode.
```json
"label": "RESTRICTED"
```
### scheme
_Type: String &bull; Cardinality: ONE_
Scheme of reference for access right code. Currently, always set to COAR access rights vocabulary: http://vocabularies.coar-repositories.org/documentation/access_rights/.
```json
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
```
## BipIndicator
The different impact indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/).
### indicator
_Type: String &bull; Cardinality: ONE_
The name of indicator; it can be either one of:
* `influence`: it reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
* `influence_alt`: it is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
* `popularity`: it reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
* `popularity_alt`: it is an alternative to the "Popularity" indicator, which also reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
* `impulse`: it reflects the initial momentum of an article directly after its publication, based on the underlying citation network.
For more details on how these indicators are calculated, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators).
```json
"influence": {
"score": "123",
"class": "C2"
}
```
### class
_Type: String &bull; Cardinality: ONE_
The impact class assigned based on the indicator score.
To facilitate comprehension, BIP! also offers impact classes for articles, to group together those that have similar impact. The following 5 classes are provided:
* `C1`: Top 0.01%
* `C2`: Top 0.1%
* `C3`: Top 1%
* `C4`: Top 10%
* `C5`: Bottom 90%
```json
"class": "C2"
```
### score
_Type: String &bull; Cardinality: ONE_
The actual indicator score.
```json
"score": "1234"
```
## Container
This field has information about the conference or journal where the result has been presented or published.
### name
_Type: String &bull; Cardinality: ONE_
Name of the journal or conference.
```json
"name": "Research Policy"
```
### issnPrinted
_Type: String &bull; Cardinality: ONE_
The journal printed issn.
```json
"issnPrinted": "0048-7333"
```
### issnOnline
_Type: String &bull; Cardinality: ONE_
The journal online issn.
```json
"issnOnline": "1873-7625"
```
### issnLinking
_Type: String &bull; Cardinality: ONE_
The journal linking issn.
### iss
_Type: String &bull; Cardinality: ONE_
The journal issue.
```json
"iss": "5"
```
### sp
_Type: String &bull; Cardinality: ONE_
The start page.
```json
"sp": "12"
```
### ep
_Type: String &bull; Cardinality: ONE_
The end page.
```json
"ep": "22"
```
### vol
_Type: String &bull; Cardinality: ONE_
The journal volume.
```json
"vol": "50"
```
### edition
_Type: String &bull; Cardinality: ONE_
The edition of the journal or conference.
### conferenceplace
_Type: String &bull; Cardinality: ONE_
The place of the conference.
```json
"conferenceplace": "Padua, Italy"
```
### conferencedate
_Type: String &bull; Cardinality: ONE_
The date of the conference.
```json
"conferencedate": "2022-09-22"
```
## ControlledField
<!-- <span className="todo">TODO: similar to AlternateIdentifier and ResultPid?</span> -->
Generic type used to represent the information described by a scheme and a value in that scheme (i.e. pid).
### scheme
_Type: String &bull; Cardinality: ONE_
Vocabulary reference.
```json
"scheme": "DOI"
```
### value
_Type: String &bull; Cardinality: ONE_
Value from the given scheme/vocabulary.
```json
"value": "10.5281/zenodo.4707307"
```
## Country
To represent the generic country code and label.
### code
_Type: String &bull; Cardinality: ONE_
ISO 3166-1 alpha-2 country code.
```json
"code" : "IT"
```
### label
_Type: String &bull; Cardinality: ONE_
The country label.
```json
"label": "Italy"
```
## Funding
Funding information for a project.
### funding_stream
_Type: [FundingStream](#fundingstream) &bull; Cardinality: ONE_
Funding information for the project.
```json
"funding_stream": {
"description": "Horizon 2020 Framework Programme - Research and Innovation action",
"id": "EC::H2020::RIA"
}
```
### jurisdiction
_Type: String &bull; Cardinality: ONE_
Geographical jurisdiction (e.g. for European Commission is EU, for Croatian Science Foundation is HR).
```json
"jurisdiction": "EU"
```
### name
_Type: String &bull; Cardinality: ONE_
The name of the funder.
```json
"name": "European Commission"
```
### shortName
_Type: String &bull; Cardinality: ONE_
The short name of the funder.
```json
"shortName": "EC"
```
## FundingStream
Description of a funding stream.
### id
_Type: String &bull; Cardinality: ONE_
The identifier of the funding stream.
```json
"id": "EC::H2020::RIA"
```
### description
_Type: String &bull; Cardinality: ONE_
Short description of the funding stream.
```json
"description": "Horizon 2020 Framework Programme - Research and Innovation action"
```
## GeoLocation
Represents the geolocation information.
### point
_Type: String &bull; Cardinality: ONE_
A point with Latitude and Longitude.
```json
"point": "7.72486 50.1084"
```
### box
_Type: String &bull; Cardinality: ONE_
A specified bounding box defined by two longitudes (min and max) and two latitudes (min and max).
```json
"box": "18.569386 54.468973 18.066832 54.83707"
```
### place
_Type: String &bull; Cardinality: ONE_
The name of a specific place.
```json
"place": "Tübingen, Baden-Württemberg, Southern Germany"
```
## Grant
The money granted to a project.
### currency
_Type: String &bull; Cardinality: ONE_
The currency of the granted amount (e.g. EUR).
```json
"currency": "EUR"
```
### fundedamount
_Type: Number &bull; Cardinality: ONE_
The funded amount.
```json
"fundedamount": 1.0E7
```
### totalcost
_Type: Number &bull; Cardinality: ONE_
The total cost of the project.
```json
"totalcost": 1.0E7
```
## H2020Programme
The H2020 programme funding a project.
### code
_Type: String &bull; Cardinality: ONE_
The code of the programme.
```json
"code": "H2020-EU.1.4.1.3."
```
### description
_Type: String &bull; Cardinality: ONE_
The description of the programme.
```json
"description": "Development, deployment and operation of ICT-based e-infrastructures"
```
## Instance
An instance is one specific materialization or version of the result. For example, you can have one result with three instances as result of deduplication:
* one is the pre-print
* one is the post-print
* one is the published version
Each instance is characterized by the properties that follow.
### accessright
_Type: [AccessRight](#accessright) &bull; Cardinality: ONE_
Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights/), describes the access rights of the web resources relative to this instance.
```json
"accessright": {
"code": "c_abf2",
"label": "OPEN",
"openAccessRoute": "gold",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
}
```
### alternateIdentifier
_Type: [AlternateIdentifier](#alternateidentifier) &bull; Cardinality: MANY_
All the identifiers associated to the result other than the authoritative ones.
```json
"alternateIdentifier": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
},
...
]
```
### articleprocessingcharge
_Type: [APC](#apc) &bull; Cardinality: ONE_
The money spent to make this book or article available in Open Access. Source for this information is the OpenAPC initiative.
```json
"articleprocessingcharge": {
"currency": "EUR",
"amount": "1000"
}
```
### license
_Type: String &bull; Cardinality: ONE_
The license URL.
```json
"license": "http://creativecommons.org/licenses/by-nc/4.0"
```
### pid
_Type: [ResultPid](#resultpid) &bull; 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": [
{
"scheme": "pmc",
"value": "PMC8024784"
},
...
]
```
### publicationdate
_Type: String &bull; Cardinality: ONE_
The publication date of the research product.
```json
"publicationdate": "2009-02-12"
```
### refereed
_Type: String &bull; Cardinality: ONE_
Describes if this instance has been peer-reviewed or not. Allowed values are peerReviewed, nonPeerReviewed, UNKNOWN (as defined in https://api.openaire.eu/vocabularies/dnet:review_levels). For example:
* peerReviewed: https://api.openaire.eu/vocabularies/dnet:review_levels/0001
* nonPeerReviewed: https://api.openaire.eu/vocabularies/dnet:review_levels/0002
based on guidelines covers the vocabularies
* [DRIVE guidelines 2.0 - info:eu-repo/semantic](https://wiki.surfnet.nl/download/attachments/10851536/DRIVER_Guidelines_v2_Final_2008-11-13.pdf) (OpenAIRE v1.0 till v3.0 - Literature)
* [COAR Vocabulary v2.0 and v3.0](https://vocabularies.coar-repositories.org/resource_types/) (OpenAIRE v4 - Inst.+Them.)
```json
"refereed": "UNKNOWN"
```
### type
_Type: String &bull; Cardinality: ONE_
The specific sub-type of this instance (see https://api.openaire.eu/vocabularies/dnet:result_typologies following the links)
```json
"type": "Article"
```
### url
_Type: String &bull; 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": [
"https://periodicos2.uesb.br/index.php/folio/article/view/4296",
...
]
```
## Indicator
These are indicators computed for a specific OpenAIRE result.
Each Indicator object is composed of the following properties:
### bipIndicators
_Type: [BipIndicator](#bipindicator) &bull; Cardinality: MANY_
These impact-based indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), estimate the impact of a result.
For details about their calculation, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators).
```json
"bipIndicators": [
{
"indicator": "influence",
"score": "123",
"class": "C2"
},
{
"indicator": "influence_alt",
"score": "456",
"class": "C3"
},
{
"indicator": "popularity",
"score": "234",
"class": "C1"
},
{
"indicator": "popularity_alt",
"score": "345",
"class": "C5"
},
{
"indicator": "impulse",
"score": "987",
"class": "C3"
}
]
```
### usageCounts
_Type: [UsageCounts](#usagecounts-1) &bull; Cardinality: ONE_
These measures, computed by the [UsageCounts Service](https://usagecounts.openaire.eu/), are based on usage statistics.
Please refer [here](/graph-production-workflow/indicators-ingestion/usage-counts) for more details.
```json
"usageCounts":{
"downloads": "10",
"views": "20"
}
```
## Language
Represents information for the language of the result
### code
_Type: String &bull; Cardinality: ONE_
Alpha-3/ISO 639-2 code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages).
```json
"code": "eng"
```
### label
_Type: String &bull; Cardinality: ONE_
Language label in English.
```json
"label": "English"
```
## OrganizationPid
The schema and value for identifiers of the organization.
### scheme
_Type: String &bull; Cardinality: ONE_
Vocabulary reference (i.e. isni).
```json
"scheme" : "GRID"
```
### value
_Type: String &bull; Cardinality: ONE_
Value from the given scheme/vocabulary (i.e. 0000000090326370).
```json
"value" : "grid.7119.e"
```
## Provenance
Indicates the process that produced (or provided) the information, and the trust associated to the information.
### provenance
_Type: String &bull; Cardinality: ONE_
Provenance term from the vocabulary [dnet:provenanceActions](https://api.openaire.eu/vocabularies/dnet:provenanceActions).
```json
"provenance": "Harvested"
```
### trust
_Type: String &bull; Cardinality: ONE_
Trust, expressed as a number in the range [0-1].
```json
"trust": "0.9"
```
## ResultCountry
It is for the country associated to the result.
It is a subclass of [Country](#country) and extends it with provenance information.
### provenance
_Type: [Provenance](#provenance-2) &bull; Cardinality: ONE_
Indicates the reason why this country is associated to this result.
```json
"provenance": {
"provenance": "inferred by OpenAIRE",
"trust": "0.85"
}
```
## ResultPid
Type used to represent the information associated to persistent identifiers for the result that have been forged by an authority for that pid type.
<!-- <span className="todo">Seems to be similar to the AlternateIdentifier. What is the difference?</span> -->
### scheme
_Type: String &bull; Cardinality: ONE_
The scheme of the persistent identifier for the result (i.e. doi). If the pid is here it means the information for the pid has been collected from an authority for that pid type (i.e. Crossref/Datacite for doi). The set of authoritative pid is: `doi` when collected from Crossref or Datacite, `pmid` when collected from EuroPubmed, `arxiv` when collected from arXiv, `handle` from the repositories.
```json
"scheme": "doi"
```
### value
_Type: String &bull; Cardinality: ONE_
The value expressed in the scheme (i.e. 10.1000/182).
```json
"value": "10.21511/bbs.13(3).2018.13"
```
## Subject
Represents keywords associated to the result.
### subject
_Type: [SubjectSchemeValue](#subjectschemevalue) &bull; Cardinality: ONE_
Contains the subject term: subject type (keyword, MeSH, etc) and the subject term (medicine, chemistry, etc.).
```json
"subject": {
"scheme": "keyword",
"value": "SVOC"
}
```
### provenance
_Type: [Provenance](#provenance-2) &bull; Cardinality: ONE_
Contains provenance information for the subject term.
```json
"provenance": {
"provenance": "Harvested",
"trust": "0.9"
}
```
## SubjectSchemeValue
Subject classification against a vocabulary
### scheme
_Type: String &bull; Cardinality: ONE_
OpenAIRE subject classification scheme (https://api.openaire.eu/vocabularies/dnet:subject_classification_typologies).
```json
"scheme" : "keyword"
```
### value
_Type: String &bull; Cardinality: ONE_
The value for the subject in the selected scheme. When the scheme is 'keyword', it means that the subject is free-text (i.e. not a term from a controlled vocabulary).
```json
"value" : "pyrolysis-oil"
```
## UsageCounts
The usage counts indicator computed for this result.
### views
_Type: String &bull; Cardinality: ONE_
The number of views for this result.
```json
"views": "10"
```
### downloads
_Type: String &bull; Cardinality: ONE_
The number of downloads for this result.
```json
"downloads": "5"
```

171
versioned_docs/version-7.0.0/data-model/entities/project.md
View File

@ -1,171 +0,0 @@
---
sidebar_position: 4
---
# Projects
Of crucial interest to OpenAIRE is also the identification of the funders (e.g. European Commission, WellcomeTrust, FCT Portugal, NWO The Netherlands) that co-funded the projects that have led to a given result. Projects are characterized by a list of funding streams (e.g. FP7, H2020 for the EC), which identify the strands of fundings. Funding streams can be nested to form a tree of sub-funding streams.
---
## The `Project` object
### id
_Type: String &bull; Cardinality: ONE_
Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers).
```json
"id": "corda__h2020::70ea22400fd890c5033cb31642c4ae68"
```
### code
_Type: String &bull; Cardinality: ONE_
Τhe grant agreement code of the project.
```json
"code": "777541"
```
### acronym
_Type: String &bull; Cardinality: ONE_
Project's acronym.
```json
"acronym": "OpenAIRE-Advance"
```
### title
_Type: String &bull; Cardinality: ONE_
Project's title.
```json
"title": "OpenAIRE Advancing Open Scholarship"
```
### callidentifier
_Type: String &bull; Cardinality: ONE_
The identifier of the research call.
```json
"callidentifier": "H2020-EINFRA-2017"`
```
### funding
_Type: [Funding](other#funding) &bull; Cardinality: MANY_
Funding information for the project.
```json
"funding": [
{
"funding_stream": {
"description": "Horizon 2020 Framework Programme - Research and Innovation action",
"id": "EC::H2020::RIA"
},
"jurisdiction": "EU",
"name": "European Commission",
"shortName": "EC"
}
]
```
### granted
_Type: [Grant](other#grant) &bull; Cardinality: ONE_
The money granted to the project.
```json
"granted": {
"currency": "EUR",
"fundedamount": 1.0E7,
"totalcost": 1.0E7
}
```
### h2020programme
_Type: [H2020Programme](other#h2020programme) &bull; Cardinality: MANY_
The H2020 programme funding the project.
```json
"h2020programme":[
{
"code": "H2020-EU.1.4.1.3.",
"description": "Development, deployment and operation of ICT-based e-infrastructures"
}
]
```
### keywords
_Type: String &bull; Cardinality: ONE_
```json
"keywords": [
"Open Science",
...
]
```
### openaccessmandatefordataset
_Type: Boolean &bull; Cardinality: ONE_
```json
"openaccessmandatefordataset": true
```
### openaccessmandateforpublications
_Type: Boolean &bull; Cardinality: ONE_
```json
"openaccessmandateforpublications": true
```
### startdate
_Type: String &bull; Cardinality: ONE_
The start year of the project.
```json
"startdate": "2018-01-01"
```
### enddate
_Type: String &bull; Cardinality: ONE_
The end year pf the project.
```json
"enddate": "2021-02-28"
```
### subject
_Type: String &bull; Cardinality: MANY_
The subjects of the project
```json
"subject": [
"Data and Distributed Computing e-infrastructures for Open Science",
...
]
```
### summary
_Type: String &bull; Cardinality: ONE_
Short summary of the project.
```json
"summary": "OpenAIRE-Advance continues the mission of OpenAIRE to support the Open Access/Open Data mandates in Europe. By sustaining the current successful infrastructure, comprised of a human network and robust technical services, it consolidates its achievements while working to shift the momentum among its communities to Open Science, aiming to be a trusted e-Infrastructurewithin the realms of the European Open Science Cloud.In this next phase, OpenAIRE-Advance strives to empower its National Open Access Desks (NOADs) so they become a pivotal part within their own national data infrastructures, positioningOA and open science onto national agendas. The capacity building activities bring together experts ontopical task groups in thematic areas(open policies, RDM, legal issues, TDM), promoting a train the trainer approach, strengthening and expanding the pan-European Helpdesk with support and training toolkits, training resources and workshops.It examines key elements of scholarly communication, i.e., co-operative OA publishing and next generation repositories, to develop essential building blocks of the scholarly commons.On the technical level OpenAIRE-Advance focuses on the operation and maintenance of the OpenAIRE technical TRL8/9 services,and radically improvesthe OpenAIRE services on offer by: a) optimizing their performance and scalability, b) refining their functionality based on end-user feedback, c) repackagingthem into products, taking a professional marketing approach with well-defined KPIs, d)consolidating the range of services/products into a common e-Infra catalogue to enable a wider uptake.OpenAIRE-Advancesteps up its outreach activities with concrete pilots with three major RIs,citizen science initiatives, and innovators via a rigorous Open Innovation programme. Finally, viaits partnership with COAR, OpenAIRE-Advance consolidatesOpenAIRE’s global roleextending its collaborations with Latin America, US, Japan, Canada, and Africa."
```
### websiteurl
_Type: String &bull; Cardinality: ONE_
The website of the project
```json
"websiteurl": "https://www.openaire.eu/advance/"
```

497
versioned_docs/version-7.0.0/data-model/entities/result.md
View File

@ -1,497 +0,0 @@
---
sidebar_position: 1
---
# Results
Results are intended as digital objects, described by metadata, resulting from a scientific process.
In this page, we descibe the properties of the `Result` object.
Moreover, there are the following sub-types of a `Result`, that inherit all its properties and further extend it:
* [Publication](#publication)
* [Dataset](#dataset)
* [Software](#software)
* [Other research product](#other-research-product)
---
## The `Result` object
### id
_Type: String &bull; Cardinality: ONE_
Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers).
```json
"id": "doi_dedup___::80f29c8c8ba18c46c88a285b7e739dc3"
```
### type
_Type: String &bull; Cardinality: ONE_
Type of the result. Possible types:
* `publication`
* `dataset`
* `software`
* `other`
as declared in the terms from the [dnet:result_typologies vocabulary](https://api.openaire.eu/vocabularies/dnet:result_typologies).
```json
"type": "publication"
```
### originalId
_Type: String &bull; Cardinality: MANY_
Identifiers of the record at the original sources.
```json
"originalId": [
"oai:pubmedcentral.nih.gov:8024784",
"S0048733321000305",
"10.1016/j.respol.2021.104226",
"3136742816"
]
```
### maintitle
_Type: String &bull; Cardinality: ONE_
A name or title by which a scientific result is known. May be the title of a publication, of a dataset or the name of a piece of software.
```json
"maintitle": "The fall of the innovation empire and its possible rise through open science"
```
### subtitle
_Type: String &bull; Cardinality: ONE_
Explanatory or alternative name by which a scientific result is known.
```json
"subtitle": "An analysis of cases from 1980 - 2020"
```
### author
_Type: [Author](other#author) &bull; Cardinality: MANY_
The main researchers involved in producing the data, or the authors of the publication.
```json
"author": [
{
"fullname": "E. Richard Gold",
"rank": 1,
"name": "Richard",
"surname": "Gold",
"pid": {
"id": {
"scheme": "orcid",
"value": "0000-0002-3789-9238"
},
"provenance"; {
"provenance": "Harvested",
"trust": "0.9"
}
}
},
...
]
```
### bestaccessright
_Type: [BestAccessRight](other#bestaccessright) &bull; Cardinality: ONE_
The most open access right associated to the manifestations of this research results.
```json
"bestaccessright": {
"code": "c_abf2",
"label": "OPEN",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
}
```
### contributor
_Type: String &bull; Cardinality: MANY_
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
```json
"contributor": [
"University of Zurich",
"Wright, Aidan G C",
"Hallquist, Michael",
...
]
```
### country
_Type: [ResultCountry](other#resultcountry) &bull; Cardinality: MANY_
Country associated with the result because 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 rel.
```json
"country": [
{
"code": "CH",
"label": "Switzerland",
"provenance": {
"provenance": "Inferred by OpenAIRE",
"trust": "0.85"
}
},
...
]
```
### coverage
_Type: String &bull; Cardinality: MANY_
### dateofcollection
_Type: String &bull; Cardinality: ONE_
When OpenAIRE collected the record the last time.
```json
"dateofcollection": "2021-06-09T11:37:56.248Z"
```
### description
_Type: String &bull; Cardinality: MANY_
A brief description of the resource and the context in which the resource was created.
```json
"description": [
"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.",
...
]
```
### embargoenddate
_Type: String &bull; Cardinality: ONE_
Date when the embargo ends and this result turns Open Access.
```json
"embargoenddate": "2017-01-01"
```
### indicators
_Type: [Indicator](other#indicator-1) &bull; Cardinality: ONE_
The indicators computed for this result;
currently, the following types of indicators are supported:
* [Impact indicators by BIP!](other#bipindicators)
* [Usage Statistics indicators](other#usagecounts)
```json
"indicators": {
"bipIndicators": [
{
"indicator": "influence",
"score": "123",
"class": "C2"
},
{
"indicator": "influence_alt",
"score": "456",
"class": "C3"
},
{
"indicator": "popularity",
"score": "234",
"class": "C1"
},
{
"indicator": "popularity_alt",
"score": "345",
"class": "C5"
},
{
"indicator": "impulse",
"score": "987",
"class": "C3"
}
],
"usageCounts": {
"downloads": "10",
"views": "20"
}
}
```
### instance
_Type: [Instance](other#instance) &bull; Cardinality: MANY_
Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version.
```json
"instance": [
{
"accessright": {
"code": "c_abf2",
"label": "OPEN",
"openAccessRoute": "gold",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
},
"alternateIdentifier": [
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
},
...
],
"articleprocessingcharge": {
"amount": "4063.93",
"currency": "EUR"
},
"license": "http://creativecommons.org/licenses/by-nc/4.0",
"pid": [
{
"scheme": "pmc",
"value": "PMC8024784"
},
...
],
"publicationdate": "2021-01-01",
"refereed": "UNKNOWN",
"type": "Article",
"url": [
"http://europepmc.org/articles/PMC8024784"
]
},
...
]
```
### language
_Type: [Language](other#language) &bull; Cardinality: ONE_
The alpha-3/ISO 639-2 code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages).
```json
"language": {
"code": "eng",
"label": "English"
}
```
### lastupdatetimestamp
_Type: Long &bull; Cardinality: ONE_
Timestamp of last update of the record in OpenAIRE.
```json
"lastupdatetimestamp": 1652722279987
```
### pid
_Type: [ResultPid](other#resultpid) &bull; Cardinality: MANY_
Persistent identifiers of the result. See also the [OpenAIRE entity identifier and PID mapping policy](../pids-and-identifiers) to learn more.
```json
"pid": [
{
"scheme": "pmc",
"value": "PMC8024784"
},
{
"scheme": "doi",
"value": "10.1016/j.respol.2021.104226"
},
...
]
```
### publicationdate
_Type: String &bull; Cardinality: ONE_
Main date of the research product: typically the publication or issued date. In case of a research result with different versions with different dates, the date of the result is selected as the most frequent well-formatted date. If not available, then the most recent and complete date among those that are well-formatted. For statistics, the year is extracted and the result is counted only among the result of that year. Example: Pre-print date: 2019-02-03, Article date provided by repository: 2020-02, Article date provided by Crossref: 2020, OpenAIRE will set as date 2019-02-03, because it’s the most recent among the complete and well-formed dates. If then the repository updates the metadata and set a complete date (e.g. 2020-02-12), then this will be the new date for the result because it becomes the most recent most complete date. However, if OpenAIRE then collects the pre-print from another repository with date 2019-02-03, then this will be the “winning date” because it becomes the most frequent well-formatted date.
```json
"publicationdate": "2021-03-18"
```
### publisher
_Type: String &bull; Cardinality: ONE_
The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
```json
"publisher": "Elsevier, North-Holland Pub. Co"
```
### source
_Type: String &bull; 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": [
"Research Policy",
"Crossref",
...
]
```
### subjects
_Type: [Subject](other#subject) &bull; Cardinality: MANY_
Subject, keyword, classification code, or key phrase describing the resource.
```json
"subjects": [
{
"provenance": {
"provenance": "Harvested",
"trust": "0.9"
},
"subject": {
"scheme": "keyword",
"value": "Open science"
}
},
...
]
```
---
## Sub-types
There are the following sub-types of `Result`. Each inherits all its fields and extends them with the following.
### Publication
Metadata records about research literature (includes types of publications listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/publication)).
#### container
_Type: [Container](other#container) &bull; Cardinality: ONE_
Container has information about the conference or journal where the result has been presented or published.
```json
"container": {
"edition": "",
"iss": "5",
"issnLinking": "",
"issnOnline": "1873-7625",
"issnPrinted": "0048-7333",
"name": "Research Policy",
"sp": "12",
"ep": "22",
"vol": "50"
}
```
### Dataset
Metadata records about research data (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/dataset)).
#### size
_Type: String &bull; Cardinality: ONE_
The declared size of the dataset.
```json
"size": "10129818"
```
#### version
_Type: String &bull; Cardinality: ONE_
The version of the dataset.
```json
"version": "v1.3"
```
#### geolocation
_Type: [GeoLocation](other#geolocation) &bull; Cardinality: MANY_
The list of geolocations associated with the dataset.
```json
"geolocation": [
{
"box": "18.569386 54.468973 18.066832 54.83707",
"place": "Tübingen, Baden-Württemberg, Southern Germany",
"point": "7.72486 50.1084"
},
...
]
```
### Software
Metadata records about research software (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/software)).
#### documentationUrl
_Type: String &bull; Cardinality: MANY_
The URLs to the software documentation.
```json
"documentationUrl": [
"https://github.com/openaire/iis/blob/master/README.markdown",
...
]
```
#### codeRepositoryUrl
_Type: String &bull; Cardinality: ONE_
The URL to the repository with the source code.
```json
"codeRepositoryUrl": "https://github.com/openaire/iis"
```
#### programmingLanguage
_Type: String &bull; Cardinality: ONE_
The programming language.
```json
"programmingLanguage": "Java"
```
### Other research product
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
_Type: String &bull; Cardinality: MANY_
Information on the person responsible for providing further information regarding the resource.
```json
"contactperson": [
"Noémie Dominguez",
...
]
```
#### contactgroup
_Type: String &bull; Cardinality: MANY_
Information on the group responsible for providing further information regarding the resource.
```json
"contactgroup": [
"Networked Multimedia Information Systems (NeMIS)",
...
]
```
#### tool
_Type: String &bull; Cardinality: MANY_
Information about tool useful for the interpretation and/or re-use of the research product.

81
versioned_docs/version-7.0.0/data-model/pids-and-identifiers.md
View File

@ -1,81 +0,0 @@
# PIDs and identifiers
One of the challenges towards the stability of the contents in the OpenAIRE Graph consists of making its identifiers and records stable over time.
The barriers to this scenario are many, as the Graph keeps a map of data sources that is subject to constant variations: records in repositories vary in content,
original IDs, and PIDs, may disappear or reappear, and the same holds for the repository or the metadata collection it exposes.
Not only, but the mappings applied to the original contents may also change and improve over time to catch up with the changes in the input records.
## PID Authorities
One of the fronts regards the attribution of the identity to the objects populating the graph. The basic idea is to build the identifiers of the objects in the graph from the PIDs available in some authoritative sources while considering all the other sources as by definition “unstable”. Examples of authoritative sources are Crossref and DataCite. Examples of non-authoritative ones are institutional repositories, aggregators, etc. PIDs from the authoritative sources would form the stable OpenAIRE ID skeleton of the Graph, precisely because they are immutable by construction.
Such a policy defines a list of data sources that are considered authoritative for a specific type of PID they provide, whose effect is twofold:
* OpenAIRE IDs depend on persistent IDs when they are provided by the authority responsible to create them;
* PIDs are included in the graph according to a tight criterion: the PID Types declared in the table below are considered to be mapped as PIDs only when they are collected from the relative PID authority data source.
| PID Type | Authority |
|-----------|-----------------------------------------------------------------------------------------------------|
| doi | [Crossref](https://www.crossref.org), [Datacite](https://datacite.org) |
| pmc, pmid | [Europe PubMed Central](https://europepmc.org/), [PubMed Central](https://www.ncbi.nlm.nih.gov/pmc) |
| arXiv | [arXiv.org e-Print Archive](https://arxiv.org/) |
| uniprot | [Protein Data Bank](http://www.pdb.org/) |
| ena | [Protein Data Bank](http://www.pdb.org/) |
| pdb | [Protein Data Bank](http://www.pdb.org/) |
There is an exception though: Handle(s) are minted by several repositories; as listing them all would not be a viable option, to avoid losing them as PIDs, Handles bypass the PID authority filtering rule.
In all other cases, PIDs are be included in the graph as alternate Identifiers.
## Delegated authorities
When a record is aggregated from multiple sources considered authoritative for minting specific PIDs, different mappings could be applied to them and, depending on the case,
this could result in inconsistencies in the attribution of the field values.
To overcome the issue, the intuition is to include such records only once in the graph. To do so, the concept of "delegated authorities" defines a list of datasources that
assigns PIDs to their scientific products from a given PID minter.
This "selection" can be performed when the entities in the graph sharing the same identifier are grouped together. The list of the delegated authorities currently includes
| Datasource delegated | Datasource delegating | Pid Type |
|--------------------------------------|----------------------------------|-----------|
| [Zenodo](https://zenodo.org) | [Datacite](https://datacite.org) | doi |
| [RoHub](https://reliance.rohub.org/) | [W3ID](https://w3id.org/) | w3id |
## Identifiers in the Graph
OpenAIRE assigns internal identifiers for each object it collects.
By default, the internal identifier is generated as `sourcePrefix::md5(localId)` where:
* `sourcePrefix` is a namespace prefix of 12 chars assigned to the data source at registration time
* `localΙd` is the identifier assigned to the object by the data source
After years of operation, we can say that:
* `localId` are generally unstable
* objects can disappear from sources
* PIDs provided by sources that are not PID agencies (authoritative sources for a specific type of PID) are often wrong (e.g. pre-print with the DOI of the published version, DOIs with typos)
Therefore, when the record is collected from an authoritative source:
* the identity of the record is forged using the PID, like `pidTypePrefix::md5(lowercase(doi))`
* the PID is added in a `pid` element of the data model
When the record is collected from a source which is not authoritative for any type of PID:
* the identity of the record is forged as usual using the local identifier
* the PID, if available, is added as `alternateIdentifier`
Currently, the following data sources are used as "PID authorities":
| PID Type | Prefix (12 chars) | Authority |
|-----------|------------------------|-------------------------------------------|
| doi | `doi_________` | Crossref, Datacite, Zenodo |
| pmc | `pmc_________` | Europe PubMed Central, PubMed Central |
| pmid | `pmid________` | Europe PubMed Central, PubMed Central |
| arXiv | `arXiv_______` | arXiv.org e-Print Archive |
| handle | `handle______` | any repository |
| ena | `ena_________` | EMBL-EBI |
| pdb | `pdb_________` | EMBL-EBI |
| uniprot | `uniprot_____` | EMBL-EBI |
OpenAIRE also perform duplicate identification (see the [dedicated section for details](/graph-production-workflow/deduplication)).
All duplicates are **merged** together in a **representative record** which must be assigned a dedicated OpenAIRE identifier (i.e. it cannot have the identifier of one of the aggregated record).

109
versioned_docs/version-7.0.0/data-model/relationships/relationship-object.md
View File

@ -1,109 +0,0 @@
---
title: The Relationship object
---
# The `Relationship` object
A relationship in the Graph is represented with the data type presented in this page, which aims to model a directed edge between two nodes, providing information about its semantics, provenance and validation.
### source
_Type: String &bull; Cardinality: ONE_
OpenAIRE identifier of the node in the graph.
```json
"source": "openorgs____::1cb75a3ad756e4c83e455e3e7347643b"
```
### sourceType
_Type: String &bull; Cardinality: ONE_
Graph node type.
```json
"sourceType": "organization"
```
### target
_Type: String &bull; Cardinality: ONE_
OpenAIRE identifier of the node in the graph.
```json
"target": "doajarticles::022409068174087a003647ff46070f7f"
```
### targetType
_Type: String &bull; Cardinality: ONE_
Graph node type.
```json
"target": "datasource"
```
### reltype
_Type: [RelType](#the-reltype-object) &bull; Cardinality: ONE_
Represent the semantics of the relationship between two nodes of the graph.
```json
"reltype": {
"name": "provides",
"type": "provision"
}
```
### provenance
_Type: [Provenance](/data-model/entities/other#provenance-1) &bull; Cardinality: ONE_
Indicates the process that produced (or provided) the information.
```json
"provenance": {
"provenance": "Harvested",
"trust":"0.900"
}
```
### validated
_Type: Boolean &bull; Cardinality: ONE_
Indicates weather or not the relationship was validated.
```json
"validated": true
```
### validationDate
_Type: String &bull; Cardinality: ONE_
Indicates the validation date of the relationship - applies only when the validated flag is set to true.
```json
"validationDate": "2022-09-02"
```
---
## The `RelType` object
The RelType data type models the semantic of the relationship among two nodes.
### type
_Type: String &bull; Cardinality: ONE_
The relationship category, e.g. affiliation, citation. (see [relationship types](./relationship-types)).
```json
"name": "provides"
```
### name
_Type: String &bull; Cardinality: ONE_
Further specifies the relationship semantic, indicating the relationship direction, e.g. Cites, isCitedBy.
```json
"type": "provision"
```
---

37
versioned_docs/version-7.0.0/data-model/relationships/relationship-types.md
View File

@ -1,37 +0,0 @@
# Relationship types
The following table lists all the possible relation semantics found in the Graph Dataset.
Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them.
| # | Source entity type | Target entity type | Relation name / inverse | Provenance |
|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:|
| 1 | [Project](/data-model/entities/project) | [Result](/data-model/entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user |
| 2 | [Project](/data-model/entities/project) | [Organization](/data-model/entities/organization) | hasParticipant / isParticipant | Harvested |
| 3 | [Project](/data-model/entities/project) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 4 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE |
| 5 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSupplementTo / IsSupplementedBy | Harvested |
| 6 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 7 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPartOf / HasPart | Harvested |
| 8 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDocumentedBy / Documents | Harvested |
| 9 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsObsoletedBy / Obsoletes | Harvested |
| 10 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSourceOf / IsDerivedFrom | Harvested |
| 11 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCompiledBy / Compiles | Harvested |
| 12 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRequiredBy / Requires | Harvested |
| 13 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE |
| 14 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReferencedBy / References | Harvested |
| 15 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReviewedBy / Reviews | Harvested |
| 16 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested |
| 17 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsVersionOf / HasVersion | Harvested |
| 18 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested |
| 19 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested |
| 20 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsContinuedBy / Continues | Harvested |
| 21 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDescribedBy / Describes | Harvested |
| 22 | [Result](/data-model/entities/result) | [Organization](/data-model/entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE |
| 23 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE |
| 24 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isProvidedBy / provides | Harvested |
| 25 | [Result](/data-model/entities/result) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user |
| 26 | [Organization](/data-model/entities/organization) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 27 | [Organization](/data-model/entities/organization) | [Organization](/data-model/entities/organization) | IsChildOf / IsParentOf | Linked by user |
| 28 | [Data source](/data-model/entities/data-source) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user |
| 29 | [Data source](/data-model/entities/data-source) | [Organization](/data-model/entities/organization) | isProvidedBy / provides | Harvested |

30
versioned_docs/version-7.0.0/downloads/alternative-model/cfhb.md
View File

@ -1,30 +0,0 @@
---
sidebar_position: 1
---
# CfHbKeyValue
Information about the sources from which the record has been collected.
@JsonSchema(description = "the OpenAIRE identifier of the data source")
### key
_Type: String &bull; Cardinality: ONE_
the OpenAIRE identifier of the data source
```json
"key":"openaire____::081b82f96300b6a6e3d282bad31cb6e2"
```
### value
_Type: String &bull; Cardinality: ONE_
The name of the data source.
```json
"value":"Crossref"
```

37
versioned_docs/version-7.0.0/downloads/alternative-model/communityInstance.md
View File

@ -1,37 +0,0 @@
---
sidebar_position: 1
---
# CommunityInstance
It is a subclass of [Instance](../../data-model/entities/result#instance) extended with information regarding the collection and hosting source for this materialization of the result.
### hostedby
_Type: [CfHbKeyValue](./cfhb) &bull; Cardinality: ONE_
Information about the source from which the instance can be viewed or downloaded.
```json
"hostedby": {
"key": "issn___print::35ee75a5ad42581d604be113a8f56427",
"value": "New Phytologist"
},
```
### collectedfrom
_Type: [CfHbKeyValue](./cfhb) &bull; Cardinality: ONE_
Information about the source from which the record has been collected
```json
"collectedfrom": {
"key": "openaire____::081b82f96300b6a6e3d282bad31cb6e2",
"value": "Crossref"
}
```

46
versioned_docs/version-7.0.0/downloads/alternative-model/context.md
View File

@ -1,46 +0,0 @@
---
sidebar_position: 1
---
# Context
Information related to research initiative/community (RI/RC) related to the result.
### code
_Type: String &bull; Cardinality: ONE_
Code identifying the RI/RC.
```json
"code":"sdsn-gr"
```
### label
_Type: String &bull; Cardinality: ONE_
Label of the RI/RC.
```json
"label":"SDSN - Greece"
```
### provenance
_Type: [Provenance](/data-model/entities/other#provenance-2) &bull; Cardinality: MANY_
Why this result is associated to the RI/RC.
```json
"provenance":[{
"provenance":"Inferred by OpenAIRE",
"trust":"0.9"
},
...
]
```

141
versioned_docs/version-7.0.0/downloads/alternative-model/extendedresult.md
View File

@ -1,141 +0,0 @@
---
sidebar_position: 1
---
# Extended Result
It is a subclass of [Result](/data-model/entities/result) extended with information regarding projects (and funders), research communities/infrastructure and related data sources.
### projects
_Type: [Project](project.md) &bull; Cardinality: MANY_
List of projects (i.e. grants) that (co-)funded the production of the research results.
```json
"projects": [
{
"id": "corda__h2020::94c4a066401e22002c4811a301bb4655",
"code": "727929",
"acronym": "TomRes",
"title": "A NOVEL AND INTEGRATED APPROACH TO INCREASE MULTIPLE AND COMBINED STRESS TOLERANCE IN PLANTS USING TOMATO AS A MODEL",
"funder": {
"shortName": "EC",
"name": "European Commission",
"jurisdiction": "EU",
"fundingStream": "H2020"
},
"provenance": {
"provenance": "Harvested",
"trust": "0.900000000000000022"
},
"validated": {
"validationDate": "2021-0101",
"validatedByFunder": true
}
},
...
]
```
### context
_Type: [Context](./context) &bull; Cardinality: MANY_
Reference to relevant research infrastructure, initiative or communities (RI/RC) among those collaborating with OpenAIRE. Please see https://connect.openaire.eu that are publicly visible.
```json
"context":[
{
"code":"sdsn-gr",
"label":"SDSN - Greece",
"provenance":[
{
"provenance":"Inferred by OpenAIRE",
"trust":"0.9"
}
]
},
...
]
```
### collectedfrom
_Type: [CfHbKeyValue](./cfhb) &bull; Cardinality: MANY_
Information about the sources from which the record has been collected.
```json
"collectedfrom":[
{
"key":"openaire____::081b82f96300b6a6e3d282bad31cb6e2",
"value":"Crossref"
},
...
]
```
### instance
_Type: [CommunityInstance](./communityInstance) &bull; Cardinality: MANY_
Information about the source from which the instance can be viewed or downloaded.
```json
"instance": [
{
"license": "http://doi.wiley.com/10.1002/tdm_license_1.1",
"accessright": {
"code": "c_16ec",
"label": "RESTRICTED",
"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/",
"openAccessRoute": null
},
"type": "Article",
"url": [
"https://api.wiley.com/onlinelibrary/tdm/v1/articles/10.1111%2Fnph.15014",
"http://onlinelibrary.wiley.com/wol1/doi/10.1111/nph.15014/fullpdf",
"http://dx.doi.org/10.1111/nph.15014"
],
"publicationdate": "2018-02-09",
"refereed": "UNKNOWN",
"hostedby": {
"key": "issn___print::35ee75a5ad42581d604be113a8f56427",
"value": "New Phytologist"
},
"collectedfrom": {
"key": "openaire____::081b82f96300b6a6e3d282bad31cb6e2",
"value": "Crossref"
}
},
...
]
```

72
versioned_docs/version-7.0.0/downloads/alternative-model/funder.md
View File

@ -1,72 +0,0 @@
---
sidebar_position: 1
---
# Funder
Information about the funder funding the project.
### fundingStream
_Type: String &bull; Cardinality: ONE_
Funding information for the project.
```json
"funding_stream": "H2020"
```
### jurisdiction
_Type: String &bull; Cardinality: ONE_
Geographical jurisdiction (e.g. for European Commission is EU, for Croatian Science Foundation is HR).
```json
"jurisdiction": "EU"
```
### name
_Type: String &bull; Cardinality: ONE_
The name of the funder.
```json
"name": "European Commission"
```
### shortName
_Type: String &bull; Cardinality: ONE_
The short name of the funder.
```json
"shortName": "EC"
```

134
versioned_docs/version-7.0.0/downloads/alternative-model/project.md
View File

@ -1,134 +0,0 @@
---
sidebar_position: 1
---
# Project
The information about the projects related to the result.
### id
_Type: String &bull; Cardinality: ONE_
Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](../../data-model/pids-and-identifiers).
```json
"id": "corda__h2020::70ea22400fd890c5033cb31642c4ae68"
```
### code
_Type: String &bull; Cardinality: ONE_
Τhe grant agreement code of the project.
```json
"code": "777541"
```
### acronym
_Type: String &bull; Cardinality: ONE_
Project's acronym.
```json
"acronym": "OpenAIRE-Advance"
```
### title
_Type: String &bull; Cardinality: ONE_
Project's title.
```json
"title": "OpenAIRE Advancing Open Scholarship"
```
### funder
_Type [Funder](funder.md) &bull; Cardinality: ONE_
Information about the funder funding the project.
```json
"funder": {
"shortName": "EC",
"name": "European Commission",
"jurisdiction": "EU",
"fundingStream": "H2020"
}
```
### provenace
_Type [Provenance](../../data-model/entities/other#provenance-2) &bull; Cardinality: ONE_
The reason why the project is associated to the result.
```json
"provenance": {
"provenance": "Harvested",
"trust": "0.900000000000000022"
}
```
### validated
_Type [Validated](validated.md) &bull; Cardinality: ONE_
Specifies it the association between the project and the result was validated.
```json
"validated": {
"validationDate": "2021-0101",
"validatedByFunder": true
}
```

41
versioned_docs/version-7.0.0/downloads/alternative-model/validated.md
View File

@ -1,41 +0,0 @@
---
sidebar_position: 1
---
# Validated
Information about the validtion of the association between the result and the funding information.
### validationDate
_Type: String &bull; Cardinality: ONE_
When OpenAIRE collected the association between the funding and the result from an authoritative source (i.e. Sygma).
```json
"validationDate": "2021-0101"
```
### validatedByFunder
_Type: Boolean &bull; Cardinality: ONE_
Specifies if the validation comes from the funder.
```json
"validatedByFunder": true
```

16
versioned_docs/version-7.0.0/downloads/beginners-kit.md
View File

@ -1,16 +0,0 @@
---
sidebar_position: 2
---
# Beginner's kit
The large size of the OpenAIRE Graph is a major impediment for beginners to familiarise with the underlying data model and explore its contents.
Working with the Graph in its full size typically requires access to a huge distributed computing infrastructure which cannot be easily accessible to everyone.
[The OpenAIRE Beginner’s Kit](https://doi.org/10.5281/zenodo.7490191) aims to address this issue. It consists of two components:
<!-- :::caution
This version is not accompanied with public dataset files, hence the files in this section are based on [v6.0.0](/docs/6.0.0/) of the Graph. The current data are only exposed via the [OpenAIRE Graph API](https://graph.openaire.eu/develop/) and added-value services that are built on top of this version of the Graph (e.g., the [OpenAIRE Explore](https://explore.openaire.eu/)). If you are interested to get bulk access to our latest data, please contact us via our [helpdesk](https://graph.openaire.eu/support).
::: -->
* A subset of the Graph composed of the research products published between 2022-06-29 and 2022-12-29, all the entities connected to them and the respective relationships.
* A Zeppelin notebook that demonstrates how you can use PySpark to analyse the Graph and get answers to some interesting research questions. A guide to Apache Zeppelin can be found [here](https://docs.cloudera.com/HDPDocuments/HDP2/HDP-2.6.5/bk_zeppelin-component-guide/content/ch_overview.html).

50
versioned_docs/version-7.0.0/downloads/full-graph.md
View File

@ -1,50 +0,0 @@
---
sidebar_position: 1
---
# Full graph dataset
You can download the full OpenAIRE Graph Dataset as well as its schema from the following links:
<!-- :::caution
This version is not accompanied with public dump files, hence the files in this section are based on [v6.0.0](/docs/6.0.0/) of the Graph. The current data are only exposed via the [OpenAIRE Graph API](https://graph.openaire.eu/develop/) and added-value services that are built on top of this version of the Graph (e.g., the [OpenAIRE Explore](https://explore.openaire.eu/)). If you are interested to get bulk access to our latest data, please contact us via our [helpdesk](https://graph.openaire.eu/support).
::: -->
Dataset: https://doi.org/10.5281/zenodo.3516917
Schema: https://doi.org/10.5281/zenodo.4238938
The schema used to create this dataset mirrors the one described in the [Data Model](/data-model).
This dataset is licensed under a Creative Commons Attribution 4.0 International License.
It is composed of several files so that you can download the parts you are interested into. The files are named after the entity they store (i.e. publication, dataset). Each file is at most 10GB and it is
a tar archive containing gz files, each with one json per line.
## How to acknowledge this work
Open Science services are open and transparent and survive thanks to your active support and to the visibility and reward they gather. If you use one of the [OpenAIRE Graph datasets](https://doi.org/10.5281/zenodo.3516917) for your research, please provide a proper citation following the recommendation that you find on the dataset's Zenodo page or as provided below.
:::note How to cite
Manghi P., Atzori C., Bardi A., Baglioni M., Schirrwagen J., Dimitropoulos H., La Bruzzo S., Foufoulas I., Mannocci A., Horst M., Czerniak A., Iatropoulou K., Kokogiannaki A., De Bonis M., Artini M., Lempesis A., Ioannidis A., Manola N., Principe P., Vergoulis T., Chatzopoulos S., Pierrakos D. (2022). "OpenAIRE Research Graph Dataset", *Dataset*, Zenodo. [doi:10.5281/zenodo.3516917](https://doi.org/10.5281/zenodo.3516917) ([BibTex](/bibtex/OpenAIRE_Research_Graph_dataset.bib))
:::
Please also consider citing [other relevant research products](/publications#relevant-research-products) that can be of interest.
Also consider adding one of the following badges to your service with the appropriate link to [our website](https://graph.openaire.eu); click on the badges below to download the respective badge image files.
<div className="row">
<div className="col col--4 left-badge">
<a target="_blank" href={require('../assets/badges/openaire-badge-1.zip').default} download>
<img loading="lazy" alt="Openaire badge" src={require('../assets/badges/openaire-badge-1.png').default} className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module pagination-nav__link" style={{ paddingTop: '1.2em', paddingBottom: '1.2em'}} title="Click to download"/>
</a>
</div>
<div className="col col--4 mid-badge">
<a target="_blank" href={require('../assets/badges/openaire-badge-2.zip').default} download>
<img loading="lazy" alt="Openaire badge" src={require('../assets/badges/openaire-badge-2.png').default} className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module pagination-nav__link dark-badge" style={{ paddingTop: '1.2em', paddingBottom: '1.2em'}} title="Click to download"/>
</a>
</div>
<div className="col col--4 right-badge">
<a target="_blank" href={require('../assets/badges/openaire-badge-3.zip').default} download>
<img loading="lazy" alt="Openaire badge" src={require('../assets/badges/openaire-badge-3.png').default} className="img_node_modules-@docusaurus-theme-classic-lib-theme-MDXComponents-Img-styles-module pagination-nav__link" style={{ paddingTop: '1.2em', paddingBottom: '1.2em'}} title="Click to download"/>
</a>
</div>
</div>

34
versioned_docs/version-7.0.0/downloads/related-datasets.md
View File

@ -1,34 +0,0 @@
---
sidebar_position: 4
---
# Other related datasets
In this page, we list other related datasets; please refer to their respective schema definitions for the data model they follow.
## The dataset of ScholeXplorer
Dataset: https://zenodo.org/doi/10.5281/zenodo.1200252
Schema (Scholix version 3): https://doi.org/10.5281/zenodo.1120275
Schema (Scholix version 4): https://doi.org/10.5281/zenodo.6351557
This dataset is licensed under a CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.
The dataset contains the GZ-compressed dataset of the Scholix links exposed by the OpenAIRE ScholeXplorer service.
## The OpenAIRE LOD dataset
:::caution
The OpenAIRE LOD dataset has been discontinued. The SPARQL Endpoint is no longer supported but old LOD datasets can be found in the link below.
:::
Dataset (RDF): https://doi.org/10.5281/zenodo.609943
<!-- LOD Ontology: http://lod.openaire.eu/vocab
SPARQL Endpoint: http://lod.openaire.eu/sparql -->
The OpenAIRE Linked Open Data (LOD) Services and their integration with the OpenAIRE information space have been released as a beta version. The LOD exporting process started with a specification of the OpenAIRE data model as an RDF vocabulary, and then mapping of the OpenAIRE data to the graph-based RDF data model. To interlink the OpenAIRE data with related data on the Web, we have identified a list of potential datasets to interlinked with, including the DBpedia dataset extracted from Wikipedia and the publication databases DBLP and CiteSeer.
<!-- Please refer [here](http://lod.openaire.eu/documentation) for more details on the LOD documentation. -->

70
versioned_docs/version-7.0.0/downloads/subgraphs.md
View File

@ -1,70 +0,0 @@
---
sidebar_position: 3
---
# Sub-graph datasets
In order to facilitate users, different datasets are available under the Zenodo community called [OpenAIRE Graph](https://zenodo.org/communities/openaire-research-graph).
This page lists all alternative datasets currently available.
<!-- :::caution
This version is not accompanied with public dataset files, hence the files in this section are based on [v6.0.0](/docs/6.0.0/) of the Graph. The current data are only exposed via the [OpenAIRE Graph API](https://graph.openaire.eu/develop/) and added-value services that are built on top of this version of the Graph (e.g., the [OpenAIRE Explore](https://explore.openaire.eu/)). If you are interested to get bulk access to our latest data, please contact us via our [helpdesk](https://graph.openaire.eu/support).
::: -->
## The OpenAIRE COVID-19 dataset
Dataset: https://doi.org/10.5281/zenodo.3980490
Schema: https://doi.org/10.5281/zenodo.3974225
This dataset is licensed under a Creative Commons Attribution 4.0 International License.
It contains metadata records of publications, research data, software and projects on the topic of Corona Virus and COVID-19.
This dataset is part of the activities of OpenAIRE to support the fight against COVID-19 together with the OpenAIRE COVID-19 Gateway.
The dataset consists of a tar archive containing gzip files with one json per line. Please refer [here](#alternative-sub-graph-data-model) for details on the data model of this dataset.
## The dataset of funded products
Dataset: https://doi.org/10.5281/zenodo.4559725
Schema: https://doi.org/10.5281/zenodo.3974225
This dataset is licensed under a Creative Commons Attribution 4.0 International License.
It contains metadata records of research products (research literature, data, software, other types of research products) with funding
information available in the OpenAIRE Graph. Records are grouped by funder in a dedicated archive file. Each tar archive contains
gzip files, each with one json record per line. The model of this dataset differs from the one of the whole graph.
Please refer [here](#alternative-sub-graph-data-model) for details on the data model of this dataset.
## The dataset of delta projects
Dataset: https://doi.org/10.5281/zenodo.6419021
Schema: https://doi.org/10.5281/zenodo.4238938
This dataset is licensed under a Creative Commons Attribution 4.0 International License.
It contains the metadata records of projects collected by OpenAIRE in a given time frame. Usually one deposition of collected projects is done for each release of the OpenAIRE Graph
The deposition is one tar archive containing gzip files, each with one json record per line.
## The datasets about research communities, initiatives and infrastructures
Dataset: https://doi.org/10.5281/zenodo.3974604
Schema: https://doi.org/10.5281/zenodo.3974225
This dataset is licensed under a Creative Commons Attribution 4.0 International License.
The dataset contains one file per community/initiative/infrastructure collaborating with OpenAIRE. Check out also their community gateways on
CONNECT. Each file is a tar archive containing gzip files with one json per line. The only communities/research initiative/infrastructure included are publicly visible ones.
The model of this dataset differs from the one of the whole graph.
Please refer [here](#alternative-sub-graph-data-model) for details on the data model of this dataset.
---
## Alternative sub-graph data model
It should be noted that the datasets for research communities, infrastructures, and products related to projects do not strictly follow the main data model of the OpenAIRE Graph. In particular, they differ in the following:
* only research products are included (no relations, and entities different from results)
* the results are extended with information that can be inferred in the whole dataset namely:
* funding information if present
* associated research community/infrastructure
* associated data sources
So they have just one entity type, that is the [Extended Result](alternative-model/extendedresult.md).

7
versioned_docs/version-7.0.0/faq.md
View File

@ -1,7 +0,0 @@
---
sidebar_position: 10
---
# FAQ
<span className="todo">https://support.openaire.eu/projects/docs/wiki/FAQ</span>

Some files were not shown because too many files have changed in this diff Show More