| 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-datasets" xreflabel="Search HTTP API for metadata about datasets">
|
| 4 |
26607
|
alessia.ba
|
<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 |
32467
|
alessia.ba
|
<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>dateofcollection</code>, <code>resultstoragedate</code>, <code>resultstoragedate</code>, <code>resultembargoenddate</code>, <code>resultembargoendyear</code>, <code>resultdateofacceptance</code>, <code>resultacceptanceyear</code></para>
|
| 15 |
|
|
</listitem>
|
| 16 |
|
|
</varlistentry>
|
| 17 |
|
|
<varlistentry>
|
| 18 |
26607
|
alessia.ba
|
<term>doi</term>
|
| 19 |
|
|
<listitem>
|
| 20 |
32751
|
alessia.ba
|
<para>Gets the datasets with the given DOIs, if any. Allowed values: comma separated list of DOIs. Alternatevely, it is possible to repeat the paramater for each requested doi.</para>
|
| 21 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 22 |
|
|
</listitem>
|
| 23 |
|
|
</varlistentry>
|
| 24 |
|
|
<varlistentry>
|
| 25 |
|
|
<term>openaireDatasetID</term>
|
| 26 |
|
|
<listitem>
|
| 27 |
32751
|
alessia.ba
|
<para>Gets the publication with the given openaire identifier, if any. Allowed values: comma separated list of openaire identifiers. Alternatevely, it is possible to repeat the paramater for each requested identifier.</para>
|
| 28 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 29 |
|
|
</listitem>
|
| 30 |
|
|
</varlistentry>
|
| 31 |
|
|
<varlistentry>
|
| 32 |
|
|
<term>fromDateCollected</term>
|
| 33 |
|
|
<listitem>
|
| 34 |
32751
|
alessia.ba
|
<para>Gets the datasets whose date of acceptance is greater than or equal the given
|
| 35 |
|
|
date. Allowed values: date formatted as <code>YYYY-MM-DD</code>.</para>
|
| 36 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 37 |
|
|
</listitem>
|
| 38 |
|
|
</varlistentry>
|
| 39 |
|
|
<varlistentry>
|
| 40 |
|
|
<term>toDateCollected</term>
|
| 41 |
|
|
<listitem>
|
| 42 |
32751
|
alessia.ba
|
<para>Gets the datasets whose date of acceptance is less than or equal the given date. Allowed values: date formatted as <code>YYYY-MM-DD</code>.</para>
|
| 43 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 44 |
|
|
</listitem>
|
| 45 |
|
|
</varlistentry>
|
| 46 |
|
|
<varlistentry>
|
| 47 |
|
|
<term>title</term>
|
| 48 |
|
|
<listitem>
|
| 49 |
32751
|
alessia.ba
|
<para>Gets the datasets whose titles contain the given list of keywords. Allowed values: white-space separated list of keywords.</para>
|
| 50 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 51 |
|
|
</listitem>
|
| 52 |
|
|
</varlistentry>
|
| 53 |
|
|
<varlistentry>
|
| 54 |
|
|
<term>author</term>
|
| 55 |
|
|
<listitem>
|
| 56 |
32751
|
alessia.ba
|
<para>Search for datasets by authors. Allowed value is a white-space separated list of names and/or surnames.</para>
|
| 57 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 58 |
|
|
</listitem>
|
| 59 |
|
|
</varlistentry>
|
| 60 |
|
|
<varlistentry>
|
| 61 |
|
|
<term>openaireAuthorID</term>
|
| 62 |
|
|
<listitem>
|
| 63 |
32751
|
alessia.ba
|
<para>Search for datasets by openaire author identifier. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each author id. In both cases, author identifiers will form a query with OR semantics.</para>
|
| 64 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 65 |
|
|
</listitem>
|
| 66 |
|
|
</varlistentry>
|
| 67 |
|
|
<varlistentry>
|
| 68 |
|
|
<term>openaireProviderID</term>
|
| 69 |
|
|
<listitem>
|
| 70 |
32751
|
alessia.ba
|
<para>Search for datasets by openaire data provider identifier. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.</para>
|
| 71 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 72 |
|
|
</listitem>
|
| 73 |
|
|
</varlistentry>
|
| 74 |
|
|
<varlistentry>
|
| 75 |
|
|
<term>openaireProjectID</term>
|
| 76 |
|
|
<listitem>
|
| 77 |
32751
|
alessia.ba
|
<para>Search for publications by openaire project identifier. Allowed values: comma separated list of identifiers. Alternatevely, it is possible to repeat the paramater for each provider id. In both cases, provider identifiers will form a query with OR semantics.</para>
|
| 78 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 79 |
|
|
</listitem>
|
| 80 |
|
|
</varlistentry>
|
| 81 |
|
|
<varlistentry>
|
| 82 |
|
|
<term>hasProject</term>
|
| 83 |
|
|
<listitem>
|
| 84 |
|
|
<para>Allowed values: <code>true|false</code>. If hasProject is true gets the datasets
|
| 85 |
|
|
that have a link to a project. If hasProject is false gets the datasets with no links
|
| 86 |
|
|
to projects.</para>
|
| 87 |
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 88 |
|
|
</listitem>
|
| 89 |
|
|
</varlistentry>
|
| 90 |
|
|
<varlistentry>
|
| 91 |
|
|
<term>FP7ProjectID</term>
|
| 92 |
|
|
<listitem>
|
| 93 |
32751
|
alessia.ba
|
<para>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></para>
|
| 94 |
26607
|
alessia.ba
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 95 |
|
|
</listitem>
|
| 96 |
|
|
</varlistentry>
|
| 97 |
|
|
<varlistentry>
|
| 98 |
|
|
<term>OA</term>
|
| 99 |
|
|
<listitem>
|
| 100 |
|
|
<para>Allowed values: <code>true|false</code>. If OA is true gets Open Access datasets.
|
| 101 |
|
|
If OA is false gets the non Open Access datasets</para>
|
| 102 |
|
|
<!--<para><code>here goes the sample query</code></para> -->
|
| 103 |
|
|
</listitem>
|
| 104 |
|
|
</varlistentry>
|
| 105 |
|
|
</variablelist>
|
| 106 |
|
|
|
| 107 |
|
|
</section>
|