Loading TOC...

admin.appserverSetDefaultErrorFormat

admin.appserverSetDefaultErrorFormat(
   $config as element(configuration),
   $appserver-id as (Number|String),
   $value as 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.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id The ID of the App Server. Typically, this is the result of an admin:appserver-get-id call.
$value The format for the protocol error. The format can be compatible, json, html, or xml.

Required Privileges

This operation requires at least one of the following 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

const admin = require('/MarkLogic/admin.xqy');
var config = admin.getConfiguration()
var appserverId = admin.appserverGetId(config, null, "MyAppServer")
admin.appserverSetDefaultErrorFormat(config,appserverId, "json")

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.  
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.