Loading TOC...
XQuery admin:appserver-get-default-error-format

MarkLogic 12 Product Documentation
admin.appserverGetDefaultErrorFormat

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

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.appserverGetId call.

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}

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const appserverId = admin.appserverGetId(config, null, "MyAppServer")
admin.appserverGetDefaultErrorFormat(config,appserverId)
  =>
  compatible

   //returns the default format for protocol errors on the App Server

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