RESTXQ Module
Revision as of 13:59, 4 June 2013 by CG (talk | contribs) (Created page with "This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the [http://exquery.github.io/exquery/exquery-restxq-specific...")
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- This module is included in the complete distributions (zip, exe, war) of BaseX.
- All functions are assigned to the
http://exquery.org/ns/restxq
namespace, which must be dynamically imported:
import module namespace rest = "http://exquery.org/ns/restxq"; ...
- In this documentation, the namespace is bound to the
rest
prefix, and thehttp://wadl.dev.java.net/2009/02
namespace is bound to thewadl
prefix. - If any of the functions is called outside the servlet context, the error
BXSE0003
: is raised.
General Functions
restxq:base-uri
Signatures | restxq:base-uri() as xs:anyURI
|
Summary | This function returns the implementation defined base URI of the resource function. |
restxq:uri
Signatures | restxq:base-uri() as xs:anyURI
|
Summary | This function returns the complete URI that addresses the Resource Function. This is the result of rest:base-uri appended with the path from the path annotation of the resource function. |
restxq:wadl
Signatures | restxq:wadl() as element(wadl:application)
|
Summary | This (unofficial) function returns a [WADL description] of all available REST services. |
Changelog
This module was introduced with Version 7.5.