MarkLogic 10 Product Documentation

admin:appserver-set-default-error-format

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

Summary

This function sets the default format 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 format based 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}

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{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-set-default-error-format($config,$appserver-id, "json")

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)