New end point for researchProducts in selective access! FOS and SDG classifications available for publication requests

git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@62224 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
Katerina Iatropoulou 2022-05-11 10:01:33 +00:00
parent 92e7dd637b
commit cee0efc298
3 changed files with 124 additions and 328 deletions

437
api.html
View File

@ -85,10 +85,13 @@
<a href="#">HTTP API Documentation</a>
<ul class="uk-nav-sub">
<li class="sideMenuItem"><a href="#common" uk-scroll="offset: 115;">Common Parameters</a></li>
<li class="sideMenuItem"><a href="#pubs" uk-scroll="offset: 115;">Publications</a></li>
<li class="sideMenuItem"><a href="#datasets" uk-scroll="offset: 115;">Research Data</a></li>
<li class="sideMenuItem"><a href="#software" uk-scroll="offset: 115;">Software</a></li>
<li class="sideMenuItem"><a href="#other" uk-scroll="offset: 115;">Other Research Products</a></li>
<li class="sideMenuItem"><a href="#rproducts" uk-scroll="offset: 115;">Research Products</a></li>
<ul class="uk-nav-sub">
<li class="sideMenuItem"><a href="#pubs" uk-scroll="offset: 115;">Publications</a></li>
<li class="sideMenuItem"><a href="#datasets" uk-scroll="offset: 115;">Research Data</a></li>
<li class="sideMenuItem"><a href="#software" uk-scroll="offset: 115;">Research Software</a></li>
<li class="sideMenuItem"><a href="#other" uk-scroll="offset: 115;">Other Research Products</a></li>
</ul>
<li class="sideMenuItem"><a href="#projects" uk-scroll="offset: 115;">Projects</a></li>
</ul>
</li>
@ -120,13 +123,16 @@
<h3 class="portal-color" id="common">Common Parameters</h3>
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
<strong>research data</strong>, <strong>software</strong>, <strong>other research products</strong>, or <strong>projects</strong>) you want to retrieve. <br>
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
To query for research data metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
To query for software metadata: <strong>http://api.openaire.eu/search/software</strong> <br>
To query for other research products metadata: <strong>http://api.openaire.eu/search/other</strong> <br>
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
<p class="uk-margin-remove-bottom"> Parameters included in this section can always be specified, for both <strong>research products</strong> and <strong>projects</strong>. <br>
For research products: <strong>https://api.openaire.eu/search/researchProducts</strong>. By specific type: <br>
<ul class="uk-margin-remove-top">
<li>publications: <strong>https://api.openaire.eu/search/publications</strong></li>
<li>research data: <strong>https://api.openaire.eu/search/datasets</strong></li>
<li>research software: <strong>https://api.openaire.eu/search/software</strong></li>
<li>other research products: <strong>http://api.openaire.eu/search/other</strong></li>
</ul>
To query for projects metadata: <strong>https://api.openaire.eu/search/projects</strong> <br>
</p>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small">
@ -196,8 +202,8 @@
</tbody>
</table>
<h3 class="portal-color" id="pubs">Publication specific parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/publications</strong></p>
<h3 class="portal-color" id="rproducts">Reasearch Products Common Parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/researchProducts</strong></p>
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
@ -218,15 +224,88 @@
<td>Comma separated list of DOIs. <br>
Alternatively, it is possible to repeat the parameter for each requested doi.
</td>
<td>Gets the publications with the given DOIs, if any.</td>
<td>Gets the research products with the given DOIs, if any.</td>
</tr>
<tr>
<td>orcid</td>
<td>Comma separated list of ORCID iDs of authors.<br>
Alternatively, it is possible to repeat the parameter for each author ORCID iD.
</td>
<td>Gets the publications linked to the given ORCID iD of an author, if any. </td>
<td>Gets the research products linked to the given ORCID iD of an author, if any. </td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the research products whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the research products whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the research products whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>White-space separated list of names and/or surnames.</td>
<td>Search for research products by authors.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>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.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>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.</td>
<td>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.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>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.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for research products associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access research products. If OA is false gets the non Open Access research products</td>
</tr>
<tr>
<td>country</td>
<td>2 letter country code</td>
<td>Search for research products associated to the country code</td>
</tr>
</tbody>
</table>
<h3 class="portal-color" id="pubs">Publication parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/publications</strong></p>
You can use all the <strong><a href="#rproducts">research products parameters</a></strong> and the ones available in the following table.
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
<th>Parameter</th>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>openairePublicationID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
@ -238,71 +317,27 @@
<td>originalId</td>
<td>Comma separated list of original identifiers as we get them from the content provider. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the software with the given openaire identifier, if any.</td>
<td>Gets the publication with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the publications whose date of acceptance is greater than or equal the given date.</td>
<td>sdg</td>
<td>The number of the Sustainable Development Goals <code>[1-17]</code>.<br>
Check <a href="https://sdgs.un.org/goals" target="_blank">here</a> to see the Sustainable Developemnt Goals.</td>
<td>Gets the publications that are classified with the respective Sustainable Development Goal number.
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the publications whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the publications whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>White-space separated list of names and/or surnames.</td>
<td>Search for publications by authors.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for publications 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.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>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.</td>
<td>Search for publications 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.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>If hasProject is true gets the publications that have a link to a project. If hasProject is false gets the publications with no links to projects.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for publications associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access publications. If OA is false gets the non Open Access publications</td>
</tr>
<tr>
<td>country</td>
<td>2 letter country code</td>
<td>Search for publications associated to the country code</td>
</tr>
<td>fos</td>
<td>The Field of Science classification value.<br>
Check <a href="athenarc_fos_hierarchy.json" target="_blank">here</a> to see the Field of Science classification values</td></td>
<td>Gets the publications that are classified with the respective Field of Science classification value.</td>
</tr>
</tbody>
</table>
<h3 class="portal-color" id="datasets">Research Data specific parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/datasets</strong></p>
You can use all the <strong><a href="#rproducts">research products parameters</a></strong> and the ones available in the following table.
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
@ -311,101 +346,20 @@
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>doi</td>
<td>Comma separated list of DOIs. <br>
Alternatively, it is possible to repeat the parameter for each requested doi.
</td>
<td>Gets the datasets with the given DOIs, if any.</td>
</tr>
<tr>
<td>orcid</td>
<td>Comma separated list of ORCID iDs of authors.<br>
Alternatively, it is possible to repeat the parameter for each author ORCID iD.
</td>
<td>Gets the publications linked to the given ORCID iD of an author, if any. </td>
</tr>
<tbody>
<tr>
<td>openaireDatasetID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the dataset with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>originalId</td>
<td>Comma separated list of original identifiers as we get them from the content provider. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the software with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the datasets whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>A white-space separated list of names and/or surnames</td>
<td>Search for datasets by authors.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for datasets 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.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>Comma separated list of identifiers. </td>
<td>Search for datasets by openaire project 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.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>If hasProject is true gets the datasets that have a link to a project. If hasProject is false gets the datasets with no links to projects.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for datasets associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
</tr>
<tr>
<td>country</td>
<td>2 letter country code</td>
<td>Search for datasets associated to the country code</td>
</tr>
</tr>
</tbody>
</table>
<h3 class="portal-color" id="software">Software specific parameters</h3>
<h3 class="portal-color" id="software">Research Software specific parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/software</strong></p>
You can use all the <strong><a href="#rproducts">research products parameters</a></strong> and the ones available in the following table.
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
@ -414,101 +368,20 @@
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>doi</td>
<td>Comma separated list of DOIs. <br>
Alternatively, it is possible to repeat the parameter for each requested doi.
</td>
<td>Gets the software with the given DOIs, if any.</td>
</tr>
<tr>
<td>orcid</td>
<td>Comma separated list of ORCID iDs of authors.<br>
Alternatively, it is possible to repeat the parameter for each author ORCID iD.
</td>
<td>Gets the publications linked to the given ORCID iD of an author, if any. </td>
</tr>
<tbody>
<tr>
<td>openaireSoftwareID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the software with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>originalId</td>
<td>Comma separated list of original identifiers as we get them from the content provider. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the software with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the software whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the software whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the software whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>A white-space separated list of names and/or surnames</td>
<td>Search for software by authors.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for software 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.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>Comma separated list of identifiers. </td>
<td>Search for software by openaire project 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.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>If hasProject is true gets the software that have a link to a project. If hasProject is false gets the software with no links to projects.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for software associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access software. If OA is false gets the non Open Access software</td>
</tr>
<tr>
<td>country</td>
<td>2 letter country code</td>
<td>Search for software associated to the country code</td>
</tr>
</tr>
</tbody>
</table>
<h3 class="portal-color" id="other">Other Research Products specific parameters</h3>
<p>Endpoint: <strong>http://api.openaire.eu/search/other</strong></p>
You can use all the <strong><a href="#rproducts">research products parameters</a></strong> and the ones available in the following table.
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
<thead>
<tr>
@ -517,95 +390,13 @@
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>sortBy</td>
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
<td>The sorting order of the specified field.</td>
</tr>
<tr>
<td>doi</td>
<td>Comma separated list of DOIs. <br>
Alternatively, it is possible to repeat the parameter for each requested doi.
</td>
<td>Gets the other research products with the given DOIs, if any.</td>
</tr>
<tr>
<td>orcid</td>
<td>Comma separated list of ORCID iDs of authors.<br>
Alternatively, it is possible to repeat the parameter for each author ORCID iD.
</td>
<td>Gets the publications linked to the given ORCID iD of an author, if any. </td>
</tr>
<tbody>
<tr>
<td>openaireOtherID</td>
<td>Comma separated list of OpenAIRE identifiers. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the other research products with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>originalId</td>
<td>Comma separated list of original identifiers as we get them from the content provider. <br>
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
<td>Gets the software with the given openaire identifier, if any.</td>
</tr>
<tr>
<td>fromDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the other research products whose date of acceptance is greater than or equal the given date.</td>
</tr>
<tr>
<td>toDateAccepted</td>
<td>Date formatted as <code>YYYY-MM-DD</code></td>
<td>Gets the other research products whose date of acceptance is less than or equal the given date.</td>
</tr>
<tr>
<td>title</td>
<td>White-space separated list of keywords.</td>
<td>Gets the other research products whose titles contain the given list of keywords.</td>
</tr>
<tr>
<td>author</td>
<td>A white-space separated list of names and/or surnames</td>
<td>Search for other research products by authors.</td>
</tr>
<tr>
<td>openaireProviderID</td>
<td>Comma separated list of identifiers.</td>
<td>Search for other 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.</td>
</tr>
<tr>
<td>openaireProjectID</td>
<td>Comma separated list of identifiers. </td>
<td>Search for other research products by openaire project 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.</td>
</tr>
<tr>
<td>projectID</td>
<td>...</td>
<td>The given grant identifier of the project.</td>
</tr>
<tr>
<td>hasProject</td>
<td>true | false</td>
<td>If hasProject is true gets the other research products that have a link to a project. If hasProject is false gets the other research products with no links to projects.</td>
</tr>
<tr>
<td>FP7ProjectID</td>
<td>...</td>
<td>Search for other research products associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
</tr>
<tr>
<td>OA</td>
<td>true | false</td>
<td>If OA is true gets Open Access other research products. If OA is false gets the non Open Access other research products</td>
</tr>
<tr>
<td>country</td>
<td>2 letter country code</td>
<td>Search for other research products associated to the country code</td>
</tr>
</tr>
</tbody>
</table>

File diff suppressed because one or more lines are too long

View File

@ -99,11 +99,15 @@
<div class="uk-card uk-card-body uk-card-default">
<h3 class="uk-card-title portal-color uk-margin-remove-bottom">Selective access</h3>
<p class="uk-text-meta uk-text-small uk-margin-remove-top">Access via HTTP</p>
<a href="api.html#pubs">Publications</a> <br>
<a href="api.html#datasets">Research data</a> <br>
<a href="api.html#software">Software</a> <br>
<a href="api.html#other">Other Research Products</a> <br>
<a href="api.html#projects">Projects</a> <br>
<p class="uk-margin-remove-bottom"><a href="api.html#projects">Projects</a> <br>
<a href="api.html#rproducts">Research Products</a>
<ul class="uk-margin-remove-top uk-text-small">
<li><a class="uk-margin-left uk-margin-remove-top" href="api.html#pubs">Publications</a></li>
<li><a class="uk-margin-left" href="api.html#datasets">Research data</a></li>
<li><a class="uk-margin-left" href="api.html#software">Research Software</a></li>
<li><a class="uk-margin-left" href="api.html#other">Other Research Products</a></li>
</ul>
</p>
</div>
</div>
<div>