Project

General

Profile

« Previous | Next » 

Revision 47349

warning and location of the api in the prod infra

View differences:

modules/dnet-api-http-doc/openaire-api-doc.xpr
1 1
<?xml version="1.0" encoding="UTF-8"?>
2
<project version="17.1">
2
<project version="19.0">
3 3
    <meta>
4 4
        <filters directoryPatterns="" filePatterns="" positiveFilePatterns="" showHiddenFiles="false"/>
5 5
        <options>
6
            <serialized version="17.1" xml:space="preserve">
6
            <serialized version="19.0" xml:space="preserve">
7 7
                <serializableOrderedMap>
8 8
                    <entry>
9 9
                        <String>scenario.associations</String>
10 10
                        <scenarioAssociation-array>
11 11
                            <scenarioAssociation>
12 12
                                <field name="url">
13
                                    <String>src/docbkx/Untitled1.xml</String>
14
                                </field>
15
                                <field name="scenarioIds">
16
                                    <list>
17
                                        <String>Untitled1</String>
18
                                    </list>
19
                                </field>
20
                                <field name="scenarioTypes">
21
                                    <list>
22
                                        <String>XSL</String>
23
                                    </list>
24
                                </field>
25
                            </scenarioAssociation>
26
                            <scenarioAssociation>
27
                                <field name="url">
28
                                    <String>../../../Untitled2.xml</String>
29
                                </field>
30
                                <field name="scenarioIds">
31
                                    <list>
32
                                        <String>opentrials2</String>
33
                                    </list>
34
                                </field>
35
                                <field name="scenarioTypes">
36
                                    <list>
37
                                        <String>XSL</String>
38
                                    </list>
39
                                </field>
40
                            </scenarioAssociation>
41
                            <scenarioAssociation>
42
                                <field name="url">
43
                                    <String>../../../workspace8/dnet-parthenos/src/main/resources/eu/dnetlib/parthenos/index/Untitled3.xml</String>
44
                                </field>
45
                                <field name="scenarioIds">
46
                                    <list>
47
                                        <String>Untitled3</String>
48
                                    </list>
49
                                </field>
50
                                <field name="scenarioTypes">
51
                                    <list>
52
                                        <String>XSL</String>
53
                                    </list>
54
                                </field>
55
                            </scenarioAssociation>
56
                            <scenarioAssociation>
57
                                <field name="url">
58
                                    <String>../../../workspace8/dnet-parthenos/src/main/resources/eu/dnetlib/parthenos/index/Untitled1.xml</String>
59
                                </field>
60
                                <field name="scenarioIds">
61
                                    <list>
62
                                        <String>lrs</String>
63
                                    </list>
64
                                </field>
65
                                <field name="scenarioTypes">
66
                                    <list>
67
                                        <String>XSL</String>
68
                                    </list>
69
                                </field>
70
                            </scenarioAssociation>
71
                            <scenarioAssociation>
72
                                <field name="url">
73
                                    <String>../../../index.xsl</String>
74
                                </field>
75
                                <field name="scenarioIds">
76
                                    <list>
77
                                        <String>index</String>
78
                                    </list>
79
                                </field>
80
                                <field name="scenarioTypes">
81
                                    <list>
82
                                        <String>XML</String>
83
                                    </list>
84
                                </field>
85
                            </scenarioAssociation>
86
                            <scenarioAssociation>
87
                                <field name="url">
13 88
                                    <String>../../../Desktop/oaf2dc.xsl</String>
14 89
                                </field>
15 90
                                <field name="scenarioIds">
......
547 622
                                    <null/>
548 623
                                </field>
549 624
                                <field name="name">
625
                                    <String>index</String>
626
                                </field>
627
                                <field name="baseURL">
628
                                    <String></String>
629
                                </field>
630
                                <field name="footerURL">
631
                                    <String></String>
632
                                </field>
633
                                <field name="fOPMethod">
634
                                    <String>pdf</String>
635
                                </field>
636
                                <field name="fOProcessorName">
637
                                    <String>Apache FOP</String>
638
                                </field>
639
                                <field name="headerURL">
640
                                    <String></String>
641
                                </field>
642
                                <field name="inputXSLURL">
