Main Page » XQuery » Functions » RESTXQ Functions

RESTXQ Functions

This 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.
  • 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


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


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


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


  $update  as xs:boolean?  := false()
) as empty-sequence()
SummaryInitializes the RESTXQ module cache:
  • By default, the cache will be discarded, and all modules will be parsed and cached again.
  • If $update is enabled, the background caching behavior is simulated (see PARSERESTXQ): Only updated modules will be parsed.
  • This function should be called if new RESTXQ code is deployed at runtime.


Version 9.4Version 8.6Version 7.7
  • Added: New module added.

⚡Generated with XQuery