102 lines
4.2 KiB
XML
102 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-pubs" xreflabel="Search HTTP API for metadata about publications">
|
|
<title>Publications</title>
|
|
<para>Endpoint: <code>http://api.openaire.eu/search/publications</code></para>
|
|
<!-- TODO: uncomment when the API version feature is implemented -->
|
|
<!-- <para>Endpoint to a specific version of the API: <code>http://api.openaire.eu/search/{API_VERSION}/publications</code></para> -->
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>doi</term>
|
|
<listitem>
|
|
<para>Allowed values: comma separated list of DOIs.Gets the publications with the given DOIs, if any.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>openairePublicationID</term>
|
|
<listitem>
|
|
<para>Gets the publication with the given openaire identifier, if any.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>fromDateAccepted</term>
|
|
<listitem>
|
|
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the publications whose date of acceptance is greater than or equal the given
|
|
date.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>toDateAccepted</term>
|
|
<listitem>
|
|
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the publications whose date of acceptance is less than or equal the given date.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>title</term>
|
|
<listitem>
|
|
<para>Allowed values: white-space separated list of keywords. Gets the publications whose titles contain the given list of keywords.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>author</term>
|
|
<listitem>
|
|
<para>Search for publications by authors. Allowed value is a white-space separated list of
|
|
names and/or surnames.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>openaireAuthorID</term>
|
|
<listitem>
|
|
<para>Search for publications by openaire author identifier.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>openaireProviderID</term>
|
|
<listitem>
|
|
<para>Search for publications by openaire data provider identifier.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>openaireProjectID</term>
|
|
<listitem>
|
|
<para>Search for publications by openaire project identifier.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>hasProject</term>
|
|
<listitem>
|
|
<para>Allowed values: <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.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>FP7ProjectID</term>
|
|
<listitem>
|
|
<para>Search for publications associated to a FP7 project with the given grant number.</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>OA</term>
|
|
<listitem>
|
|
<para>Allowed values: <code>true|false</code>. If OA is true gets Open Access publications.
|
|
If OA is false gets the non Open Access publications</para>
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</section>
|