643
                                    <String>${currentFileURL}</String>
644
                                </field>
645
                                <field name="inputXMLURL">
646
                                    <String>file:/Users/alessia/sample.xml</String>
647
                                </field>
648
                                <field name="defaultScenario">
649
                                    <Boolean>false</Boolean>
650
                                </field>
651
                                <field name="isFOPPerforming">
652
                                    <Boolean>false</Boolean>
653
                                </field>
654
                                <field name="type">
655
                                    <String>XML</String>
656
                                </field>
657
                                <field name="saveAs">
658
                                    <Boolean>true</Boolean>
659
                                </field>
660
                                <field name="openInBrowser">
661
                                    <Boolean>false</Boolean>
662
                                </field>
663
                                <field name="outputFile">
664
                                    <null/>
665
                                </field>
666
                                <field name="outputResource">
667
                                    <null/>
668
                                </field>
669
                                <field name="openOtherLocationInBrowser">
670
                                    <Boolean>false</Boolean>
671
                                </field>
672
                                <field name="locationToOpenInBrowserURL">
673
                                    <null/>
674
                                </field>
675
                                <field name="openInEditor">
676
                                    <Boolean>false</Boolean>
677
                                </field>
678
                                <field name="showInHTMLPane">
679
                                    <Boolean>false</Boolean>
680
                                </field>
681
                                <field name="showInXMLPane">
682
                                    <Boolean>true</Boolean>
683
                                </field>
684
                                <field name="showInSVGPane">
685
                                    <Boolean>false</Boolean>
686
                                </field>
687
                                <field name="showInResultSetPane">
688
                                    <Boolean>false</Boolean>
689
                                </field>
690
                                <field name="useXSLTInput">
691
                                    <Boolean>true</Boolean>
692
                                </field>
693
                                <field name="xsltParams">
694
                                    <list/>
695
                                </field>
696
                                <field name="cascadingStylesheets">
697
                                    <String-array/>
698
                                </field>
699
                                <field name="xslTransformer">
700
                                    <String>Saxon6.5.5</String>
701
                                </field>
702
                                <field name="extensionURLs">
703
                                    <String-array/>
704
                                </field>
705
                            </scenario>
706
                            <scenario>
707
                                <field name="advancedOptionsMap">
708
                                    <null/>
709
                                </field>
710
                                <field name="name">
550 711
                                    <String>oaf2dc</String>
551 712
                                </field>
552 713
                                <field name="baseURL">
......
984 1145
                                    <null/>
985 1146
                                </field>
986 1147
                                <field name="name">
1148
                                    <String>Untitled1</String>
1149
                                </field>
1150
                                <field name="baseURL">
1151
                                    <String></String>
1152
                                </field>
1153
                                <field name="footerURL">
1154
                                    <String></String>
1155
                                </field>
1156
                                <field name="fOPMethod">
1157
                                    <String>pdf</String>
1158
                                </field>
1159
                                <field name="fOProcessorName">
1160
                                    <String>Apache FOP</String>
1161
                                </field>
1162
                                <field name="headerURL">
1163
                                    <String></String>
1164
                                </field>
1165
                                <field name="inputXSLURL">
1166
                                    <String>file:/Users/alessia/Desktop/index.xsl</String>
1167
                                </field>
1168
                                <field name="inputXMLURL">
1169
                                    <String>${currentFileURL}</String>
1170
                                </field>
1171
                                <field name="defaultScenario">
1172
                                    <Boolean>false</Boolean>
1173
                                </field>
1174
                                <field name="isFOPPerforming">
1175
                                    <Boolean>false</Boolean>
1176
                                </field>
1177
                                <field name="type">
1178
                                    <String>XSL</String>
1179
                                </field>
1180
                                <field name="saveAs">
1181
                                    <Boolean>true</Boolean>
1182
                                </field>
1183
                                <field name="openInBrowser">
1184
                                    <Boolean>false</Boolean>
1185
                                </field>
1186
                                <field name="outputFile">
1187
                                    <null/>
1188
                                </field>
1189
                                <field name="outputResource">
1190
                                    <null/>
1191
                                </field>
1192
                                <field name="openOtherLocationInBrowser">
1193
                                    <Boolean>false</Boolean>
