mavenized project. Generates html running mvn docbkx:generate-html. results are then in target/docbkx
git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet30/modules/dnet-api-http-doc/src@26448 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
parent
65a6e4d1f8
commit
428e6a26d9
|
|
@ -1,11 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>Chapter 1. Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"><link rel="home" href="index.html" title="OpenAIRE+ HTTP API documentation"><link rel="up" href="index.html" title="OpenAIRE+ HTTP API documentation"><link rel="prev" href="index.html" title="OpenAIRE+ HTTP API documentation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="d5e12"></a>Chapter 1. Introduction</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch01.html#d5e19">Common API parameters</a></span></dt></dl></div><p>The OpenAIRE+ HTTP API allows developers to access the information space of OpenAIRE+ by
|
||||
performing queries over publications, datasets, and projects.</p><p>The API is intended for discovery and exploration only, that is it does not provide access
|
||||
to the whole informaton space, but the number of total results returned by one query is limited
|
||||
to 1000.</p><p>For accessing the whole information space, developers are encouraged to use the OAI-PMH API
|
||||
available at <a class="link" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a>. For details on the OAI-PMH
|
||||
protocol please refer to the official documentation at <a class="link" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a>
|
||||
</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d5e19"></a>Common API parameters</h2></div></div></div><p>
|
||||
Parameters included in this section can always be specified, regardless the type of entities (publications, datasets, or projects) you want to retrieve.
|
||||
</p><p>Katerina: add in the list below parameters for paging and other common parameters exposed by the API.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">X1</span></dt><dd><p>description of param</p></dd><dt><span class="term">X2</span></dt><dd><p>description of param</p></dd></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">OpenAIRE+ HTTP API documentation </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>This is an included section</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"><link rel="home" href="index.html" title="This is a book"><link rel="up" href="ch01.html" title="Chapter 1. This is a chapter"><link rel="prev" href="ch01.html" title="Chapter 1. This is a chapter"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">This is an included section</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01.html">Prev</a> </td><th width="60%" align="center">Chapter 1. This is a chapter</th><td width="20%" align="right"> </td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d5e9"></a>This is an included section</h2></div></div></div><p>This is an included paragraph.</p><div class="mediaobject"><img src="../../media/martin-luther-king.jpg"></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. This is a chapter </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>OpenAIRE+ HTTP API documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"><link rel="home" href="index.html" title="OpenAIRE+ HTTP API documentation"><link rel="next" href="ch01.html" title="Chapter 1. Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">OpenAIRE+ HTTP API documentation</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d5e1"></a>OpenAIRE+ HTTP API documentation</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author">Alessia Bardi</h3><div class="affiliation"><span class="org">
|
||||
<span class="orgname">ISTI-CNR</span>
|
||||
</span></div><code class="email"><<a class="email" href="mailto:alessia.bardi@isti.cnr.it">alessia.bardi@isti.cnr.it</a>></code></div></div></div><div><p class="pubdate">10 Mar 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="ch01.html#d5e19">Common API parameters</a></span></dt></dl></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html>
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>Part I. First Part</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"><link rel="home" href="index.html" title="Book Template Title"><link rel="up" href="index.html" title="Book Template Title"><link rel="prev" href="index.html" title="Book Template Title"><link rel="next" href="ch01.html" title="Chapter 1. Chapter Title"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Part I. First Part</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="d5e12"></a>Part I. First Part</h1></div><div><h2 class="subtitle">Subtitle of First Part</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Chapter Title</a></span></dt><dd><dl><dt><span class="sect1"><a href="ch01.html#d5e18">Section1 Title</a></span></dt></dl></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Book Template Title </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 1. Chapter Title</td></tr></table></div></body></html>
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>Book Template Title</title><meta name="generator" content="DocBook XSL Stylesheets V1.77.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d5e1"></a>Book Template Title</h1></div><div><div class="author"><h3 class="author"><span class="orgname">Organization Name</span><div class="address"><p><br>
|
||||
<span class="city">City</span><br>
|
||||
<span class="street">Street</span><br>
|
||||
<span class="postcode">000000</span><br>
|
||||
<span class="country">Country</span><br>
|
||||
</p></div><code class="email"><<a class="email" href="mailto:user@example.com">user@example.com</a>></code></h3><code class="email"><<a class="email" href="mailto:user@example.com">user@example.com</a>></code></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="part"><a href="#d5e12">I. First Part</a></span></dt><dd><dl><dt><span class="chapter"><a href="#d5e15">1. Chapter Title</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d5e18">Section1 Title</a></span></dt></dl></dd></dl></dd></dl></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="d5e12"></a>Part I. First Part</h1></div><div><h2 class="subtitle">Subtitle of First Part</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d5e15">1. Chapter Title</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d5e18">Section1 Title</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="d5e15"></a>Chapter 1. Chapter Title</h2></div><div><h3 class="subtitle"><i>Subtitle of Chapter</i></h3></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#d5e18">Section1 Title</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d5e18"></a>Section1 Title</h2></div><div><h3 class="subtitle">Subtitle of Section 1</h3></div></div></div><p>Text</p></div></div></div></div></body></html>
|
||||
|
|
@ -1,196 +0,0 @@
|
|||
<html><head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>OpenAIRE API documentation</title><link rel="stylesheet" href="openaire-api.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="OpenAIRE API documentation"><div class="titlepage"><div><div><h1 class="title"><a name="d4e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">8 April 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d4e5">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to FP7 projects</a></span></dt><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></dd></dl></div>
|
||||
|
||||
|
||||
|
||||
<div class="chapter" title="Chapter 1. Overview"><div class="titlepage"><div><div><h2 class="title"><a name="d4e5"></a>Chapter 1. Overview</h2></div></div></div>
|
||||
|
||||
<p>The OpenAIRE API allows developers to access the information space of OpenAIRE programmatically.</p>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||
<p>Bulk access:</p>
|
||||
<table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#cha_oai_pmh" title="Chapter 2. Bulk access via OAI-PMH">OAI-PMH</a></td></tr><tr><td><a class="xref" href="#cha_projects_http" title="Chapter 3. Bulk access to FP7 projects">FP7 projects export</a></td></tr></table>
|
||||
|
||||
</li><li class="listitem">
|
||||
<p>Selective access via <a class="xref" href="#cha_http-api" title="Chapter 4. Selective access with HTTP API">HTTP Search API</a></p>
|
||||
<table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#sec_http-pubs" title="Publications">Search HTTP API for publications</a></td></tr><tr><td><a class="xref" href="#sec_http-datasets" title="Datasets">Search HTTP API for datasets</a></td></tr><tr><td>HTTP API for projects [available soon] </td></tr></table>
|
||||
</li></ul></div>
|
||||
<p>The default format of delivered records is <code class="code">oaf</code> (OpenAire Format - current version 0.1):
|
||||
</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="ulink" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top"><code class="code">oaf</code> XML schema v0.1</a></td></tr><tr><td><a class="ulink" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top"><code class="code">oaf</code> XML schema v0.1 documentation</a></td></tr></table><p>
|
||||
</p>
|
||||
</div>
|
||||
<div class="chapter" title="Chapter 2. Bulk access via OAI-PMH"><div class="titlepage"><div><div><h2 class="title"><a name="cha_oai_pmh"></a>Chapter 2. Bulk access via OAI-PMH</h2></div></div></div>
|
||||
|
||||
<p>OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the
|
||||
OAI-PMH protocol please refer to the official documentation at <a class="ulink" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a></p>
|
||||
<p>The OpenAIRE OAI-PMH endpoint is <a class="ulink" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a></p>
|
||||
<p>For information about the endpoint check <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=Identify" target="_top">http://api.openaire.eu/oai_pmh?verb=Identify</a></p>
|
||||
<p>The updated list of OAI sets is always available at: <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=ListSets" target="_top">http://api.openaire.eu/oai_pmh?verb=ListSets</a></p>
|
||||
<p>For quick reference, we report here the likely more interesting sets:</p>
|
||||
<table border="0" summary="Simple list" class="simplelist"><tr><td>publications: the set of all publications</td></tr><tr><td>OpenAccess: the set of all Open Access publications and datasets</td></tr><tr><td>projects: the set of all projects</td></tr><tr><td>organizations: the set of all organizations</td></tr><tr><td>datasets: the set of all datasets</td></tr></table>
|
||||
<p>For the list of available metadata prefix, check: <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_top">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>.</p>
|
||||
<p>Note that records will always be available in the OpenAIRE format (<a class="ulink" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top">schema</a>, <a class="ulink" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a>). </p>
|
||||
<p>The availability of records in oai_dc depends on the typology of records. Currently only
|
||||
publications and datasets (records of type 'result') are available in oai_dc.</p>
|
||||
|
||||
</div>
|
||||
<div class="chapter" title="Chapter 3. Bulk access to FP7 projects"><div class="titlepage"><div><div><h2 class="title"><a name="cha_projects_http"></a>Chapter 3. Bulk access to FP7 projects</h2></div></div></div>
|
||||
|
||||
<p>The APIs offer custom access to EC projects information for the DSpace and EPrints platforms:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>DSpace endpoint: <a class="ulink" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL</a></td></tr><tr><td>ePrints endpoint: <a class="ulink" href="http://api.openaire.eu/projects/eprints/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/ALL/ALL</a></td></tr></table>
|
||||
<p> The URLs embed the parameters needed to collect sub-portions of the EC projects, where the
|
||||
pattern is <code class="code">FP7/SpecificProgramme/ScientificArea</code>.</p>
|
||||
<p>Additional parameters can be concatenated to the URL to refine the results by date (date
|
||||
must be in the form <code class="code">YYYY-MM-DD</code>): </p><table border="0" summary="Simple list" class="simplelist"><tr><td>startFrom</td></tr><tr><td>startUntil</td></tr><tr><td>endFrom</td></tr><tr><td>endUntil</td></tr></table>
|
||||
|
||||
<p>Examples: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>Get projects of the specific programme “SP2-IDEAS” for Eprints: <a class="ulink" href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a></td></tr><tr><td>Get FP7 projects for Dspace that started after the given date: <a class="ulink" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a></td></tr></table><p>
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="chapter" title="Chapter 4. Selective access with HTTP API"><div class="titlepage"><div><div><h2 class="title"><a name="cha_http-api"></a>Chapter 4. Selective access with HTTP API</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></div>
|
||||
|
||||
<p>The OpenAIRE+ HTTP API allows developers to access the information space of OpenAIRE+ by
|
||||
performing queries over publications, datasets, and projects.</p>
|
||||
<p>The API is intended for discovery and exploration only, that is it does not provide access
|
||||
to the whole informaton space, but the number of total results returned by one query is limited
|
||||
to 1000.</p>
|
||||
<p>For accessing the whole information space, developers are encouraged to use the <a class="xref" href="#cha_oai_pmh" title="Chapter 2. Bulk access via OAI-PMH">OAI-PMH</a></p>
|
||||
|
||||
<div class="section" title="Common API parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-common"></a>Common API parameters</h2></div></div></div>
|
||||
|
||||
<p> Parameters included in this section can always be specified, regardless the type of
|
||||
entities (publications, datasets, or projects) you want to retrieve. </p>
|
||||
<p>To query for publications: <code class="code">http://api.openaire.eu/search/publications</code></p>
|
||||
<p>To query for datasets: <code class="code">http://api.openaire.eu/search/datasets</code></p>
|
||||
<p>To query for projects: <code class="code">http://api.openaire.eu/search/projects</code></p>
|
||||
<p>Katerina: add in the list below parameters for paging and other common parameters exposed by
|
||||
the API.</p>
|
||||
<div class="variablelist"><dl><dt><span class="term">hasECFunding</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>. If hasECFunding is true gets the publications/datasets/projects
|
||||
funded by the EC. If hasECFunding is false gets the publications/datasets/projects
|
||||
related to projects not funded by the EC. </p>
|
||||
|
||||
</dd><dt><span class="term">hasUKFunding</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>.If hasUKFunding is true gets the publications/datasets/projects
|
||||
funded by the UK. If hasUKFunding is false gets the publications/datasets/projects
|
||||
related to projects not funded by the UK.</p>
|
||||
|
||||
</dd><dt><span class="term">funder</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">wt|fp7|h2020</code>. Search for publications/datasets/projects by funder.</p>
|
||||
|
||||
</dd><dt><span class="term">fundingStream</span></dt><dd>
|
||||
<p>earch for publications/datasets/projects by funding stream.</p>
|
||||
|
||||
</dd><dt><span class="term">FP7scientificArea</span></dt><dd>
|
||||
<p>Search for FP7 publications/datasets/projects by scientific area. </p>
|
||||
|
||||
</dd></dl></div>
|
||||
</div>
|
||||
<div class="section" title="Publications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-pubs"></a>Publications</h2></div></div></div>
|
||||
|
||||
<p>Endpoint: <code class="code">http://api.openaire.eu/search/publications</code></p>
|
||||
|
||||
|
||||
|
||||
<div class="variablelist"><dl><dt><span class="term">doi</span></dt><dd>
|
||||
<p>Gets the publication with the given doi, if any.</p>
|
||||
|
||||
</dd><dt><span class="term">openairePublicationID</span></dt><dd>
|
||||
<p>Gets the publication with the given openaire identifier, if any.</p>
|
||||
|
||||
</dd><dt><span class="term">fromDateAccepted</span></dt><dd>
|
||||
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the publications whose date of acceptance is greater than or equal the given
|
||||
date.</p>
|
||||
|
||||
</dd><dt><span class="term">toDateAccepted</span></dt><dd>
|
||||
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the publications whose date of acceptance is less than or equal the given date.</p>
|
||||
|
||||
</dd><dt><span class="term">title</span></dt><dd>
|
||||
<p>Allowed values: white-space separated list of keywords. Gets the publications whose titles contain the given list of keywords.</p>
|
||||
|
||||
</dd><dt><span class="term">author</span></dt><dd>
|
||||
<p>Search for publications by authors. Allowed value is a white-space separated list of
|
||||
names and/or surnames.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireAuthorID</span></dt><dd>
|
||||
<p>Search for publications by openaire author identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireProviderID</span></dt><dd>
|
||||
<p>Search for publications by openaire data provider identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireProjectID</span></dt><dd>
|
||||
<p>Search for publications by openaire project identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">hasProject</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>. 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.</p>
|
||||
|
||||
</dd><dt><span class="term">FP7ProjectID</span></dt><dd>
|
||||
<p>Search for publications associated to a FP7 project with the given grant number.</p>
|
||||
|
||||
</dd><dt><span class="term">OA</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>. If OA is true gets Open Access publications.
|
||||
If OA is false gets the non Open Access publications</p>
|
||||
|
||||
</dd></dl></div>
|
||||
|
||||
</div>
|
||||
<div class="section" title="Datasets"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-datasets"></a>Datasets</h2></div></div></div>
|
||||
|
||||
<p>Endpoint: <code class="code">http://api.openaire.eu/search/datasets</code></p>
|
||||
|
||||
|
||||
|
||||
<div class="variablelist"><dl><dt><span class="term">doi</span></dt><dd>
|
||||
<p>Gets the dataset with the given doi, if any.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireDatasetID</span></dt><dd>
|
||||
<p>Gets the dataset with the given openaire identifier, if any.</p>
|
||||
|
||||
</dd><dt><span class="term">fromDateCollected</span></dt><dd>
|
||||
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is greater than or equal the given
|
||||
date.</p>
|
||||
|
||||
</dd><dt><span class="term">toDateCollected</span></dt><dd>
|
||||
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is less than or equal the given date.</p>
|
||||
|
||||
</dd><dt><span class="term">title</span></dt><dd>
|
||||
<p>Gets the datasets whose titles contain the given list of keywords. Allowed value
|
||||
is a white-space separated list of keywords.</p>
|
||||
|
||||
</dd><dt><span class="term">author</span></dt><dd>
|
||||
<p>Search for datasets by authors. Allowed value is a white-space separated list of
|
||||
names and/or surnames.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireAuthorID</span></dt><dd>
|
||||
<p>Search for datasets by openaire author identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireProviderID</span></dt><dd>
|
||||
<p>Search for datasets by openaire data provider identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">openaireProjectID</span></dt><dd>
|
||||
<p>Search for datasets by openaire project identifier.</p>
|
||||
|
||||
</dd><dt><span class="term">hasProject</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>. 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.</p>
|
||||
|
||||
</dd><dt><span class="term">FP7ProjectID</span></dt><dd>
|
||||
<p>Search for datasets associated to a FP7 project with the given grant number.</p>
|
||||
|
||||
</dd><dt><span class="term">OA</span></dt><dd>
|
||||
<p>Allowed values: <code class="code">true|false</code>. If OA is true gets Open Access datasets.
|
||||
If OA is false gets the non Open Access datasets</p>
|
||||
|
||||
</dd></dl></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div></body></html>
|
||||
Loading…
Reference in New Issue