MarkLogic Server 11.0 Product Documentation

admin:appserver-get-default-error-format

admin:appserver-get-default-error-format(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong
) as xs:string

Summary

This function returns the default format for protocol errors for an App Server. The 'default' error format can be compatible, json, html, or xml. At runtime the actual error format is resolved to a concrete formatba sed on many factors, and will end up as JSON, HTML, or XML.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

Example

xquery version "1.0-ml";

import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
let $appserver-id := admin:appserver-get-id($config, (), "MyAppServer")
return
admin:appserver-get-default-error-format($config,$appserver-id)

  =>
  compatible

  (: returns the default format for protocol errors on the App Server :)