1194
                                </field>
1195
                                <field name="locationToOpenInBrowserURL">
1196
                                    <null/>
1197
                                </field>
1198
                                <field name="openInEditor">
1199
                                    <Boolean>true</Boolean>
1200
                                </field>
1201
                                <field name="showInHTMLPane">
1202
                                    <Boolean>false</Boolean>
1203
                                </field>
1204
                                <field name="showInXMLPane">
1205
                                    <Boolean>true</Boolean>
1206
                                </field>
1207
                                <field name="showInSVGPane">
1208
                                    <Boolean>false</Boolean>
1209
                                </field>
1210
                                <field name="showInResultSetPane">
1211
                                    <Boolean>false</Boolean>
1212
                                </field>
1213
                                <field name="useXSLTInput">
1214
                                    <Boolean>true</Boolean>
1215
                                </field>
1216
                                <field name="xsltParams">
1217
                                    <list/>
1218
                                </field>
1219
                                <field name="cascadingStylesheets">
1220
                                    <String-array/>
1221
                                </field>
1222
                                <field name="xslTransformer">
1223
                                    <String>Saxon6.5.5</String>
1224
                                </field>
1225
                                <field name="extensionURLs">
1226
                                    <String-array/>
1227
                                </field>
1228
                            </scenario>
1229
                            <scenario>
1230
                                <field name="advancedOptionsMap">
1231
                                    <null/>
1232
                                </field>
1233
                                <field name="name">
987 1234
                                    <String>Untitled2</String>
988 1235
                                </field>
989 1236
                                <field name="baseURL">
......
1242 1489
                                    <null/>
1243 1490
                                </field>
1244 1491
                                <field name="name">
1492
                                    <String>Untitled3</String>
1493
                                </field>
1494
                                <field name="baseURL">
1495
                                    <String></String>
1496
                                </field>
1497
                                <field name="footerURL">
1498
                                    <String></String>
1499
                                </field>
1500
                                <field name="fOPMethod">
1501
                                    <String>pdf</String>
1502
                                </field>
1503
                                <field name="fOProcessorName">
1504
                                    <String>Apache FOP</String>
1505
                                </field>
1506
                                <field name="headerURL">
1507
                                    <String></String>
1508
                                </field>
1509
                                <field name="inputXSLURL">
1510
                                    <String>file:/Users/alessia/x.xslt</String>
1511
                                </field>
1512
                                <field name="inputXMLURL">
1513
                                    <String>${currentFileURL}</String>
1514
                                </field>
1515
                                <field name="defaultScenario">
1516
                                    <Boolean>false</Boolean>
1517
                                </field>
1518
                                <field name="isFOPPerforming">
1519
                                    <Boolean>false</Boolean>
1520
                                </field>
1521
                                <field name="type">
1522
                                    <String>XSL</String>
1523
                                </field>
1524
                                <field name="saveAs">
1525
                                    <Boolean>true</Boolean>
1526
                                </field>
1527
                                <field name="openInBrowser">
1528
                                    <Boolean>false</Boolean>
1529
                                </field>
1530
                                <field name="outputFile">
1531
                                    <null/>
1532
                                </field>
1533
                                <field name="outputResource">
1534
                                    <null/>
1535
                                </field>
1536
                                <field name="openOtherLocationInBrowser">
1537
                                    <Boolean>false</Boolean>
1538
                                </field>
1539
                                <field name="locationToOpenInBrowserURL">
1540
                                    <null/>
1541
                                </field>
1542
                                <field name="openInEditor">
1543
                                    <Boolean>true</Boolean>
1544
                                </field>
1545
                                <field name="showInHTMLPane">
1546
                                    <Boolean>false</Boolean>
1547
                                </field>
1548
                                <field name="showInXMLPane">
1549
                                    <Boolean>true</Boolean>
1550
                                </field>
1551
                                <field name="showInSVGPane">
1552
                                    <Boolean>false</Boolean>
1553
                                </field>
1554
                                <field name="showInResultSetPane">
1555
                                    <Boolean>false</Boolean>
1556
                                </field>
1557
                                <field name="useXSLTInput">
1558
                                    <Boolean>true</Boolean>
