1 |
49344
|
katerina.i
|
|
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 |
50282
|
katerina.i
|
|
153 |
|
|
<div class="uk-alert-danger" uk-alert>
|
154 |
|
|
<p>Openaire XML Schema will change soon! Please <a href="https://www.openaire.eu/openaire-xml-schema-change-announcement" target="_blank">click here</a> to learn more!</p>
|
155 |
|
|
</div>
|
156 |
|
|
|
157 |
49344
|
katerina.i
|
<p>
|
158 |
|
|
The OpenAIRE HTTP API allows developers to access the metadata information space of OpenAIRE+ by performing queries over publications, datasets, and projects.
|
159 |
|
|
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
|
160 |
|
|
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
|
161 |
|
|
encouraged to use the <a href="http://api.openaire.eu/#cha_oai_pmh" target="_blank">OAI-PMH</a>.<br>
|
162 |
|
|
</p>
|
163 |
|
|
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
|
164 |
|
|
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
165 |
|
|
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
|
166 |
|
|
To query for datasets metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
|
167 |
|
|
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
|
168 |
|
|
</p>
|
169 |
|
|
|
170 |
|
|
<h2 id="common">Common Parameters</h2>
|
171 |
|
|
|
172 |
|
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small">
|
173 |
|
|
<thead>
|
174 |
|
|
<tr>
|
175 |
|
|
<th>Parameter</th>
|
176 |
|
|
<th>Option</th>
|
177 |
|
|
<th>Description</th>
|
178 |
|
|
</tr>
|
179 |
|
|
</thead>
|
180 |
|
|
<tbody>
|
181 |
|
|
<tr>
|
182 |
|
|
<td>page</td>
|
183 |
|
|
<td>integer</td>
|
184 |
|
|
<td>Page number of the search results.</td>
|
185 |
|
|
</tr>
|
186 |
|
|
<tr>
|
187 |
|
|
<td>size</td>
|
188 |
|
|
<td>integer</td>
|
189 |
|
|
<td>Number of results per page.</td>
|
190 |
|
|
</tr>
|
191 |
|
|
<tr>
|
192 |
|
|
<td>format</td>
|
193 |
|
|
<td>json | xml | csv | tsv</td>
|
194 |
|
|
<td>The format of the response. The default is xml.</td>
|
195 |
|
|
</tr>
|
196 |
|
|
<tr>
|
197 |
|
|
<td>model</td>
|
198 |
|
|
<td>openaire | sygma</td>
|
199 |
|
|
<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>
|
200 |
|
|
</tr>
|
201 |
|
|
<tr>
|
202 |
|
|
<td>sortBy</td>
|
203 |
|
|
<td><code>sortBy=field,[ascending|descending]</code></td>
|
204 |
|
|
<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>
|
205 |
|
|
</tr>
|
206 |
|
|
<tr>
|
207 |
|
|
<td>hasECFunding</td>
|
208 |
|
|
<td>true | false</td>
|
209 |
|
|
<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>
|
210 |
|
|
</tr>
|
211 |
|
|
<tr>
|
212 |
|
|
<td>hasWTFunding</td>
|
213 |
|
|
<td>true | false</td>
|
214 |
|
|
<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>
|
215 |
|
|
</tr>
|
216 |
|
|
<tr>
|
217 |
|
|
<td>funder</td>
|
218 |
|
|
<td>WT | EC | ARC | ANDS | NSF | FCT | NHMRC</td>
|
219 |
|
|
<td>Search for entities by funder.</td>
|
220 |
|
|
</tr>
|
221 |
|
|
<tr>
|
222 |
|
|
<td>fundingStream</td>
|
223 |
|
|
<td>...</td>
|
224 |
|
|
<td>Search for entities by funding stream.</td>
|
225 |
|
|
</tr>
|
226 |
|
|
<tr>
|
227 |
|
|
<td>FP7scientificArea</td>
|
228 |
|
|
<td>...</td>
|
229 |
|
|
<td>Search for FP7 entities by scientific area.</td>
|
230 |
|
|
</tr>
|
231 |
|
|
<tr>
|
232 |
|
|
<td>keywords</td>
|
233 |
|
|
<td>White-space separated list of keywords.</td>
|
234 |
|
|
<td>N/A</td>
|
235 |
|
|
</tr>
|
236 |
|
|
</tbody>
|
237 |
|
|
</table>
|
238 |
|
|
|
239 |
|
|
<h2 id="pubs">Publication specific parameters</h2>
|
240 |
|
|
<p>Endpoint: <strong>http://api.openaire.eu/search/publications</strong></p>
|
241 |
|
|
|
242 |
|
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
243 |
|
|
<thead>
|
244 |
|
|
<tr>
|
245 |
|
|
<th>Parameter</th>
|
246 |
|
|
<th>Option</th>
|
247 |
|
|
<th>Description</th>
|
248 |
|
|
</tr>
|
249 |
|
|
</thead>
|
250 |
|
|
<tbody>
|
251 |
|
|
<tr>
|
252 |
|
|
<td>sortBy</td>
|
253 |
|
|
<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>
|
254 |
|
|
<td>The sorting order of the specified field.</td>
|
255 |
|
|
</tr>
|
256 |
|
|
<tr>
|
257 |
|
|
<td>doi</td>
|
258 |
|
|
<td>Comma separated list of DOIs. <br>
|
259 |
|
|
Alternatevely, it is possible to repeat the paramater for each requested doi.
|
260 |
|
|
</td>
|
261 |
|
|
<td>Gets the publications with the given DOIs, if any.</td>
|
262 |
|
|
</tr>
|
263 |
|
|
<tr>
|
264 |
|
|
<td>openairePublicationID</td>
|
265 |
|
|
<td>Comma separated list of OpenAIRE identifiers. <br>
|
266 |
|
|
Alternatevely, it is possible to repeat the paramater for each requested identifier.
|
267 |
|
|
</td>
|
268 |
|
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
269 |
|
|
</tr>
|
270 |
|
|
<tr>
|
271 |
|
|
<td>fromDateAccepted</td>
|
272 |
|
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
273 |
|
|
<td>Gets the publications whose date of acceptance is greater than or equal the given date.</td>
|
274 |
|
|
</tr>
|
275 |
|
|
<tr>
|
276 |
|
|
<td>toDateAccepted</td>
|
277 |
|
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
278 |
|
|
<td>Gets the publications whose date of acceptance is less than or equal the given date.</td>
|
279 |
|
|
</tr>
|
280 |
|
|
<tr>
|
281 |
|
|
<td>title</td>
|
282 |
|
|
<td>White-space separated list of keywords.</td>
|
283 |
|
|
<td>Gets the publications whose titles contain the given list of keywords.</td>
|
284 |
|
|
</tr>
|
285 |
|
|
<tr>
|
286 |
|
|
<td>author</td>
|
287 |
|
|
<td>White-space separated list of names and/or surnames.</td>
|
288 |
|
|
<td>Search for publications by authors.</td>
|
289 |
|
|
</tr>
|
290 |
|
|
<tr>
|
291 |
|
|
<td>openaireProviderID</td>
|
292 |
|
|
<td>Comma separated list of identifiers.</td>
|
293 |
|
|
<td>Search for publications by openaire data provider identifier. <br>
|
294 |
|
|
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
295 |
|
|
</tr>
|
296 |
|
|
<tr>
|
297 |
|
|
<td>openaireProjectID</td>
|
298 |
|
|
<td>Comma separated list of identifiers. <br>
|
299 |
|
|
Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
300 |
|
|
<td>Search for publications by openaire project identifier. Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
301 |
|
|
</tr>
|
302 |
|
|
<tr>
|
303 |
|
|
<td>hasProject</td>
|
304 |
|
|
<td>true | false</td>
|
305 |
|
|
<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>
|
306 |
|
|
</tr>
|
307 |
|
|
<tr>
|
308 |
|
|
<td>projectID</td>
|
309 |
|
|
<td>...</td>
|
310 |
|
|
<td>The given grant identifier of the project.</td>
|
311 |
|
|
</tr>
|
312 |
|
|
<tr>
|
313 |
|
|
<td>FP7ProjectID</td>
|
314 |
|
|
<td>...</td>
|
315 |
|
|
<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>
|
316 |
|
|
</tr>
|
317 |
|
|
<tr>
|
318 |
|
|
<td>OA</td>
|
319 |
|
|
<td>true | false</td>
|
320 |
|
|
<td>If OA is true gets Open Access publications. If OA is false gets the non Open Access publications</td>
|
321 |
|
|
</tr>
|
322 |
|
|
</tbody>
|
323 |
|
|
</table>
|
324 |
|
|
|
325 |
|
|
<h2 id="datasets">Dataset specific parameters</h2>
|
326 |
|
|
<p>Endpoint: <strong>http://api.openaire.eu/search/datasets</strong></p>
|
327 |
|
|
|
328 |
|
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
329 |
|
|
<thead>
|
330 |
|
|
<tr>
|
331 |
|
|
<th>Parameter</th>
|
332 |
|
|
<th>Option</th>
|
333 |
|
|
<th>Description</th>
|
334 |
|
|
</tr>
|
335 |
|
|
</thead>
|
336 |
|
|
<tbody>
|
337 |
|
|
<tr>
|
338 |
|
|
<td>sortBy</td>
|
339 |
|
|
<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>
|
340 |
|
|
<td>The sorting order of the specified field.</td>
|
341 |
|
|
</tr>
|
342 |
|
|
<tr>
|
343 |
|
|
<td>doi</td>
|
344 |
|
|
<td>Comma separated list of DOIs. <br>
|
345 |
|
|
Alternatevely, it is possible to repeat the paramater for each requested doi.
|
346 |
|
|
</td>
|
347 |
|
|
<td>Gets the publications with the given DOIs, if any.</td>
|
348 |
|
|
</tr>
|
349 |
|
|
<tr>
|
350 |
|
|
<td>openaireDatasetID</td>
|
351 |
|
|
<td>Comma separated list of OpenAIRE identifiers. <br>
|
352 |
|
|
Alternatevely, it is possible to repeat the paramater for each requested identifier.</td>
|
353 |
|
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
354 |
|
|
</tr>
|
355 |
|
|
<tr>
|
356 |
|
|
<td>openaireDatasetID</td>
|
357 |
|
|
<td>Comma separated list of openaire identifiers</td>
|
358 |
|
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
359 |
|
|
</tr>
|
360 |
|
|
<tr>
|
361 |
|
|
<td>fromDateAccepted</td>
|
362 |
|
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
363 |
|
|
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
|
364 |
|
|
</tr>
|
365 |
|
|
<tr>
|
366 |
|
|
<td>toDateAccepted</td>
|
367 |
|
|
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
368 |
|
|
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
|
369 |
|
|
</tr>
|
370 |
|
|
<tr>
|
371 |
|
|
<td>title</td>
|
372 |
|
|
<td>White-space separated list of keywords.</td>
|
373 |
|
|
<td>Gets the datasets whose titles contain the given list of keywords.</td>
|
374 |
|
|
</tr>
|
375 |
|
|
<tr>
|
376 |
|
|
<td>author</td>
|
377 |
|
|
<td>A white-space separated list of names and/or surnames</td>
|
378 |
|
|
<td>Search for datasets by authors.</td>
|
379 |
|
|
</tr>
|
380 |
|
|
<tr>
|
381 |
|
|
<td>openaireProviderID</td>
|
382 |
|
|
<td>Comma separated list of identifiers.</td>
|
383 |
|
|
<td>Search for datasets by openaire data provider identifier. <br>
|
384 |
|
|
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
385 |
|
|
</tr>
|
386 |
|
|
<tr>
|
387 |
|
|
<td>openaireProjectID</td>
|
388 |
|
|
<td>Comma separated list of identifiers. </td>
|
389 |
|
|
<td>Search for publications by openaire project identifier. <br>
|
390 |
|
|
Alternatevely, it is possible to repeat the parameter for each provider id. In both cases, provider identifiers will form a query with OR semantics.</td>
|
391 |
|
|
</tr>
|
392 |
|
|
<tr>
|
393 |
|
|
<td>hasProject</td>
|
394 |
|
|
<td>true | false</td>
|
395 |
|
|
<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>
|
396 |
|
|
</tr>
|
397 |
|
|
<tr>
|
398 |
|
|
<td>FP7ProjectID</td>
|
399 |
|
|
<td>...</td>
|
400 |
|
|
<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>
|
401 |
|
|
</tr>
|
402 |
|
|
<tr>
|
403 |
|
|
<td>OA</td>
|
404 |
|
|
<td>true | false</td>
|
405 |
|
|
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
|
406 |
|
|
</tr>
|
407 |
|
|
</tbody>
|
408 |
|
|
</table>
|
409 |
|
|
|
410 |
|
|
<h2 id="projects">Project specific parameters</h2>
|
411 |
|
|
<p>Endpoint: <strong>http://api.openaire.eu/search/projects</strong></p>
|
412 |
|
|
|
413 |
|
|
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
414 |
|
|
<thead>
|
415 |
|
|
<tr>
|
416 |
|
|
<th>Parameter</th>
|
417 |
|
|
<th>Option</th>
|
418 |
|
|
<th>Description</th>
|
419 |
|
|
</tr>
|
420 |
|
|
</thead>
|
421 |
|
|
<tbody>
|
422 |
|
|
<tr>
|
423 |
|
|
<td>sortBy</td>
|
424 |
|
|
<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>
|
425 |
|
|
<td>The sorting order of the specified field.</td>
|
426 |
|
|
</tr>
|
427 |
|
|
<tr>
|
428 |
|
|
<td>grantID</td>
|
429 |
|
|
<td>Comma separated list of DOIs.</td>
|
430 |
|
|
<td>Gets the project with the given grant identifier, if any.</td>
|
431 |
|
|
</tr>
|
432 |
|
|
<tr>
|
433 |
|
|
<td>openairePublicationID</td>
|
434 |
|
|
<td>Comma separated list of OpenAIRE identifiers.</td>
|
435 |
|
|
<td>Gets the publication with the given openaire identifier, if any.</td>
|
436 |
|
|
</tr>
|
437 |
|
|
<tr>
|
438 |
|
|
<td>name</td>
|
439 |
|
|
<td>White-space separated list of keywords.</td>
|
440 |
|
|
<td>Gets the projects whose names contain the given list of keywords.</td>
|
441 |
|
|
</tr>
|
442 |
|
|
<tr>
|
443 |
|
|
<td>acronym</td>
|
444 |
|
|
<td>N/A</td>
|
445 |
|
|
<td>Gets the project with the given acronym, if any.</td>
|
446 |
|
|
</tr>
|
447 |
|
|
<tr>
|
448 |
|
|
<td>callID</td>
|
449 |
|
|
<td>N/A</td>
|
450 |
|
|
<td>Search for projects by call identifier.</td>
|
451 |
|
|
</tr>
|
452 |
|
|
<tr>
|
453 |
|
|
<td>startYear</td>
|
454 |
|
|
<td>Year formatted as <code>YYYY</code></td>
|
455 |
|
|
<td>Gets the projects that started in the given year.</td>
|
456 |
|
|
</tr>
|
457 |
|
|
<tr>
|
458 |
|
|
<td>endYear</td>
|
459 |
|
|
<td>Year formatted as <code>YYYY</code>.</td>
|
460 |
|
|
<td>Gets the projects that ended in the given year.</td>
|
461 |
|
|
</tr>
|
462 |
|
|
<tr>
|
463 |
|
|
<td>participantCountries</td>
|
464 |
|
|
<td>Comma separeted list of 2 letter country codes.</td>
|
465 |
|
|
<td>Search for projects by participant countries.</td>
|
466 |
|
|
</tr>
|
467 |
|
|
<tr>
|
468 |
|
|
<td>participantAcronyms</td>
|
469 |
|
|
<td>White space separeted list of acronyms of institutions.</td>
|
470 |
|
|
<td>Search for projects by participant institutions.</td>
|
471 |
|
|
</tr>
|
472 |
|
|
</tbody>
|
473 |
|
|
</table>
|
474 |
|
|
|
475 |
|
|
<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;" >
|
476 |
|
|
<a href="#" uk-scroll="" uk-totop="" class=" uk-align-right uk-totop uk-icon uk-margin-right">
|
477 |
|
|
</a>
|
478 |
|
|
</div>
|
479 |
|
|
|
480 |
|
|
</div>
|
481 |
|
|
</div>
|
482 |
|
|
</div>
|
483 |
|
|
</div>
|
484 |
|
|
<!-- FOOTER STARTS HERE-->
|
485 |
|
|
<div class="custom-footer" style="z-index: 200;">
|
486 |
|
|
<div class="uk-section-primary uk-section uk-section-small">
|
487 |
|
|
<div class="uk-container">
|
488 |
|
|
<div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
|
489 |
|
|
<div class="uk-width-1-1@m uk-first-column">
|
490 |
|
|
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
|
491 |
|
|
<img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
|
492 |
|
|
</div>
|
493 |
|
|
<div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
|
494 |
|
|
<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>
|
495 |
|
|
<div>OPENAIRE IS POWERED BY <a href="http://www.d-net.research-infrastructures.eu/">D-NET</a>.</div>
|
496 |
|
|
</div>
|
497 |
|
|
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
|
498 |
|
|
<a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop="">
|
499 |
|
|
</a>
|
500 |
|
|
</div>
|
501 |
|
|
</div>
|
502 |
|
|
</div>
|
503 |
|
|
</div>
|
504 |
|
|
</div>
|
505 |
|
|
</div>
|
506 |
|
|
<!--/div-->
|
507 |
|
|
</div>
|
508 |
|
|
</body>
|
509 |
|
|
</html>
|