REST Messages

REST-FAILEDACCEPT

Message Text

: variable1 is not a matching user agent string

Cause

Logged in user has insufficient privileges.

Response

Check the documentation and update privileges accordingly

REST-FAILEDAUTH

Message Text

User does not have necessary privilege

Cause

Logged in user has insufficient privileges. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 403 Forbidden.

Response

Check the documentation and update privileges accordingly

REST-FAILEDFUNCTION

Message Text

User defined condition function returned false: {variable1}variable2

Cause

The user-defined condition function returned false.

Response

Check the documentation for that condition and adjust accordingly.

REST-FAILEDUSERAGENT

Message Text

Invalid user agent: variable1 is not a matching user agent string

Cause

Logged in user has insufficient privileges.

Response

Check the documentation and update privileges accordingly

REST-INCORRECTURI

Message Text

Incorrect URI: variable1 does not match variable2

Cause

The REST library was called with an invalid request configuration

Response

This error corresponds to an HTTP code 400 Bad Request. Check the configuration and correct the incorrect URI.

REST-INVALIDCONDITION

Message Text

Invalid condition: variable1 is not a valid condition

Cause

A REST endpoint was configured with an invalid condition.

Response

This error corresponds to an HTTP code 400 Bad Request. Check the declaration of the endpoint and correct the invalid condition.

REST-INVALIDCRITERIA

Message Text

Invalid criterion: "variable1" is not valid, must be one of: variable2

Cause

The rewriter was called with invalid matching criteria.

Response

Check the calling function and invoke it with valid criteria.

REST-INVALIDMIMETYPE

Message Text

Content-Type must be one of: variable1, Received: variable2

Cause

The client-supplied Content-Type header is not an acceptable mimetype for this endpoint.

Response

Resubmit the request with an acceptable content-type header and body (see message details).

REST-INVALIDPARAM

Message Text

Invalid parameter: variable1

Cause

A REST endpoint was called with an invalid parameter.

Response

This error should throw an HTTP 400 Bad Request. Check the documentation for form parameters for the REST endpoint that threw this error. Adjust the client call accordingly.

REST-INVALIDREQUEST

Message Text

Invalid request: variable1

Cause

The request is invalid.

Response

Correct the request.

REST-INVALIDTYPE

Message Text

Invalid type in variable1: variable2 variable3 variable4

Cause

A REST endpoint was configured with an invalid type. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 406.

Response

This error corresponds to an HTTP code 400 Bad Request. Check the declaration of the endpoint and correct the invalid type.

REST-MULTIPLEPATTERNS

Message Text

Multiple patterns match the parameter: variable1

Cause

A REST endpoint was called with a parameter name that matches more than one parameter in the endpoint description.

Response

This error should throw an HTTP 400 Bad Request. Check the documentation for parameter patterns or URI parameters for the REST endpoint that threw this error. Adjust the client call accordingly.

REST-REPEATEDPARAM

Message Text

Endpoint does not support repeated parameter: variable1 can only appear once

Cause

A parameter which cannot be repeated is being repeated. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 400.

Response

Remove all but one instance of the offending parameter.

REST-REQUIREDPARAM

Message Text

Required parameter: variable1

Cause

Required parameter is not provided. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 400.

Response

Provide the required parameter.

REST-UNACCEPTABLETYPE

Message Text

No acceptable content type: None of the requested types variable1 can be provided

Cause

None of the acceptable types indicated by the caller can be provided.

Response

Check the documentation for the Accept types that the endpoint supports. Include at least one of the supported MIME types in the Accept header. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 406.

REST-UNSUPPORTEDMETHOD

Message Text

Endpoint does not support method: variable1

Cause

A client has submitted an HTTP method that the matched REST API endpoint does not support. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 405.

Response

This error is a standard wrapper for HTTP Response Code 405 Method Not Allowed. For example, your client has submitted a PUT request, and the endpoint does not support this verb. Check your client and the server endpoint for whether this error is appropriate for the given scenario.

REST-UNSUPPORTEDPARAM

Message Text

Endpoint does not support query parameter: variable1

Cause

An unsupported query parameter is included. When this error is reported by a MarkLogic REST API instance, MarkLogic Server returns status code 400.

Response

Remove the unsupported parameter.