added documentation for the projects2tsv endpoint
git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet40/modules/dnet-api-http-doc/src@35524 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
parent
b5da10418e
commit
2946848a0f
|
|
@ -1,28 +1,12 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cha_projects_http"
|
||||
xreflabel="Projects export for DSpace and EPrints">
|
||||
<title>Bulk access to projects for DSpace and EPrints</title>
|
||||
xreflabel="Bulk access to projects">
|
||||
<title>Bulk access to projects</title>
|
||||
<para>The APIs offer custom access to metadata about projects funded by a selection of
|
||||
international funders for the DSpace and EPrints platforms:<simplelist>
|
||||
<member>DSpace endpoint: <link
|
||||
xlink:href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL"
|
||||
/></member>
|
||||
<member>ePrints endpoint: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL"
|
||||
/></member>
|
||||
</simplelist></para>
|
||||
<para> The URLs embed the parameters needed to collect projects funded by specific funding stream, where
|
||||
the pattern is <code>FundingStream/FundingSubStream/FundingSubSubStream</code>.</para>
|
||||
<para>Additional parameters can be concatenated to the URL to refine the results by date (date
|
||||
must be in the form <code>YYYY-MM-DD</code>): <simplelist>
|
||||
<member>startFrom</member>
|
||||
<member>startUntil</member>
|
||||
<member>endFrom</member>
|
||||
<member>endUntil</member>
|
||||
</simplelist></para>
|
||||
|
||||
<para>The currently supported funding streams and relative codes are: <itemizedlist>
|
||||
international funders for the DSpace and EPrints platforms and as TSV file.</para>
|
||||
<para xml:id="fundings" xreflabel="Funding codes">The currently supported funding streams and
|
||||
relative codes are: <itemizedlist>
|
||||
<listitem>
|
||||
<para>FP7: The 7th Framework Programme funded by the European Commission</para>
|
||||
</listitem>
|
||||
|
|
@ -39,17 +23,51 @@
|
|||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>Examples: <simplelist>
|
||||
<member>Get Wellcome Trust projects for EPrints: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL"/></member>
|
||||
<member>Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL"/></member>
|
||||
<member>Get EC-FP7 projects for DSpace that started after the given date: <link
|
||||
xlink:href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01"
|
||||
<section>
|
||||
<title>DSpace/ePrints</title>
|
||||
<simplelist>
|
||||
<member>DSpace endpoint: <link
|
||||
xlink:href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL"
|
||||
/></member>
|
||||
<member>ePrints endpoint: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL"
|
||||
/></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
|
||||
<para> The URLs embed the parameters needed to collect projects funded by specific funding
|
||||
stream, where the pattern is
|
||||
<code>FundingStream/FundingSubStream/FundingSubSubStream</code>.</para>
|
||||
<para>Additional parameters can be concatenated to the URL to refine the results by date
|
||||
(date must be in the form <code>YYYY-MM-DD</code>): <simplelist>
|
||||
<member>startFrom</member>
|
||||
<member>startUntil</member>
|
||||
<member>endFrom</member>
|
||||
<member>endUntil</member>
|
||||
</simplelist></para>
|
||||
<para>Examples: <simplelist>
|
||||
<member>Get Wellcome Trust projects for EPrints: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL"/></member>
|
||||
<member>Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: <link
|
||||
xlink:href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL"/></member>
|
||||
<member>Get EC-FP7 projects for DSpace that started after the given date: <link
|
||||
xlink:href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01"
|
||||
/></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</section>
|
||||
<section>
|
||||
<title>Projects in TSV file</title>
|
||||
<para>Endpoint: <link xlink:href="http://api.openaire.eu/projects/project2tsv.do"/></para>
|
||||
<para>Mandatory parameter: <simplelist>
|
||||
<member>funding: the code of the funding program (See <xref linkend="fundings"
|
||||
/>)</member>
|
||||
</simplelist>
|
||||
</para>
|
||||
<para>Examples: <simplelist>
|
||||
<member>Get FP7 projects in a tsv file: <link
|
||||
xlink:href="http://api.openaire.eu/projects/project2tsv.do?funding=FP7"
|
||||
/></member>
|
||||
</simplelist> The returned tsv file has an header where the semantics of each column is
|
||||
described. </para>
|
||||
</section>
|
||||
|
||||
</chapter>
|
||||
|
|
|
|||
Loading…
Reference in New Issue