12 KiB

Raw Blame History

sidebar_position
6

Other helper objects

AccessRight

Type: One of { gold, green, hybrid, bronze } • Cardinality: ONE

Subclass of BestAccessRight, indicates information about rights held in and over the resource and the open Access Route.

openAccessRoute

Indicates the OpenAccess status. Values are set according to the Unpaywall methodology.

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.

Example

 { 
  "scheme" : "doi",
  "value" : "10.17182/hepdata.9959" 
 }

scheme

Type: String • Cardinality: ONE

Vocabulary reference.

value

Type: String • Cardinality: ONE

Value from the given scheme/vocabulary.

APC

Indicates the money spent to make a book or article available in Open Access. Sources for this information includes the OpenAPC initiative.

Example

{ 
  "currency" : "EU",
  "amount": "1000" 
}

currency

Type: String • Cardinality: ONE

The system of money in which the amount is expressed (Euro, USD, etc).

amount

Type: String • Cardinality: ONE

The quantity of money.

Author

Represents the result author.

Example

{
    "fullname":"Turunen, Heidi",
    "name":"Heidi",
    "surname":"Turunen",
    "rank":1,
    "pid":{
        "id":{
            "scheme":"orcid",
            "value":"0000-0001-7169-1177" 
        },
        "provenance":{
            "provenance":"Harvested",
            "trust":"0.9" 
        }
    }
}

fullname

Type: String • Cardinality: ONE

Author's full name.

name

Type: String • Cardinality: ONE

Author's given name.

surname

Type: String • Cardinality: ONE

Author's family name.

rank

Type: String • Cardinality: ONE

Author's order in the list of authors for the given result.

pid

Type: AuthorPid • Cardinality: ONE

Persistent identifier associated with this author.

AuthorPid

The author's persistent identifier.

Example

{
    "id":{
        "scheme":"orcid",
        "value":"0000-0001-7169-1177" 
    },
    "provenance":{
        "provenance":"Inferred by OpenAIRE",
        "trust":"0.85" 
    }
}

id

Type: AuthorPidSchemaValue • Cardinality: ONE

provenance

Type: Provenance • Cardinality: ONE

AuthorPidSchemaValue

Type used to represent the scheme and value for the author's pid.

Example

{
	"scheme" : "orcid",
	"value" : "0000-1111-2222-3333"
}

schema

Type: String • Cardinality: ONE

The author's pid scheme. OpenAIRE currently supports ORCID.

value

Type: String • Cardinality: ONE

The author's pid value.

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

Example

{
    "code":"c_16ec",
    "label":"RESTRICTED",
    "scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/" 
}

code

Type: String • Cardinality: ONE TODO

label

Type: String • Cardinality: ONE TODO

scheme

Type: String • Cardinality: ONE TODO

Container

This field has information about the conference or journal where the result has been presented or published.

name

Type: String • Cardinality: ONE Name of the journal or conference.

issnPrinted

Type: String • Cardinality: ONE

The journal printed issn.

issnOnline

Type: String • Cardinality: ONE

The journal online issn.

issnLinking

Type: String • Cardinality: ONE

The journal linking issn.

iss

Type: String • Cardinality: ONE

The journal issue.

sp

Type: String • Cardinality: ONE

The start page.

ep

Type: String • Cardinality: ONE

The end page.

vol

Type: String • Cardinality: ONE

The journal volume.

edition

Type: String • Cardinality: ONE

The edition of the journal or conference.

conferenceplace

Type: String • Cardinality: ONE

The place of the conference.

conferencedate

Type: String • Cardinality: ONE

The date of the conference.

GeoLocation

Represents the geolocation information.

point

Type: String • Cardinality: ONE TODO

box

Type: String • Cardinality: ONE TODO

place

Type: String • Cardinality: ONE TODO

ControlledField

TODO: similar to AlternateIdentifier and ResultPid?

Generic type used to represent the information described by a scheme and a value in that scheme (i.e. pid).

Example

{ 
  "scheme" : "DOI",
  "value" : "10.5281/zenodo.4707307" 
}

scheme

Type: String • Cardinality: ONE

Vocabulary reference.

value

Type: String • Cardinality: ONE

Value from the given scheme/vocabulary.

Country

To represent the generic country code and label.

code

Type: String • Cardinality: ONE

The country code (i.e. IT). TODO: based on which list?

label

Type: String • Cardinality: ONE

The country label (i.e. Italy).

ResultCountry

It is for the country associated to the result. It is a subclass of Country and extends it with provenance information.

Example

{
    "code" : "IT",
    "label": "Italy",
    "provenance" : {
         "provenance": "inferred by OpenAIRE",
         "trust": "0.85"
     }
}

provenance

Type: Provenance • Cardinality: ONE

Indicates the reason why this country is associated to this result

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 described in the following table.

Example

{
    "accessright":{
        "code":"c_abf2",
        "label":"OPEN",
        "openAccessRoute":"gold",
        "scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/" 
    },
    "alternateIdentifier":[],
    "license":"http://creativecommons.org/licenses/by-nc/4.0",
    "pid":[],
    "publicationdate":"2009-02-12",
    "refereed":"UNKNOWN",
    "type":"Article",
    "url":["https://periodicos2.uesb.br/index.php/folio/article/view/4296"]
}

accessright

Type: AccessRight • Cardinality: ONE

Maps dc:rights, describes the access rights of the web resources relative to this instance.

alternateIdentifier

Type: AlternateIdentifier • Cardinality: MANY

All the identifiers associated to the result other than the authoritative ones.

articleprocessingcharge

Type: APC • Cardinality: ONE

The money spent to make this book or article available in Open Access. Source for this information is the OpenAPC initiative.

license

Type: String • Cardinality: ONE

The license URL.

pid

Type: ResultPid • Cardinality: MANY

The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See OpenAIRE_entity_identifier_and_PID_mapping_policy for more information.

publicationdate

Type: String • Cardinality: ONE

The publication date of the research product.

refereed

Type: String • 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 (OpenAIRE v1.0 till v3.0 - Literature)
COAR Vocabulary v2.0 and v3.0 (OpenAIRE v4 - Inst.+Them.)

type

Type: String • Cardinality: ONE

The specific sub-type of this instance (see https://api.openaire.eu/vocabularies/dnet:result_typologies following the links)

url

Type: String • Cardinality: MANY

URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source.

Language

Represents information for the language of the result

code

Type: String • Cardinality: ONE

Alpha-3/ISO 639-2 code of the language.

label

Type: String • Cardinality: ONE

Language label in English

Provenance

Indicates the process that produced (or provided) the information, and the trust associated to the information.

Example

[
	{
		"provenance":"Harvested",
		"trust":"0.9"
	},
	{
		"provenance":"Inferred by OpenAIRE",
		"trust":"0.875"
	},
	{
		"provenance":"Linked by user",
		"trust":"0.8"
	}
]

provenance

Type: String • Cardinality: ONE

provenance term from the vocabulary dnet:provenanceActions.

trust

Type: String • Cardinality: ONE

Trust, expressed as a number in the range [0-1].

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.

Seems to be similar to the AlternateIdentifier. What is the difference?

Example

{
    "scheme" : "doi",
    "value" : "10.21511/bbs.13(3).2018.13" 
}

scheme

Type: String • Cardinality: ONE

Vocabulary reference.

value

Type: String • Cardinality: ONE

Value from the given scheme/vocabulary.

Subject

Represents keywords associated to the result.

Example

[
	{
	    "subject":{
	        "scheme": "acm",
	        "value": "GeneralLiterature_MISCELLANEOUS"
	    },
	    "provenance": {
	        "provenance": "Inferred by OpenAIRE",
	        "trust": "0.891"
	    }
	},
	{
	    "provenance":{
	        "provenance":"Harvested",
	        "trust":"0.9"
	    },
	    "subject":{
	        "scheme":"keyword",
	        "value":"SVOC"
	    }
	}
]

subject

Type: SubjectSchemeValue • Cardinality: ONE

Contains the subject term: subject type (keyword, MeSH, etc) and the subject term (medicine, chemistry, etc.).

provenance

Type: Provenance • Cardinality: ONE

Contains provenance information for the subject term.

SubjectSchemeValue

Subject classification against a vocabulary

Example

[
	{
		"scheme" : "keyword",
		"value" : "pyrolysis-oil"
	},
	{
		"value":"food and beverages",
		"scheme":"mesheuropmc"
	}
]

scheme

Type: String • Cardinality: ONE

OpenAIRE subject classification scheme (https://api.openaire.eu/vocabularies/dnet:subject_classification_typologies).

value

Type: String • 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).

12 KiB Raw Blame History

Other helper objects

AccessRight

openAccessRoute

AlternateIdentifier

scheme

value

APC

currency

amount

Author

fullname

name

surname

rank

pid

AuthorPid

id

provenance

AuthorPidSchemaValue

schema

value

BestAccessRight

code

label

scheme

Container

name

issnPrinted

issnOnline

issnLinking

iss

sp

ep

vol

edition

conferenceplace

conferencedate

GeoLocation

point

box

place

ControlledField

scheme

value

Country

code

label

ResultCountry

provenance

Instance

accessright

alternateIdentifier

articleprocessingcharge

license

pid

publicationdate

refereed

type

url

Language

code

label

Provenance

provenance

trust

ResultPid

scheme

value

Subject

subject

provenance

SubjectSchemeValue

scheme

value

12 KiB

Raw Blame History