1559
                                </field>
1560
                                <field name="xsltParams">
1561
                                    <list/>
1562
                                </field>
1563
                                <field name="cascadingStylesheets">
1564
                                    <String-array/>
1565
                                </field>
1566
                                <field name="xslTransformer">
1567
                                    <String>Saxon6.5.5</String>
1568
                                </field>
1569
                                <field name="extensionURLs">
1570
                                    <String-array/>
1571
                                </field>
1572
                            </scenario>
1573
                            <scenario>
1574
                                <field name="advancedOptionsMap">
1575
                                    <null/>
1576
                                </field>
1577
                                <field name="name">
1578
                                    <String>lrs</String>
1579
                                </field>
1580
                                <field name="baseURL">
1581
                                    <String></String>
1582
                                </field>
1583
                                <field name="footerURL">
1584
                                    <String></String>
1585
                                </field>
1586
                                <field name="fOPMethod">
1587
                                    <String>pdf</String>
1588
                                </field>
1589
                                <field name="fOProcessorName">
1590
                                    <String>Apache FOP</String>
1591
                                </field>
1592
                                <field name="headerURL">
1593
                                    <String></String>
1594
                                </field>
1595
                                <field name="inputXSLURL">
1596
                                    <String>file:/Users/alessia/workspace8/dnet-parthenos/src/main/resources/eu/dnetlib/parthenos/index/parthenosLayoutToRecordStylesheet.xsl</String>
1597
                                </field>
1598
                                <field name="inputXMLURL">
1599
                                    <String>${currentFileURL}</String>
1600
                                </field>
1601
                                <field name="defaultScenario">
1602
                                    <Boolean>false</Boolean>
1603
                                </field>
1604
                                <field name="isFOPPerforming">
1605
                                    <Boolean>false</Boolean>
1606
                                </field>
1607
                                <field name="type">
1608
                                    <String>XSL</String>
1609
                                </field>
1610
                                <field name="saveAs">
1611
                                    <Boolean>true</Boolean>
1612
                                </field>
1613
                                <field name="openInBrowser">
1614
                                    <Boolean>false</Boolean>
1615
                                </field>
1616
                                <field name="outputFile">
1617
                                    <null/>
1618
                                </field>
1619
                                <field name="outputResource">
1620
                                    <null/>
1621
                                </field>
1622
                                <field name="openOtherLocationInBrowser">
1623
                                    <Boolean>false</Boolean>
1624
                                </field>
1625
                                <field name="locationToOpenInBrowserURL">
1626
                                    <null/>
1627
                                </field>
1628
                                <field name="openInEditor">
1629
                                    <Boolean>true</Boolean>
1630
                                </field>
1631
                                <field name="showInHTMLPane">
1632
                                    <Boolean>false</Boolean>
1633
                                </field>
1634
                                <field name="showInXMLPane">
1635
                                    <Boolean>true</Boolean>
1636
                                </field>
1637
                                <field name="showInSVGPane">
1638
                                    <Boolean>false</Boolean>
1639
                                </field>
1640
                                <field name="showInResultSetPane">
1641
                                    <Boolean>false</Boolean>
1642
                                </field>
1643
                                <field name="useXSLTInput">
1644
                                    <Boolean>true</Boolean>
1645
                                </field>
1646
                                <field name="xsltParams">
1647
                                    <list/>
1648
                                </field>
1649
                                <field name="cascadingStylesheets">
1650
                                    <String-array/>
1651
                                </field>
1652
                                <field name="xslTransformer">
1653
                                    <String>Saxon6.5.5</String>
1654
                                </field>
1655
                                <field name="extensionURLs">
1656
                                    <String-array/>
1657
                                </field>
1658
                            </scenario>
1659
                            <scenario>
1660
                                <field name="advancedOptionsMap">
1661
                                    <null/>
1662
                                </field>
1663
                                <field name="name">
1245 1664
                                    <String>oaf2dc</String>
1246 1665
                                </field>
1247 1666
                                <field name="baseURL">
......
1323 1742
                                    <String-array/>
1324 1743
                                </field>
1325 1744
                            </scenario>
1745
                            <scenario>
1746
                                <field name="advancedOptionsMap">
