|
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-datasets" xreflabel="Search HTTP API for metadata about datasets">
|
|
4
|
<title>Datasets</title>
|
|
5
|
<para>Endpoint: <code>http://api.openaire.eu/search/datasets</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}/datasets</code></para> -->
|
|
8
|
|
|
9
|
<variablelist>
|
|
10
|
<varlistentry>
|
|
11
|
<term>doi</term>
|
|
12
|
<listitem>
|
|
13
|
<para>Gets the dataset with the given doi, if any.</para>
|
|
14
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
15
|
</listitem>
|
|
16
|
</varlistentry>
|
|
17
|
<varlistentry>
|
|
18
|
<term>openaireDatasetID</term>
|
|
19
|
<listitem>
|
|
20
|
<para>Gets the dataset with the given openaire identifier, if any.</para>
|
|
21
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
22
|
</listitem>
|
|
23
|
</varlistentry>
|
|
24
|
<varlistentry>
|
|
25
|
<term>fromDateCollected</term>
|
|
26
|
<listitem>
|
|
27
|
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is greater than or equal the given
|
|
28
|
date.</para>
|
|
29
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
30
|
</listitem>
|
|
31
|
</varlistentry>
|
|
32
|
<varlistentry>
|
|
33
|
<term>toDateCollected</term>
|
|
34
|
<listitem>
|
|
35
|
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is less than or equal the given date.</para>
|
|
36
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
37
|
</listitem>
|
|
38
|
</varlistentry>
|
|
39
|
<varlistentry>
|
|
40
|
<term>title</term>
|
|
41
|
<listitem>
|
|
42
|
<para>Gets the datasets whose titles contain the given list of keywords. Allowed value
|
|
43
|
is a white-space separated list of keywords.</para>
|
|
44
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
45
|
</listitem>
|
|
46
|
</varlistentry>
|
|
47
|
<varlistentry>
|
|
48
|
<term>author</term>
|
|
49
|
<listitem>
|
|
50
|
<para>Search for datasets by authors. Allowed value is a white-space separated list of
|
|
51
|
names and/or surnames.</para>
|
|
52
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
53
|
</listitem>
|
|
54
|
</varlistentry>
|
|
55
|
<varlistentry>
|
|
56
|
<term>openaireAuthorID</term>
|
|
57
|
<listitem>
|
|
58
|
<para>Search for datasets by openaire author identifier.</para>
|
|
59
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
60
|
</listitem>
|
|
61
|
</varlistentry>
|
|
62
|
<varlistentry>
|
|
63
|
<term>openaireProviderID</term>
|
|
64
|
<listitem>
|
|
65
|
<para>Search for datasets by openaire data provider identifier.</para>
|
|
66
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
67
|
</listitem>
|
|
68
|
</varlistentry>
|
|
69
|
<varlistentry>
|
|
70
|
<term>openaireProjectID</term>
|
|
71
|
<listitem>
|
|
72
|
<para>Search for datasets by openaire project identifier.</para>
|
|
73
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
74
|
</listitem>
|
|
75
|
</varlistentry>
|
|
76
|
<varlistentry>
|
|
77
|
<term>hasProject</term>
|
|
78
|
<listitem>
|
|
79
|
<para>Allowed values: <code>true|false</code>. If hasProject is true gets the datasets
|
|
80
|
that have a link to a project. If hasProject is false gets the datasets with no links
|
|
81
|
to projects.</para>
|
|
82
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
83
|
</listitem>
|
|
84
|
</varlistentry>
|
|
85
|
<varlistentry>
|
|
86
|
<term>FP7ProjectID</term>
|
|
87
|
<listitem>
|
|
88
|
<para>Search for datasets associated to a FP7 project with the given grant number.</para>
|
|
89
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
90
|
</listitem>
|
|
91
|
</varlistentry>
|
|
92
|
<varlistentry>
|
|
93
|
<term>OA</term>
|
|
94
|
<listitem>
|
|
95
|
<para>Allowed values: <code>true|false</code>. If OA is true gets Open Access datasets.
|
|
96
|
If OA is false gets the non Open Access datasets</para>
|
|
97
|
<!--<para><code>here goes the sample query</code></para> -->
|
|
98
|
</listitem>
|
|
99
|
</varlistentry>
|
|
100
|
</variablelist>
|
|
101
|
|
|
102
|
</section>
|