|
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
|
|
3
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-projects" xreflabel="Search HTTP API for metadata about projects">
|
|
4
|
<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>sortBy</term>
|
|
12
|
<listitem>
|
|
13
|
<para>Select the sorting order: <code>sortBy=field,[ascending|descending]</code></para>
|
|
14
|
<para>where <code>field</code> is one of: <code>projectstartdate</code>, <code>projectstartyear</code>, <code>projectenddate</code>, <code>projectendyear</code>, <code>projectduration</code></para>
|
|
15
|
</listitem>
|
|
16
|
</varlistentry>
|
|
17
|
<varlistentry>
|
|
18
|
<term>grantID</term>
|
|
19
|
<listitem>
|
|
20
|
<para>Gets the project with the given grant identifier, if any.</para>
|
|
21
|
</listitem>
|
|
22
|
</varlistentry>
|
|
23
|
<varlistentry>
|
|
24
|
<term>name</term>
|
|
25
|
<listitem>
|
|
26
|
<para>Allowed values: white-space separated list of keywords. Gets the projects whose names contain the given list of keywords. </para>
|
|
27
|
</listitem>
|
|
28
|
</varlistentry>
|
|
29
|
<varlistentry>
|
|
30
|
<term>acronym</term>
|
|
31
|
<listitem>
|
|
32
|
<para>Gets the project with the given acronym, if any. </para></listitem>
|
|
33
|
</varlistentry>
|
|
34
|
<varlistentry>
|
|
35
|
<term>callID</term>
|
|
36
|
<listitem>
|
|
37
|
<para>Search for projects by call identifier.</para>
|
|
38
|
</listitem>
|
|
39
|
</varlistentry>
|
|
40
|
<varlistentry>
|
|
41
|
<term>startYear</term>
|
|
42
|
<listitem>
|
|
43
|
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that started in the given year. </para>
|
|
44
|
</listitem>
|
|
45
|
</varlistentry>
|
|
46
|
<varlistentry>
|
|
47
|
<term>endYear</term>
|
|
48
|
<listitem>
|
|
49
|
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that ended in the given year. </para>
|
|
50
|
</listitem>
|
|
51
|
</varlistentry>
|
|
52
|
<varlistentry>
|
|
53
|
<term>participantCountries</term>
|
|
54
|
<listitem>
|
|
55
|
<para>Allowed values: comma separeted list of 2 letter country codes. Search for projects by participant countries. </para>
|
|
56
|
</listitem>
|
|
57
|
</varlistentry>
|
|
58
|
<varlistentry>
|
|
59
|
<term>participantAcronyms</term>
|
|
60
|
<listitem>
|
|
61
|
<para>Allowed values: white space separeted list of acronyms of institutions. Search for projects by participant institutions. </para>
|
|
62
|
</listitem>
|
|
63
|
</varlistentry>
|
|
64
|
</variablelist>
|
|
65
|
|
|
66
|
</section>
|