1
|
|
2
|
|
3
|
<!DOCTYPE html>
|
4
|
<html lang="en-gb">
|
5
|
<head>
|
6
|
<!--link href="http://demo.openaire.eu" rel="canonical" /-->
|
7
|
<meta charset="utf-8">
|
8
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
9
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
10
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
11
|
<meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission, EC, FP7, ERC,
|
12
|
Horizon 2020, H2020, search, projects, publications, research data, datasets, HTTP, funders "/>
|
13
|
<link href="./assets/favicon.ico" rel="shortcut icon" />
|
14
|
<title>OpenAIRE API documentation - Selective access</title>
|
15
|
<script src="./assets/jquery.js"></script>
|
16
|
<script src="./assets/uikit.js"></script>
|
17
|
<script src="./assets/uikit-icon-max.js"></script>
|
18
|
<link rel="stylesheet" type="text/css" href="./assets/theme.css">
|
19
|
<link rel="stylesheet" type="text/css" href="./assets/custom.css">
|
20
|
<link rel="stylesheet" type="text/css" href="./assets/custom.css.1">
|
21
|
|
22
|
</head>
|
23
|
<body class="" style="">
|
24
|
<div class="uk-offcanvas-content uk-height-viewport">
|
25
|
<!-- MENU STARTS HERE-->
|
26
|
<!-- MAIN MENU STARTS HERE-->
|
27
|
<div class="tm-header-mobile uk-hidden@m">
|
28
|
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" uk-sticky="">
|
29
|
<nav class="uk-navbar-container uk-navbar" uk-navbar="">
|
30
|
<div class="uk-navbar-left">
|
31
|
<a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="" style="z-index:1000;">
|
32
|
<div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon custom-navbar-toggle-icon"> </div>
|
33
|
</a>
|
34
|
</div>
|
35
|
<div class="uk-navbar-center uk-margin-left">
|
36
|
<img src="./assets/apple-icon-72x72.png" alt="OpenAIRE" class="uk-responsive-height">
|
37
|
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-visible@m" routerLinkActive="uk-link" routerLink="/" >
|
38
|
OpenAIRE API Documentation</a>
|
39
|
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-hidden@m" routerLinkActive="uk-link" routerLink="/" >
|
40
|
API Documentation</a>
|
41
|
</div>
|
42
|
</nav>
|
43
|
<div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
|
44
|
<div class="uk-offcanvas-bar">
|
45
|
<button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close=""></button>
|
46
|
<div class="uk-child-width-1-1 uk-grid" uk-grid="">
|
47
|
<div>
|
48
|
<div class="uk-panel" id="module-0">
|
49
|
<ul class="uk-nav uk-nav-default">
|
50
|
<li class="uk-nav-header uk-parent">
|
51
|
<a href="./overview.html"> Overview </a>
|
52
|
</li>
|
53
|
<li class="uk-nav-header uk-parent">
|
54
|
Bulk access
|
55
|
<ul class="uk-nav-sub">
|
56
|
<li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH</a></li>
|
57
|
<li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
|
58
|
</ul>
|
59
|
</li>
|
60
|
|
61
|
<li class="uk-nav-header uk-parent uk-active">
|
62
|
<a href="./api.html">Selective access</a>
|
63
|
<ul class="uk-nav-sub">
|
64
|
<li><a href="./api.html#pubs" >Publications</a></li>
|
65
|
<li><a href="./api.html#datasets" >Research Data</a></li>
|
66
|
<li><a href="./api.html#projects" >Projects</a></li>
|
67
|
</ul>
|
68
|
</li>
|
69
|
</ul>
|
70
|
</div>
|
71
|
</div>
|
72
|
</div>
|
73
|
</div>
|
74
|
</div>
|
75
|
</div>
|
76
|
</div>
|
77
|
<div class="tm-header uk-visible@m tm-header-transparent" uk-header=""><!-- top=".tm-header" + [class*="uk-section"] -->
|
78
|
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" media="768" uk-sticky="">
|
79
|
<div class="uk-container uk-container-expand">
|
80
|
<nav class="uk-navbar" uk-navbar="{"align":"left"}" style="background-color:white !important;">
|
81
|
<div class="uk-navbar-center">
|
82
|
<div class="uk-logo uk-navbar-item uk-margin-small-top">
|
83
|
<img alt="OpenAIRE" class="uk-responsive-height" src="./assets/Logo_Horizontal.png">
|
84
|
</div>
|
85
|
<div class="uk-logo uk-navbar-item uk-margin-medium-top">
|
86
|
<h3 style="color: #767779 !important;"> API Documentation </h3>
|
87
|
</div>
|
88
|
</div>
|
89
|
<div class="uk-navbar-right">
|
90
|
<ul class="uk-navbar-nav uk-margin-small-top">
|
91
|
<li>
|
92
|
<a href="./overview.html"><span class="uk-icon" uk-icon="icon: home"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" ratio="1"> <polygon points="18.65 11.35 10 2.71 1.35 11.35 0.65 10.65 10 1.29 19.35 10.65"></polygon> <polygon points="15 4 18 4 18 7 17 7 17 5 15 5"></polygon> <polygon points="3 11 4 11 4 18 7 18 7 12 12 12 12 18 16 18 16 11 17 11 17 19 11 19 11 13 8 13 8 19 3 19"></polygon></svg></span></a>
|
93
|
</li>
|
94
|
<li>
|
95
|
<a href="#">Bulk access</a>
|
96
|
<div class="uk-navbar-dropdown">
|
97
|
<ul class="uk-nav uk-navbar-dropdown-nav">
|
98
|
<li><a href="./oai-pmh.html">OAI-PMH</a></li>
|
99
|
<li><a href="./bulk-projects.html">Bulk access to projects</a></li>
|
100
|
</ul>
|
101
|
</div>
|
102
|
</li>
|
103
|
<li class="uk-active">
|
104
|
<a href="#">Selective access</a>
|
105
|
<div class="uk-navbar-dropdown">
|
106
|
<ul class="uk-nav uk-navbar-dropdown-nav">
|
107
|
<li><a href="./api.html#pubs">Publications</a></li>
|
108
|
<li><a href="./api.html#datasets">Datasets</a></li>
|
109
|
<li><a href="./api.html#projects">Projects</a></li>
|
110
|
</ul>
|
111
|
</div>
|
112
|
</li>
|
113
|
</ul>
|
114
|
</div>
|
115
|
</nav>
|
116
|
</div>
|
117
|
</div>
|
118
|
</div>
|
119
|
<!-- MENU ENDS HERE-->
|
120
|
|
121
|
<div class=" first_page_section uk-section-default uk-section uk-padding-remove-vertical">
|
122
|
<div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
|
123
|
</div>
|
124
|
</div>
|
125
|
|
126
|
<div class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
|
127
|
<div class="uk-container">
|
128
|
<div class="uk-grid">
|
129
|
<div class="uk-width-1-3@s uk-width-1-4@m uk-width-1-4@l uk-visible@m" >
|
130
|
<ul class="uk-nav-default uk-nav-parent-icon" uk-nav="multiple: false" uk-sticky="offset: 100; media:@s" >
|
131
|
<li class="uk-parent uk-open">
|
132
|
<a href="#">HTTP API Documentation</a>
|
133
|
<ul class="uk-nav-sub">
|
134
|
<li><a href="#common" uk-scroll>Common Parameters</a></li>
|
135
|
<li><a href="#pubs" uk-scroll>Publications</a></li>
|
136
|
<li><a href="#datasets" uk-scroll>Datasets</a></li>
|
137
|
<li><a href="#projects" uk-scroll>Projects</a></li>
|
138
|
</ul>
|
139
|
</li>
|
140
|
</ul>
|
141
|
</div>
|
142
|
|
143
|
|
144
|
<div class="tm-main uk-width-expand uk-row-first uk-first-column">
|
145
|
<!--div class="uk-text-right" uk-sticky="offset:100; animation: uk-animation-slide-bottom; bottom: #bottom">
|
146
|
<a class="uk-totop" href="#" uk-scroll="" uk-totop="">
|
147
|
</a>
|
148
|
</div-->
|
149
|
<!--div class="uk-card uk-margin-remove uk-padding-remove uk-card-default uk-card-body" style="z-index: 980;" uk-sticky="offset:100; bottom: #bottom">
|
150
|
<a class="uk-totop" href="#" uk-scroll="" uk-totop="">
|
151
|
</a></div-->
|
152
|
<div class="uk-alert-danger" uk-alert>
|
153
|
<p>
|
154
|
<!--Dear users,<br>-->
|
155
|
OpenAIRE team is about to release a major update in services & portals. During September, you may notice downtime in services, while some functionalities (e.g. user registration, validation, claiming) will be temporarily disabled.
|
156
|
We are sorry for the inconvenience, please stay tuned!
|
157
|
</p>
|
158
|
</div>
|
159
|
<div class="uk-alert-danger" uk-alert>
|
160
|
<p>Openaire XML Schema has been changed! Please <a href="https://www.openaire.eu/openaire-xml-schema-change-announcement" target="_blank">click here</a> to learn more!</p>
|
161
|
</div>
|
162
|
|
163
|
<p>
|
164
|
The OpenAIRE HTTP API allows developers to access the metadata information space of OpenAIRE by performing queries over publications, datasets, and projects.
|
165
|
The API is intended for metadata discovery and exploration only, that is it does not give direct access to publication files and it does not provide access to
|
166
|
the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole information space, developers are
|
167
|
encouraged to use the <a href="http://api.openaire.eu/#cha_oai_pmh" target="_blank">OAI-PMH</a>.<br>
|
168
|
</p>
|
169
|
|
170
|
<div>
|
171
|
<h4>TERMS OF USE AND SLA</h4>
|
172
|
<p><strong>OpenAIRE HTTP API</strong>: the APIs are free-to-use (no sign-up needed) by any third-party service. Note that:</p>
|
173
|
<ul>
|
174
|
<li>The HTTP API limits each query to 10,000 paged results; for unlimited access to the APIs please contact <a href="mailto:paolo.manghi@isti.cnr.it">the service administrators</a>.
|
175
|
</li>
|
176
|
<li>Since 2015 an <a href="https://zenodo.org/record/51077#.WsdCFdNubOR">RDF dump of the LOD is made available in Zenodo.org</a></li>
|
177
|
</ul>
|
178
|
<p><strong> Metadata license is CC-BY</strong>: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as content provider.
|
179
|
</p>
|
180
|
<p><strong>Quality of Service</strong>: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the <a href="http://icm.edu.pl/en/centre-of-technology/">data center</a> facilities of the <a href="http://icm.edu.pl/en/">Interdisciplinary Centre for Mathematical and Computational Modelling</a> (ICM).
|
181
|
</p>
|
182
|
<p><strong>APIs rate limits</strong>
|
183
|
<ul>
|
184
|
<li>no more than 30 concurrent connections from single IP to any APIs</li>
|
185
|
<li>no more than 67 concurrent requests in total</li>
|
186
|
<li>no more then 37 concurrent request in total (max 30 per single IP) to the HTTP API for selective access</li>
|
187
|
<li>no more than 15 requests/second to the HTTP API for selective access (in total, not per IP. If this limit is reached, requests will be delayed).</li>
|
188
|
</ul>
|
189
|
</p>
|
190
|
</div>
|
191
|
|
192
|
|
193
|
<h2 id="common">Common Parameters</h2>
|
194
|
|
195
|
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
|
196
|
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
197
|
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
|
198
|
To query for datasets metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
|
199
|
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
|
200
|
</p>
|
201
|
|
202
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small">
|
203
|
<thead>
|
204
|
<tr>
|
205
|
<th>Parameter</th>
|
206
|
<th>Option</th>
|
207
|
<th>Description</th>
|
208
|
</tr>
|
209
|
</thead>
|
210
|
<tbody>
|
211
|
<tr>
|
212
|
<td>page</td>
|
213
|
<td>integer</td>
|
214
|
<td>Page number of the search results.</td>
|
215
|
</tr>
|
216
|
<tr>
|
217
|
<td>size</td>
|
218
|
<td>integer</td>
|
219
|
<td>Number of results per page.</td>
|
220
|
</tr>
|
221
|
<tr>
|
222
|
<td>format</td>
|
223
|
<td>json | xml | csv | tsv</td>
|
224
|
<td>The format of the response. The default is xml.</td>
|
225
|
</tr>
|
226
|
<tr>
|
227
|
<td>model</td>
|
228
|
<td>openaire | sygma</td>
|
229
|
<td>The data model of the response. Default is openaire. Model sygma is a simplified version of the openaire model. For sygma, only the xml format is available. The relative XML schema is available <a href="https://www.openaire.eu/schema/sygma/oaf_sygma_v2.1.xsd" target="_blank">here</a>.</td>
|
230
|
</tr>
|
231
|
<tr>
|
232
|
<td>sortBy</td>
|
233
|
<td><code>sortBy=field,[ascending|descending]</code></td>
|
234
|
<td>The sorting order of the specified field. For the list of sortable fields, please refer to the documentation relative to the specific type of entity you are querying for.</td>
|
235
|
</tr>
|
236
|
<tr>
|
237
|
<td>hasECFunding</td>
|
238
|
<td>true | false</td>
|
239
|
<td>If hasECFunding is true gets the entities funded by the EC. If hasECFunding is false gets the entities related to projects not funded by the EC.</td>
|
240
|
</tr>
|
241
|
<tr>
|
242
|
<td>hasWTFunding</td>
|
243
|
<td>true | false</td>
|
244
|
<td>If hasWTFunding is true gets the entities funded by Wellcome Trust. The results are the same as those obtained with <code>funder=wt</code>. If hasWTFunding is false gets the entities related to projects not funded by Wellcome Trust.</td>
|
245
|
</tr>
|
246
|
<tr>
|
247
|
<td>funder</td>
|
248
|
<td>WT | EC | ARC | ANDS | NSF | FCT | NHMRC</td>
|
249
|
<td>Search for entities by funder.</td>
|
250
|
</tr>
|
251
|
<tr>
|
252
|
<td>fundingStream</td>
|
253
|
<td>...</td>
|
254
|
<td>Search for entities by funding stream.</td>
|
255
|
</tr>
|
256
|
<tr>
|
257
|
<td>FP7scientificArea</td>
|
258
|
<td>...</td>
|
259
|
<td>Search for FP7 entities by scientific area.</td>
|
260
|
</tr>
|
261
|
<tr>
|
262
|
<td>keywords</td>
|
263
|
<td>White-space separated list of keywords.</td>
|
264
|
<td>N/A</td>
|
265
|
</tr>
|
266
|
</tbody>
|
267
|
</table>
|
268
|
|
269
|
<h2 id="pubs">Publication specific parameters</h2>
|
270
|
<p>Endpoint: <strong>http://api.openaire.eu/search/publications</strong></p>
|
271
|
|
272
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
273
|
<thead>
|
274
|
<tr>
|
275
|
<th>Parameter</th>
|
276
|
<th>Option</th>
|
277
|
<th>Description</th>
|
278
|
</tr>
|
279
|
</thead>
|
280
|
<tbody>
|
281
|
<tr>
|
282
|
<td>sortBy</td>
|
283
|
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
|
284
|
<td>The sorting order of the specified field.</td>
|
285
|
</tr>
|
286
|
<tr>
|
287
|
<td>doi</td>
|
288
|
<td>Comma separated list of DOIs. <br>
|
289
|
Alternatively, it is possible to repeat the parameter for each requested doi.
|
290
|
</td>
|
291
|
<td>Gets the publications with the given DOIs, if any.</td>
|
292
|
</tr>
|
293
|
<tr>
|
294
|
<td>openairePublicationID</td>
|
295
|
<td>Comma separated list of OpenAIRE identifiers. <br>
|
296
|
Alternatively, it is possible to repeat the parameter for each requested identifier.
|
297
|
</td>
|
298
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
299
|
</tr>
|
300
|
<tr>
|
301
|
<td>fromDateAccepted</td>
|
302
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
303
|
<td>Gets the publications whose date of acceptance is greater than or equal the given date.</td>
|
304
|
</tr>
|
305
|
<tr>
|
306
|
<td>toDateAccepted</td>
|
307
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
308
|
<td>Gets the publications whose date of acceptance is less than or equal the given date.</td>
|
309
|
</tr>
|
310
|
<tr>
|
311
|
<td>title</td>
|
312
|
<td>White-space separated list of keywords.</td>
|
313
|
<td>Gets the publications whose titles contain the given list of keywords.</td>
|
314
|
</tr>
|
315
|
<tr>
|
316
|
<td>author</td>
|
317
|
<td>White-space separated list of names and/or surnames.</td>
|
318
|
<td>Search for publications by authors.</td>
|
319
|
</tr>
|
320
|
<tr>
|
321
|
<td>openaireProviderID</td>
|
322
|
<td>Comma separated list of identifiers.</td>
|
323
|
<td>Search for publications by openaire data provider identifier. <br>
|
324
|
Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
325
|
</tr>
|
326
|
<tr>
|
327
|
<td>openaireProjectID</td>
|
328
|
<td>Comma separated list of identifiers. <br>
|
329
|
Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
330
|
<td>Search for publications by openaire project identifier. Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
331
|
</tr>
|
332
|
<tr>
|
333
|
<td>hasProject</td>
|
334
|
<td>true | false</td>
|
335
|
<td>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.</td>
|
336
|
</tr>
|
337
|
<tr>
|
338
|
<td>projectID</td>
|
339
|
<td>...</td>
|
340
|
<td>The given grant identifier of the project.</td>
|
341
|
</tr>
|
342
|
<tr>
|
343
|
<td>FP7ProjectID</td>
|
344
|
<td>...</td>
|
345
|
<td>Search for publications associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
|
346
|
</tr>
|
347
|
<tr>
|
348
|
<td>OA</td>
|
349
|
<td>true | false</td>
|
350
|
<td>If OA is true gets Open Access publications. If OA is false gets the non Open Access publications</td>
|
351
|
</tr>
|
352
|
</tbody>
|
353
|
</table>
|
354
|
|
355
|
<h2 id="datasets">Dataset specific parameters</h2>
|
356
|
<p>Endpoint: <strong>http://api.openaire.eu/search/datasets</strong></p>
|
357
|
|
358
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
359
|
<thead>
|
360
|
<tr>
|
361
|
<th>Parameter</th>
|
362
|
<th>Option</th>
|
363
|
<th>Description</th>
|
364
|
</tr>
|
365
|
</thead>
|
366
|
<tbody>
|
367
|
<tr>
|
368
|
<td>sortBy</td>
|
369
|
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></td>
|
370
|
<td>The sorting order of the specified field.</td>
|
371
|
</tr>
|
372
|
<tr>
|
373
|
<td>doi</td>
|
374
|
<td>Comma separated list of DOIs. <br>
|
375
|
Alternatively, it is possible to repeat the parameter for each requested doi.
|
376
|
</td>
|
377
|
<td>Gets the datasets with the given DOIs, if any.</td>
|
378
|
</tr>
|
379
|
<tr>
|
380
|
<td>openaireDatasetID</td>
|
381
|
<td>Comma separated list of OpenAIRE identifiers. <br>
|
382
|
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
|
383
|
<td>Gets the dataset with the given openaire identifier, if any.</td>
|
384
|
</tr>
|
385
|
<tr>
|
386
|
<td>fromDateAccepted</td>
|
387
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
388
|
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
|
389
|
</tr>
|
390
|
<tr>
|
391
|
<td>toDateAccepted</td>
|
392
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
393
|
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
|
394
|
</tr>
|
395
|
<tr>
|
396
|
<td>title</td>
|
397
|
<td>White-space separated list of keywords.</td>
|
398
|
<td>Gets the datasets whose titles contain the given list of keywords.</td>
|
399
|
</tr>
|
400
|
<tr>
|
401
|
<td>author</td>
|
402
|
<td>A white-space separated list of names and/or surnames</td>
|
403
|
<td>Search for datasets by authors.</td>
|
404
|
</tr>
|
405
|
<tr>
|
406
|
<td>openaireProviderID</td>
|
407
|
<td>Comma separated list of identifiers.</td>
|
408
|
<td>Search for datasets by openaire data provider identifier. <br>
|
409
|
Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
410
|
</tr>
|
411
|
<tr>
|
412
|
<td>openaireProjectID</td>
|
413
|
<td>Comma separated list of identifiers. </td>
|
414
|
<td>Search for datasets by openaire project identifier. <br>
|
415
|
Alternatively, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
416
|
</tr>
|
417
|
<tr>
|
418
|
<td>hasProject</td>
|
419
|
<td>true | false</td>
|
420
|
<td>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.</td>
|
421
|
</tr>
|
422
|
<tr>
|
423
|
<td>FP7ProjectID</td>
|
424
|
<td>...</td>
|
425
|
<td>Search for datasets associated to a FP7 project with the given grant number. It is equivalent to a query by <code>funder=FP7&projectID=grantID</code></td>
|
426
|
</tr>
|
427
|
<tr>
|
428
|
<td>OA</td>
|
429
|
<td>true | false</td>
|
430
|
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
|
431
|
</tr>
|
432
|
</tbody>
|
433
|
</table>
|
434
|
|
435
|
<h2 id="projects">Project specific parameters</h2>
|
436
|
<p>Endpoint: <strong>http://api.openaire.eu/search/projects</strong></p>
|
437
|
|
438
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
439
|
<thead>
|
440
|
<tr>
|
441
|
<th>Parameter</th>
|
442
|
<th>Option</th>
|
443
|
<th>Description</th>
|
444
|
</tr>
|
445
|
</thead>
|
446
|
<tbody>
|
447
|
<tr>
|
448
|
<td>sortBy</td>
|
449
|
<td><code>sortBy=field,[ascending|descending]</code>; <strong>'field'</strong> is one of: <code>projectstartdate</code>, <code>projectstartyear</code>, <code>projectenddate</code>, <code>projectendyear</code>, <code> projectduration</code></td>
|
450
|
<td>The sorting order of the specified field.</td>
|
451
|
</tr>
|
452
|
<tr>
|
453
|
<td>grantID</td>
|
454
|
<td>Comma separated list of DOIs.</td>
|
455
|
<td>Gets the project with the given grant identifier, if any.</td>
|
456
|
</tr>
|
457
|
<tr>
|
458
|
<td>openairePublicationID</td>
|
459
|
<td>Comma separated list of OpenAIRE identifiers.</td>
|
460
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
461
|
</tr>
|
462
|
<tr>
|
463
|
<td>name</td>
|
464
|
<td>White-space separated list of keywords.</td>
|
465
|
<td>Gets the projects whose names contain the given list of keywords.</td>
|
466
|
</tr>
|
467
|
<tr>
|
468
|
<td>acronym</td>
|
469
|
<td>N/A</td>
|
470
|
<td>Gets the project with the given acronym, if any.</td>
|
471
|
</tr>
|
472
|
<tr>
|
473
|
<td>callID</td>
|
474
|
<td>N/A</td>
|
475
|
<td>Search for projects by call identifier.</td>
|
476
|
</tr>
|
477
|
<tr>
|
478
|
<td>startYear</td>
|
479
|
<td>Year formatted as <code>YYYY</code></td>
|
480
|
<td>Gets the projects that started in the given year.</td>
|
481
|
</tr>
|
482
|
<tr>
|
483
|
<td>endYear</td>
|
484
|
<td>Year formatted as <code>YYYY</code>.</td>
|
485
|
<td>Gets the projects that ended in the given year.</td>
|
486
|
</tr>
|
487
|
<tr>
|
488
|
<td>participantCountries</td>
|
489
|
<td>Comma separeted list of 2 letter country codes.</td>
|
490
|
<td>Search for projects by participant countries.</td>
|
491
|
</tr>
|
492
|
<tr>
|
493
|
<td>participantAcronyms</td>
|
494
|
<td>White space separeted list of acronyms of institutions.</td>
|
495
|
<td>Search for projects by participant institutions.</td>
|
496
|
</tr>
|
497
|
</tbody>
|
498
|
</table>
|
499
|
|
500
|
<div class="uk-card uk-margin-remove uk-padding-small uk-card-default uk-card-body uk-width-1-1@s uk-width-3-4@m uk-width-1-2@l" style="z-index: 100; bottom: 0px; position: fixed;" >
|
501
|
<a href="#" uk-scroll="" uk-totop="" class=" uk-align-right uk-totop uk-icon uk-margin-right">
|
502
|
</a>
|
503
|
</div>
|
504
|
|
505
|
</div>
|
506
|
</div>
|
507
|
</div>
|
508
|
</div>
|
509
|
<!-- FOOTER STARTS HERE-->
|
510
|
<div class="custom-footer" style="z-index: 200;">
|
511
|
<div class="uk-section-primary uk-section uk-section-small">
|
512
|
<div class="uk-container">
|
513
|
<div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
|
514
|
<div class="uk-width-1-1@m uk-first-column">
|
515
|
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
|
516
|
<img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
|
517
|
</div>
|
518
|
<div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
|
519
|
<div><a href="http://creativecommons.org/licenses/by/4.0/" rel="license"><img alt="Creative" src="./assets/80x15.png" style="height: auto; max-width: 100%; vertical-align: middle;"></a> UNLESS OTHERWISE INDICATED, ALL MATERIALS CREATED BY THE OPENAIRE CONSORTIUM ARE LICENSED UNDER A <a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.</div>
|
520
|
<div>OPENAIRE IS POWERED BY <a href="http://www.d-net.research-infrastructures.eu/">D-NET</a>.</div>
|
521
|
</div>
|
522
|
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
|
523
|
<a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop="">
|
524
|
</a>
|
525
|
</div>
|
526
|
</div>
|
527
|
</div>
|
528
|
</div>
|
529
|
</div>
|
530
|
</div>
|
531
|
<!--/div-->
|
532
|
</div>
|
533
|
</body>
|
534
|
</html>
|