1747
                                    <null/>
1748
                                </field>
1749
                                <field name="name">
1750
                                    <String>opentrials2</String>
1751
                                </field>
1752
                                <field name="baseURL">
1753
                                    <String></String>
1754
                                </field>
1755
                                <field name="footerURL">
1756
                                    <String></String>
1757
                                </field>
1758
                                <field name="fOPMethod">
1759
                                    <String>pdf</String>
1760
                                </field>
1761
                                <field name="fOProcessorName">
1762
                                    <String>Apache FOP</String>
1763
                                </field>
1764
                                <field name="headerURL">
1765
                                    <String></String>
1766
                                </field>
1767
                                <field name="inputXSLURL">
1768
                                    <String>file:/Users/alessia/ot.xsl</String>
1769
                                </field>
1770
                                <field name="inputXMLURL">
1771
                                    <String>${currentFileURL}</String>
1772
                                </field>
1773
                                <field name="defaultScenario">
1774
                                    <Boolean>false</Boolean>
1775
                                </field>
1776
                                <field name="isFOPPerforming">
1777
                                    <Boolean>false</Boolean>
1778
                                </field>
1779
                                <field name="type">
1780
                                    <String>XSL</String>
1781
                                </field>
1782
                                <field name="saveAs">
1783
                                    <Boolean>true</Boolean>
1784
                                </field>
1785
                                <field name="openInBrowser">
1786
                                    <Boolean>false</Boolean>
1787
                                </field>
1788
                                <field name="outputFile">
1789
                                    <null/>
1790
                                </field>
1791
                                <field name="outputResource">
1792
                                    <null/>
1793
                                </field>
1794
                                <field name="openOtherLocationInBrowser">
1795
                                    <Boolean>false</Boolean>
1796
                                </field>
1797
                                <field name="locationToOpenInBrowserURL">
1798
                                    <null/>
1799
                                </field>
1800
                                <field name="openInEditor">
1801
                                    <Boolean>true</Boolean>
1802
                                </field>
1803
                                <field name="showInHTMLPane">
1804
                                    <Boolean>false</Boolean>
1805
                                </field>
1806
                                <field name="showInXMLPane">
1807
                                    <Boolean>true</Boolean>
1808
                                </field>
1809
                                <field name="showInSVGPane">
1810
                                    <Boolean>false</Boolean>
1811
                                </field>
1812
                                <field name="showInResultSetPane">
1813
                                    <Boolean>false</Boolean>
1814
                                </field>
1815
                                <field name="useXSLTInput">
1816
                                    <Boolean>true</Boolean>
1817
                                </field>
1818
                                <field name="xsltParams">
1819
                                    <list/>
1820
                                </field>
1821
                                <field name="cascadingStylesheets">
1822
                                    <String-array/>
1823
                                </field>
1824
                                <field name="xslTransformer">
1825
                                    <String>Saxon-PE</String>
1826
                                </field>
1827
                                <field name="extensionURLs">
1828
                                    <String-array>
1829
                                        <String>/Users/alessia/.m2/repository/eu/dnetlib/dnet-mapreduce-jobs/0.0.9.9-SNAPSHOT/dnet-mapreduce-jobs-0.0.9.9-SNAPSHOT.jar</String>
1830
                                    </String-array>
1831
                                </field>
1832
                            </scenario>
1326 1833
                        </scenario-array>
1327 1834
                    </entry>
1328 1835
                </serializableOrderedMap>
modules/dnet-api-http-doc/target/docbkx/html/api-doc.html
1 1
<html><head>
2 2
      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3
   <title>OpenAIRE API documentation</title><link rel="stylesheet" type="text/css" href="openaire-api.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">29 March 2017</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#d0e10">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to projects</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e220">DSpace/ePrints</a></span></dt></dl></dd><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt><dt><span class="section"><a href="#sec_http-projects">Projects</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="d0e10"></a>Chapter&nbsp;1.&nbsp;Overview</h1></div></div></div><p>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE
3
   <title>OpenAIRE API documentation</title><link rel="stylesheet" type="text/css" href="openaire-api.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">25 May 2017</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#d0e10">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to projects</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e236">DSpace/ePrints</a></span></dt></dl></dd><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt><dt><span class="section"><a href="#sec_http-projects">Projects</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="d0e10"></a>Chapter&nbsp;1.&nbsp;Overview</h1></div></div></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>25th May 2016</p><p>The HTTP API are under maintainance. Queries involving fields
4
        <code class="code">FP7scientificArea</code> and <code class="code">fundingStream</code> may not be working until
5
      tomorrow 26th May 2017. </p><p>We apologise for any inconvenience this may cause,</p><p>the OpenAIRE technical team.</p></div><p>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE
4 6
    programmatically.</p><p>If you have any question, please open a ticket to the <a class="link" href="https://www.openaire.eu/support/helpdesk" target="_top">OpenAIRE Helpdesk</a></p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Bulk access:</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#cha_oai_pmh" title="Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH">OAI-PMH</a></td></tr><tr><td><a class="xref" href="#cha_projects_http" title="Chapter&nbsp;3.&nbsp;Bulk access to projects">Bulk access to projects</a></td></tr></table></li><li class="listitem"><p>Selective access via <a class="xref" href="#cha_http-api" title="Chapter&nbsp;4.&nbsp;Selective access with HTTP API">HTTP Search API</a></p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#sec_http-pubs" title="Publications">Search HTTP API for metadata about publications</a></td></tr><tr><td><a class="xref" href="#sec_http-datasets" title="Datasets">Search HTTP API for metadata about datasets</a></td></tr><tr><td><a class="xref" href="#sec_http-projects" title="Projects">Search HTTP API for metadata about projects</a></td></tr></table></li></ul></div><p>The default format of delivered records is <code class="code">oaf</code> (OpenAire Format - current
5 7
    version 0.3): </p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="link" href="https://www.openaire.eu/schema/0.3/oaf-0.3.xsd" target="_top">https://www.openaire.eu/schema/0.3/oaf-0.3.xsd</a></td></tr><tr><td><a class="link" href="https://www.openaire.eu/schema/0.3/doc/oaf-0.3.html" target="_top">https://www.openaire.eu/schema/0.3/doc/oaf-0.3.html</a></td></tr></table><p>
6 8
  </p><p>The latest versions of the XML schema and documentation are also available at the following
7 9
    links: </p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="link" href="https://www.openaire.eu/schema/latest/oaf.xsd" target="_top">https://www.openaire.eu/schema/latest/oaf.xsd</a></td></tr><tr><td><a class="link" href="https://www.openaire.eu/schema/latest/doc/oaf.html" target="_top">https://www.openaire.eu/schema/latest/doc/oaf.html</a></td></tr></table><p>
8
  </p><p>Older versions: </p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="code">oaf</code> v0.2 <a class="link" href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd" target="_top"> XML
9
      schema</a> and <a class="link" href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html" target="_top">documentation</a></td></tr><tr><td><code class="code">oaf</code> v0.1 <a class="link" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top"> XML
10
      schema</a> and <a class="link" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a></td></tr></table><p>
10
  </p><p>Older versions: </p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="code">oaf</code> v0.2 <a class="link" href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd" target="_top"> XML schema</a> and <a class="link" href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html" target="_top">documentation</a></td></tr><tr><td><code class="code">oaf</code> v0.1 <a class="link" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top"> XML schema</a> and <a class="link" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a></td></tr></table><p>
11 11
  </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_oai_pmh"></a>Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH</h1></div></div></div><p>
12 12
        </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>The OAI-PMH publisher is not currently supporting incremental harvesting.</p><p>Although the usage of the OAI parameters 'from' and 'until' is handled by the OAI publisher, the datestamps of metadata records are updated about every week.</p><p>We apologise for any inconvenience this may cause to harvesters,</p><p>the OpenAIRE technical team.</p></div><p>
13 13
    </p><p>OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the
......
34 34
            <span class="emphasis"><em>WTProjects</em></span>: the set of projects funded by Wellcome Trust. Metadata
35 35
            prefix available: oaf</td></tr></table><p>For the list of available metadata prefixes, check: <a class="link" href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_top">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>.</p><p>Note that records will always be available in the OpenAIRE format (<a class="link" href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd" target="_top">schema</a>, <a class="link" href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html" target="_top">documentation</a>).
