From BaseX Documentation
Revision as of 13:49, 30 January 2019 by CG (talk | contribs) (→‎Conventions)
Jump to navigation Jump to search

This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.


  • The module will be available if the basex-api library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war).
  • All functions are assigned to the namespace, which is statically bound to the rest prefix. Prior to Version 9.2, the module needed to be imported in the query prolog:
import module namespace rest = "";
  • In this document, the namespace is bound to the rest prefix.
  • The namespace is bound to the wadl prefix.
  • If any of the functions is called outside the servlet context, basex:http is raised.

General Functions


Signatures rest:base-uri() as xs:anyURI
Summary Returns the implementation-defined base URI of the resource function.


Signatures rest:uri() as xs:anyURI
Summary 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.


Signatures rest:wadl() as element(wadl:application)
Summary Returns a WADL description of all available REST services.


Signatures rest:init() as empty-sequence()
Summary Initializes the RESTXQ module cache. This function should be called after RESTXQ modules have been replaced while the web server is running, and if PARSERESTXQ is not set to 0.


Version 8.6

This module was introduced with Version 7.7.