| 1 |
26607
|
alessia.ba
|
<?xml version="1.0" encoding="UTF-8"?>
|
| 2 |
|
|
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
|
| 3 |
28027
|
alessia.ba
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-projects" xreflabel="Search HTTP API for metadata about projects">
|
| 4 |
26607
|
alessia.ba
|
<title>Projects</title>
|
| 5 |
|
|
<para>Endpoint: <code>http://api.openaire.eu/search/projects</code></para>
|
| 6 |
|
|
<!-- TODO: uncomment when the API version feature is implemented -->
|
| 7 |
|
|
<!-- <para>Endpoint to a specific version of the API: <code>http://api.openaire.eu/search/{API_VERSION}/projects</code></para> -->
|
| 8 |
|
|
|
| 9 |
|
|
<variablelist>
|
| 10 |
|
|
<varlistentry>
|
| 11 |
|
|
<term>grantID</term>
|
| 12 |
|
|
<listitem>
|
| 13 |
|
|
<para>Gets the project with the given grant identifier, if any.</para>
|
| 14 |
|
|
<para><code>here goes the sample query</code></para>
|
| 15 |
|
|
</listitem>
|
| 16 |
|
|
</varlistentry>
|
| 17 |
|
|
<varlistentry>
|
| 18 |
|
|
<term>name</term>
|
| 19 |
|
|
<listitem>
|
| 20 |
|
|
<para>Allowed values: white-space separated list of keywords. Gets the projects whose names contain the given list of keywords. </para>
|
| 21 |
|
|
<para><code>here goes the sample query</code></para>
|
| 22 |
|
|
</listitem>
|
| 23 |
|
|
</varlistentry>
|
| 24 |
|
|
<varlistentry>
|
| 25 |
|
|
<term>acronym</term>
|
| 26 |
|
|
<listitem>
|
| 27 |
|
|
<para>Gets the project with the given acronym, if any. </para>
|
| 28 |
|
|
<para><code>here goes the sample query</code></para>
|
| 29 |
|
|
</listitem>
|
| 30 |
|
|
</varlistentry>
|
| 31 |
|
|
<varlistentry>
|
| 32 |
|
|
<term>callID</term>
|
| 33 |
|
|
<listitem>
|
| 34 |
|
|
<para>Search for projects by call identifier.</para>
|
| 35 |
|
|
<para><code>here goes the sample query</code></para>
|
| 36 |
|
|
</listitem>
|
| 37 |
|
|
</varlistentry>
|
| 38 |
|
|
<varlistentry>
|
| 39 |
|
|
<term>keywords</term>
|
| 40 |
|
|
<listitem>
|
| 41 |
|
|
<para>Allowed values: white-space separated list of keywords. Search for projects whose name, title, description or keywords match the given terms. </para>
|
| 42 |
|
|
<para><code>here goes the sample query</code></para>
|
| 43 |
|
|
</listitem>
|
| 44 |
|
|
</varlistentry>
|
| 45 |
|
|
<varlistentry>
|
| 46 |
|
|
<term>startYear</term>
|
| 47 |
|
|
<listitem>
|
| 48 |
|
|
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that started in the given year. </para>
|
| 49 |
|
|
<para><code>here goes the sample query</code></para>
|
| 50 |
|
|
</listitem>
|
| 51 |
|
|
</varlistentry>
|
| 52 |
|
|
<varlistentry>
|
| 53 |
|
|
<term>endYear</term>
|
| 54 |
|
|
<listitem>
|
| 55 |
|
|
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that ended in the given year. </para>
|
| 56 |
|
|
<para><code>here goes the sample query</code></para>
|
| 57 |
|
|
</listitem>
|
| 58 |
|
|
</varlistentry>
|
| 59 |
|
|
<varlistentry>
|
| 60 |
|
|
<term>participantCountries</term>
|
| 61 |
|
|
<listitem>
|
| 62 |
|
|
<para>Allowed values: white space separeted list of country codes in ISOXXX. Search for projects by participant countries. </para>
|
| 63 |
|
|
<para><code>here goes the sample query</code></para>
|
| 64 |
|
|
</listitem>
|
| 65 |
|
|
</varlistentry>
|
| 66 |
|
|
<varlistentry>
|
| 67 |
|
|
<term>participantAcronyms</term>
|
| 68 |
|
|
<listitem>
|
| 69 |
|
|
<para>Allowed values: white space separeted list of acronyms of institutions. Search for projects by participant institutions. </para>
|
| 70 |
|
|
<para><code>here goes the sample query</code></para>
|
| 71 |
|
|
</listitem>
|
| 72 |
|
|
</varlistentry>
|
| 73 |
|
|
</variablelist>
|
| 74 |
|
|
|
| 75 |
|
|
</section>
|