36 36
        The availability of records in oai_dc and oai_datacite depends on the typology of
37
        records.</p><p>Publications are avaialble in oai_dc according to the <a class="link" href="https://guidelines.openaire.eu/en/latest/literature/index.html" target="_top">OpenAIRE3.0 guidelines for literature repositories</a>.</p><p>Datasets are available in oai_datacite according to the <a class="link" href="https://guidelines.openaire.eu/en/latest/data/index.html" target="_top">OpenAIRE2.0 guidelines for data archives</a>. </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_projects_http"></a>Chapter&nbsp;3.&nbsp;Bulk access to projects</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#d0e220">DSpace/ePrints</a></span></dt></dl></div><p>The APIs offer custom access to metadata about projects funded by a selection of
37
        records.</p><p>Publications are avaialble in oai_dc according to the <a class="link" href="https://guidelines.openaire.eu/en/latest/literature/index.html" target="_top">OpenAIRE3.0 guidelines for literature repositories</a>.</p><p>Datasets are available in oai_datacite according to the <a class="link" href="https://guidelines.openaire.eu/en/latest/data/index.html" target="_top">OpenAIRE2.0 guidelines for data archives</a>. </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_projects_http"></a>Chapter&nbsp;3.&nbsp;Bulk access to projects</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#d0e236">DSpace/ePrints</a></span></dt></dl></div><p>The APIs offer custom access to metadata about projects funded by a selection of
38 38
        international funders for the DSpace and EPrints platforms.</p><p><a name="fundings"></a>The currently supported funding streams and
39 39
        relative codes are: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>FP7: The 7th Framework Programme funded by the European Commission</p></li><li class="listitem"><p>WT: Wellcome Trust funding programme</p></li><li class="listitem"><p>H2020: Horizon2020 Programme funded by the European Commission</p></li><li class="listitem"><p>FCT: the funding programme of Funda&ccedil;&atilde;o para a Ci&ecirc;ncia e a Tecnologia, the
40 40
                    national funding agency of Portugal</p></li><li class="listitem"><p>ARC: the funding programme of the Australian Research Council</p></li><li class="listitem"><p>NHMRC: the funding programme of the Australian National Health and Medical Research Council</p></li></ul></div><p> Coming soon: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>SFI: Science Foundation Ireland</p></li><li class="listitem"><p>CSF: Croatian Science Foundation</p></li><li class="listitem"><p>MSES: Ministry of Science, Education and Sports of the Republic of Croatia</p></li></ul></div><p>
41
    </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e220"></a>DSpace/ePrints</h2></div></div></div><table border="0" summary="Simple list" class="simplelist"><tr><td>DSpace endpoint: <a class="link" href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL" target="_top">http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL</a></td></tr><tr><td>ePrints endpoint: <a class="link" href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL</a></td></tr></table><p> The URLs embed the parameters needed to collect projects funded by specific funding
41
    </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e236"></a>DSpace/ePrints</h2></div></div></div><table border="0" summary="Simple list" class="simplelist"><tr><td>DSpace endpoint: <a class="link" href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL" target="_top">http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL</a></td></tr><tr><td>ePrints endpoint: <a class="link" href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL</a></td></tr></table><p> The URLs embed the parameters needed to collect projects funded by specific funding
42 42
            stream, where the pattern is
43 43
                <code class="code">FundingStream/FundingSubStream/FundingSubSubStream</code>.</p><p>Additional parameters can be concatenated to the URL to refine the results by date
44 44
            (date must be in the form <code class="code">YYYY-MM-DD</code>): </p><table border="0" summary="Simple list" class="simplelist"><tr><td>startFrom</td></tr><tr><td>startUntil</td></tr><tr><td>endFrom</td></tr><tr><td>endUntil</td></tr></table><p>Examples: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>Get Wellcome Trust projects for EPrints: <a class="link" href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/WT/ALL/ALL</a></td></tr><tr><td>Get EC-FP7 projects of the specific programme &#8220;SP2-IDEAS&#8221; for EPrints: <a class="link" href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a></td></tr><tr><td>Get EC-FP7 projects for DSpace that started after the given date: <a class="link" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a></td></tr></table><p>
