PRIVATE: added software and other research products documentation
git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@53474 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
parent
dcab0c6bb8
commit
4b13b7dc9e
199
api.html
199
api.html
|
|
@ -68,9 +68,11 @@
|
|||
<li class="uk-nav-header uk-parent uk-active">
|
||||
<a href="./api.html">Selective access</a>
|
||||
<!-- <ul class="uk-nav-sub">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul> -->
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -137,6 +139,8 @@
|
|||
<ul class="uk-nav uk-navbar-dropdown-nav">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -168,7 +172,9 @@
|
|||
<ul class="uk-nav-sub">
|
||||
<li><a href="#common" uk-scroll>Common Parameters</a></li>
|
||||
<li><a href="#pubs" uk-scroll>Publications</a></li>
|
||||
<li><a href="#datasets" uk-scroll>Datasets</a></li>
|
||||
<li><a href="#datasets" uk-scroll>Research Data</a></li>
|
||||
<li><a href="#software" uk-scroll>Software</a></li>
|
||||
<li><a href="#other" uk-scroll>Other Research Products</a></li>
|
||||
<li><a href="#projects" uk-scroll>Projects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -229,9 +235,11 @@
|
|||
<h2 id="common">Common Parameters</h2>
|
||||
|
||||
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
|
||||
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
||||
<strong>research data</strong>, <strong>software</strong>, <strong>other research products</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
||||
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
|
||||
To query for datasets metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
|
||||
To query for research data metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
|
||||
To query for software metadata: <strong>http://api.openaire.eu/search/software</strong> <br>
|
||||
To query for other research products metadata: <strong>http://api.openaire.eu/search/other</strong> <br>
|
||||
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
|
||||
</p>
|
||||
|
||||
|
|
@ -388,7 +396,7 @@
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2 id="datasets">Dataset specific parameters</h2>
|
||||
<h2 id="datasets">Research Data specific parameters</h2>
|
||||
<p>Endpoint: <strong>http://api.openaire.eu/search/datasets</strong></p>
|
||||
|
||||
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
||||
|
|
@ -450,6 +458,11 @@
|
|||
<td>Search for datasets by openaire project identifier. <br>
|
||||
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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>projectID</td>
|
||||
<td>...</td>
|
||||
<td>The given grant identifier of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hasProject</td>
|
||||
<td>true | false</td>
|
||||
|
|
@ -468,6 +481,176 @@
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2 id="software">Software specific parameters</h2>
|
||||
<p>Endpoint: <strong>http://api.openaire.eu/search/software</strong></p>
|
||||
|
||||
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Option</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>sortBy</td>
|
||||
<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>
|
||||
<td>The sorting order of the specified field.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>doi</td>
|
||||
<td>Comma separated list of DOIs. <br>
|
||||
Alternatively, it is possible to repeat the parameter for each requested doi.
|
||||
</td>
|
||||
<td>Gets the datasets with the given DOIs, if any.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireSoftwareID</td>
|
||||
<td>Comma separated list of OpenAIRE identifiers. <br>
|
||||
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
|
||||
<td>Gets the dataset with the given openaire identifier, if any.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fromDateAccepted</td>
|
||||
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
||||
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>toDateAccepted</td>
|
||||
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
||||
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>title</td>
|
||||
<td>White-space separated list of keywords.</td>
|
||||
<td>Gets the datasets whose titles contain the given list of keywords.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>author</td>
|
||||
<td>A white-space separated list of names and/or surnames</td>
|
||||
<td>Search for datasets by authors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireProviderID</td>
|
||||
<td>Comma separated list of identifiers.</td>
|
||||
<td>Search for datasets by openaire data provider identifier. <br>
|
||||
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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireProjectID</td>
|
||||
<td>Comma separated list of identifiers. </td>
|
||||
<td>Search for datasets by openaire project identifier. <br>
|
||||
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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>projectID</td>
|
||||
<td>...</td>
|
||||
<td>The given grant identifier of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hasProject</td>
|
||||
<td>true | false</td>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>FP7ProjectID</td>
|
||||
<td>...</td>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OA</td>
|
||||
<td>true | false</td>
|
||||
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2 id="other">Other Research Products specific parameters</h2>
|
||||
<p>Endpoint: <strong>http://api.openaire.eu/search/other</strong></p>
|
||||
|
||||
<table class="uk-table uk-table-striped uk-table-hover uk-table-small uk-table-justify">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Option</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>sortBy</td>
|
||||
<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>
|
||||
<td>The sorting order of the specified field.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>doi</td>
|
||||
<td>Comma separated list of DOIs. <br>
|
||||
Alternatively, it is possible to repeat the parameter for each requested doi.
|
||||
</td>
|
||||
<td>Gets the datasets with the given DOIs, if any.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireOtherID</td>
|
||||
<td>Comma separated list of OpenAIRE identifiers. <br>
|
||||
Alternatively, it is possible to repeat the parameter for each requested identifier.</td>
|
||||
<td>Gets the dataset with the given openaire identifier, if any.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fromDateAccepted</td>
|
||||
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
||||
<td>Gets the datasets whose date of acceptance is greater than or equal the given date.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>toDateAccepted</td>
|
||||
<td>Date formatted as <code>YYYY-MM-DD</code></td>
|
||||
<td>Gets the datasets whose date of acceptance is less than or equal the given date.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>title</td>
|
||||
<td>White-space separated list of keywords.</td>
|
||||
<td>Gets the datasets whose titles contain the given list of keywords.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>author</td>
|
||||
<td>A white-space separated list of names and/or surnames</td>
|
||||
<td>Search for datasets by authors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireProviderID</td>
|
||||
<td>Comma separated list of identifiers.</td>
|
||||
<td>Search for datasets by openaire data provider identifier. <br>
|
||||
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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>openaireProjectID</td>
|
||||
<td>Comma separated list of identifiers. </td>
|
||||
<td>Search for datasets by openaire project identifier. <br>
|
||||
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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>projectID</td>
|
||||
<td>...</td>
|
||||
<td>The given grant identifier of the project.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hasProject</td>
|
||||
<td>true | false</td>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>FP7ProjectID</td>
|
||||
<td>...</td>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OA</td>
|
||||
<td>true | false</td>
|
||||
<td>If OA is true gets Open Access datasets. If OA is false gets the non Open Access datasets</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h2 id="projects">Project specific parameters</h2>
|
||||
<p>Endpoint: <strong>http://api.openaire.eu/search/projects</strong></p>
|
||||
|
||||
|
|
@ -487,7 +670,7 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>grantID</td>
|
||||
<td>Comma separated list of DOIs.</td>
|
||||
<td>Comma separated list of grant identifiers.</td>
|
||||
<td>Gets the project with the given grant identifier, if any.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -68,6 +68,8 @@
|
|||
<ul class="uk-nav-sub">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -135,6 +137,8 @@
|
|||
<ul class="uk-nav uk-navbar-dropdown-nav">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -33,9 +33,11 @@
|
|||
</li>
|
||||
<li class="uk-nav-header uk-parent uk-active">
|
||||
<a href="./api.html">Selective access</a><ul class="uk-nav-sub">
|
||||
<li><a href="./api.html#pubs">Publications</a></li>
|
||||
<li><a href="./api.html#datasets">Research Data</a></li>
|
||||
<li><a href="./api.html#projects">Projects</a></li>
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Softare</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div></div></div>
|
||||
|
|
@ -60,9 +62,11 @@
|
|||
</li>
|
||||
<li class="uk-parent">
|
||||
<a href="#" class="" aria-expanded="false">Selective access</a><div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 228px; top: 80px;"><div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid=""><div class="uk-first-column"><ul class="uk-nav uk-navbar-dropdown-nav">
|
||||
<li><a href="./api.html#pubs">Publications</a></li>
|
||||
<li><a href="./api.html#datasets">Research Data</a></li>
|
||||
<li><a href="./api.html#projects">Projects</a></li>
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul></div></div></div>
|
||||
</li>
|
||||
</ul></div></nav></div></div></div></div>
|
||||
|
|
|
|||
|
|
@ -68,6 +68,8 @@
|
|||
<ul class="uk-nav-sub">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -135,6 +137,8 @@
|
|||
<ul class="uk-nav uk-navbar-dropdown-nav">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -71,6 +71,8 @@
|
|||
<ul class="uk-nav-sub">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -138,6 +140,8 @@
|
|||
<ul class="uk-nav uk-navbar-dropdown-nav">
|
||||
<li><a href="./api.html#pubs" >Publications</a></li>
|
||||
<li><a href="./api.html#datasets" >Research Data</a></li>
|
||||
<li><a href="./api.html#software" >Software</a></li>
|
||||
<li><a href="./api.html#other" >Other Research Products</a></li>
|
||||
<li><a href="./api.html#projects" >Projects</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -199,7 +203,9 @@
|
|||
<h3 class="uk-card-title uk-text-center">Selective access via HTTP API</h3>
|
||||
<a href="api.html#pubs">Publications</a> <br>
|
||||
<a href="api.html#datasets">Datasets</a> <br>
|
||||
<a href="api.html#projects">Projects</a> <br>
|
||||
<a href="./api.html#software" >Software</a> <br>
|
||||
<a href="./api.html#other" >Other Research Products</a> <br>
|
||||
<a href="./api.html#projects" >Projects</a> <br>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue