From BaseX Documentation
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 basex-api package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX.
  • All functions are assigned to the namespace. The module must be imported in the query prolog:
import module namespace rest = "";
  • In this documentation, the namespace is bound to the rest prefix, and the namespace is bound to the wadl prefix.
  • If any of the functions is called outside the servlet context, the error BXSE0003: is raised.

General Functions


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


Signatures rest: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.


Signatures rest:wadl() as element(wadl:application)
Summary This (unofficial) function returns a WADL description of all available REST services.


This module was introduced with Version 7.7.