45
        </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_http-api"></a>Chapter&nbsp;4.&nbsp;Selective access with HTTP API</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt><dt><span class="section"><a href="#sec_http-projects">Projects</a></span></dt></dl></div><p>The OpenAIRE+ HTTP API allows developers to access the metadata information space of OpenAIRE+ by
45
        </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_http-api"></a>Chapter&nbsp;4.&nbsp;Selective access with HTTP API</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt><dt><span class="section"><a href="#sec_http-projects">Projects</a></span></dt></dl></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>25th May 2016</p><p>The HTTP API are under maintainance. Queries involving fields
46
      <code class="code">FP7scientificArea</code> and <code class="code">fundingStream</code> may not be working until
47
      tomorrow 26th May 2017. </p><p>We apologise for any inconvenience this may cause,</p><p>the OpenAIRE technical team.</p></div><p>The OpenAIRE+ HTTP API allows developers to access the metadata information space of OpenAIRE+ by
46 48
    performing queries over publications, datasets, and projects.</p><p>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
47 49
    to the whole information space: the number of total results returned by one query is limited
48 50
    to 10,000.</p><p>For accessing the whole information space, developers are encouraged to use the <a class="xref" href="#cha_oai_pmh" title="Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH">OAI-PMH</a></p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-common"></a>Common API parameters</h2></div></div></div><p> Parameters included in this section can always be specified, regardless the type of
modules/dnet-api-http-doc/src/docbkx/overview.xml
2 2
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
3 3
  xmlns:xlink="http://www.w3.org/1999/xlink">
4 4
  <title>Overview</title>
5
  
6
  <warning>
7
    <para>25th May 2016</para>
8
    <para>The HTTP API are under maintainance. Queries involving fields
9
        <code>FP7scientificArea</code> and <code>fundingStream</code> may not be working until
10
      tomorrow 26th May 2017. </para>
11
    <para>We apologise for any inconvenience this may cause,</para>
12
    <para>the OpenAIRE technical team.</para>
13
  </warning>
14
  
5 15
  <para>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE
6 16
    programmatically.</para>
7 17
  <para>If you have any question, please open a ticket to the <link
......
47 57
    </simplelist>
48 58
  </para>
49 59
</chapter>
60
<?oxy_options track_changes="on"?>
modules/dnet-api-http-doc/src/docbkx/http_api.xml
3 3
  xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
4 4
  xml:id="cha_http-api" xreflabel="HTTP Search API">
5 5
  <title>Selective access with HTTP API</title>
6
  <warning>
7
    <para>25th May 2016</para>
8
    <para>The HTTP API are under maintainance. Queries involving fields
9
      <code>FP7scientificArea</code> and <code>fundingStream</code> may not be working until
10
      tomorrow 26th May 2017. </para>
11
    <para>We apologise for any inconvenience this may cause,</para>
12
    <para>the OpenAIRE technical team.</para>
13
  </warning>
6 14
  <para>The OpenAIRE+ HTTP API allows developers to access the metadata information space of OpenAIRE+ by
7 15
    performing queries over publications, datasets, and projects.</para>
8 16
  <para>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
modules/dnet-api-http-doc/src/docbkx/api-doc.xml
16 16
      </author>
17 17
    </authorgroup>
18 18
    -->
19
    <pubdate>29 March 2017</pubdate>
19
    <pubdate>25 May 2017</pubdate>
20 20
  </info>
21

  
21 22
  <!-- include chapters -->
22 23
  <!--  <xi:include href="warning.xml"/> -->
23 24
  <xi:include href="overview.xml"/>
......
28 29
  <xi:include href="intro_chapter.xml"/>
29 30
  <xi:include href="param_chapter.xml"/>
30 31
  -->
32
 
33

  
31 34
  
35
  
32 36
</book>
modules/dnet-api-http-doc/pom.xml
20 20
          <execution>
21 21
            <goals>
22 22
              <!-- RUN with mvn docbkx:generate-html -->
23
              <!-- then copy to /srv/www/api-docs/ of openaire-www.vls.icm.edu.pl -->
23 24
              <goal>generate-html</goal>
24 25
            </goals>
25 26
            <phase>pre-site</phase>

Also available in: Unified diff