Documentation

h1. Result

Results are intended as digital objects, described by metadata, resulting from a scientific process.

h2. Result

|_. field name |_. cardinality |_. type |_. description |

| id | ONE | string | Main entity identifier, created according to [[OpenAIRE_entity_identifier_and_PID_mapping_policy]] |

| type | ONE | string | Type of the result: one of 'publication', 'dataset', 'software', 'other' as declared in the terms from the "dnet:result_typologies":https://api.openaire.eu/vocabularies/dnet:result_typologies vocabulary |

| originalId | MANY | string | Identifiers of the record at the original sources |

| maintitle | ONE | string | 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. |

| subtitle | ONE | string | Explanatory or alternative name by which a scientific result is known. |

| author | MANY | [[Author]] | The main researchers involved in producing the data, or the authors of the publication |

| bestaccessright | ONE | [[BestAccessRight]] | The most open access right associated to the manifestations of this research results. |

| contributor | MANY | string | The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource. |

| country | MANY | [[ResultCountry#Country|ResultCountry]] | 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. |

| coverage | MANY | string | ??? |

| dateofcollection | ONE | string | When OpenAIRE collected the record the last time. TODO: we should indicate the used date format |

| description | MANY | string | A brief description of the resource and the context in which the resource was created. |

| embargoenddate | ONE | string | Date when the embargo ends and this result turns Open Access. TODO: we should indicate the used date format | 

| instance | MANY | [[Instance]] | 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 |

| language | ONE | [[Language]] | code: alpha-3/ISO 639-2 code of the language. Label: Language label in English. Values controlled by the "dnet:languages":https://api.openaire.eu/vocabularies/dnet:languages vocabulary |

| lastupdatetimestamp | ONE | long | Timestamp of last update of the record in OpenAIRE |

| pid | MANY | [[ResultPid]] | Persistent identifiers of the result. See also [[OpenAIRE_entity_identifier_and_PID_mapping_policy]] to learn more. |

| publicationdate | ONE | string | 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. |

| publisher | ONE | string | The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. |

| source | MANY | string | 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 |

| subjects | MANY | [[Subject]] | Subject, keyword, classification code, or key phrase describing the resource. |

{{collapse(Example result record)

<pre>

{

  "id" : "..."

}

</pre>

}}

h2. Publication

As a subclass of Result, Publication inherits all its fields and extends it with the followings

|_. field name |_. cardinality |_. type |_. description |

| container | ONE | [[Container]] | Container has information about the conference or journal where the result has been presented or published |

h2. Dataset

As a subclass of Result, Dataset inherits all its fields and extends it with the followings

|_. field name |_. cardinality |_. type |_. description |

| size | ONE | string | the size of the dataset |

| version | ONE | string | the version of the dataset |

| geolocation | MANY | [[GeoLocation]] | the list of geolocations associated with the dataset  |

h2. Software

As a subclass of Result, Software inherits all its fields and extends it with the followings

|_. field name |_. cardinality |_. type |_. description |

| documentationUrl | MANY | string | URLs to the software documentation |

| codeRepositoryUrl | ONE | string | URL to the repository holding the source code |

| programmingLanguage | ONE | string | the programming language |

h2. Other research product

As a subclass of Result, Other research product (ORP) inherits all its fields and extends it with the followings

|_. field name |_. cardinality |_. type |_. description |

| contactperson | MANY | string | the contact person for this ORP |

| contactgroup | MANY | string | the information for the contact group |

| tool | MANY | string | information about tool useful for the interpretation and/or re-use of the research product |