Date: Thu, 28 Mar 2024 13:47:59 -0400 (EDT) Message-ID: <1823483565.784.1711648079921@prodopencatalystconfluence.catalyst> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_783_1020083700.1711648079919" ------=_Part_783_1020083700.1711648079919 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The eagle-i repository provides a comprehensive range of CRUD an= d query web services through its REST API, described in the Repos= itory Design Specification and API Manual. This API provides interactio= n at a relatively low level of abstraction, as data input and output are ca= rried out in RDF with no ontology constraints. The primary clients of= this API are the eagle-i SWEET, SWIFT/ETL and data management toolkits, an= d the eagle-i search application.
Other eagle-i software components provide more targeted public web servi= ces that do not require RDF knowledge. They are described below.
These two web services are packaged with the SWEET application. They are= centered on the concept of a Resource Provider, which is an organ= ization that houses eagle-i resources - typically a laboratory or a core fa= cility. The information returned by this web service is assembled by issuin= g targeted SPARQL queries to the eagle-i repository and collating informati= on from the resource provider record and from its linked resources records,= such that it be possible to find out at a glance what a resource provider = offers. The information can be requested in XML format, so as to integrate = it into other content pages. NB. we will soon provide a JSON alternative.= p>
In order for these services to work properly, the following properties s= hould be configured in the eagle-i-apps-credentials property file - see Configuration Proper= ty Guide - pre 2.0MS3.x:
eaglei.catalyst.user eaglei.catalyst.password
The value of these properties should be a user created in the repository= with no roles. By default, resource provider records will not contain cont= act information. This can be changed (though only for Core facilities), by = adding the anonymousExtended user to the Contact Properties ACL via the rep= ository's administrative console.
This call returns a list of resource providers, optionally restricted by= type (e.g. only Core Laboratories), and includes minimal information about= the provider (description, contact people). It is intended to be used as a= "table of contents" from which individual resource providers can be select= ed, or as a list to loop through and visit all records. Note that at = the moment this service does not use HTTP content negotiation for determini= ng the returned format, but instead relies on the mime type being passed as= an argument.
URL: /sweet/providers
(GET and POST)
Shorthand URL: /sweet/cores
(GET and POST)=
Same as /sweet/providers?type=3Dhttp://vivo=
web.org/ontology/core#CoreLaboratory&...
Shorthand URL: /sweet/labs
(GET and POST)<=
/p>
Same as /sweet/providers?type=3Dhttp://vivo=
web.org/ontology/core#Laboratory&...
Args:format
-- text/html (default), app=
lication/xml
type
-- URI of an optional type restriction; If this argumen=
t is absent, all types are returned.
e.g. return only providers of type Core Laboratory: type=3Dhttp://vivoweb.org/ontology/core#CoreLaboratory
Result:
A list of resource providers with their description and minimal informat= ion. If format=3Dapplication/xml, the list is formatted according to the fo= llowing XML Schema:
If format=3Dtext/html, the XML is transformed into HTML using the follow= ing XSLT stylesheet:
This call returns information about one resource provider, including sho= rt descriptions of all the resources that link to it (i.e are "located in",= "provided by", etc.) organized by resource type.
URL: /sweet/provider
(GET and POST)
Args:
uri
-- the eagle-i ID (URI) of the resource provider, e.g.&n=
bsp;uri=3Dhttp://alaska.eagle-i.net/i/0000012a-25c2-=
586d-76e0-f22c80000000format
-- text/html (default),=
application/xml
Result:
Information about one resource provider.
If format=3Dapplication/xml, the list is formatted according to the foll= owing XML Schema:
If format=3Dtext/html, the XML is transformed into HTML using the follow= ing XSLT stylesheet:
eagle-i resources are published as Linked Open Data on the web. If instr= ucted to do so, search engine crawlers can index the HTML rendering of reso= urces, which makes them available as results in public search engines. A si= temap.xml file that lists published resources and that is accessible at the= root of your site communicates to search engines that resources are ready = to be indexed. This web service provides a means of generating the contents= of a sitemap, and is intended to be incorporated in a periodic job that up= dates the sitemap.xml file.
URL: /sweet/sitemap
(GET and POST)
Args:
none
Result:
A dynamically generated list of published resource providers and resources=
, formatted in XML according to the sitemap schema:http://www.sitemaps.org/schemas/sitemap/sitemap.xsd