Error Messages Returned by the Document Approval API

Use this information to troubleshoot your queries to the Document Approval API.

HTTP Code

Response Code

Message

Additional Information

400

approvableTypeMismatch

Approvable type is not matching

The query URL specifies one approvable type, but the approvable ID is for an approvable of a different type.

400

approvableTypeMissing

Approvable type is missing

The query does not specify what type of approvable is relevant. Possibilities are invoice and requisition.

400

badRequest

Malformed syntax or bad query

Check your query for typos and other syntax errors.

400

badRequest

Unrecognized field in request body

The request body refers to one or more invalid fields.

400

changeSequenceIdNotNumeric

changeSequenceId parameter needs to be numeric

Make sure the value of the changeSequenceId attribute is numeric.

400

contentTypeIncorrect

Content-Type supported is 'application/json'

The only supported value for the Content-Type header is 'application/jason'.

400

countNotBoolean

$count parameter needs to be boolean

Make sure the $count parameter is boolean.

400

invalidApprovableType

Invalid approvable type requested

The query requests an approvable of an unsupported type.

400

invalidEnumValue

Invalid enum value in request body

Check the spelling and accuracy of enumerated values in the request body.

400

invalidRealm

realm parameter is either invalid or does not exist

Make sure the realm parameter accurately specifies your site.

400

missingPasswordAdapter

PasswordAdapter parameter is missing for effective user

Include the password adapter and resubmit your query.

400

missingUser

user parameter is missing for effective user

Include the user parameter and resubmit your query

400

payloadMissing

Request body is missing

The query must include a properly formed JSON body.

400

skipNotNumeric

$skip parameter needs to be numeric

Make sure the value of the $skip parameter is numeric.

400

topLargerThanMax

$top (limit) parameter is larger than maximum allowed value

Make sure that the value of the $top is not too large.

400

topNotNumeric

$top parameter needs to be numeric

Make sure the value of the $top parameter is numeric.

400

unknownParameter

Unknown parameter received.

The query includes a parameter that the system doesn't recognize. Check spelling of all parameters, and make sure that all parameters are valid for the endpoint in use.

400

updateFailed

Update Failed

The PATCH request was unsuccessful.

400

updateFailedInvalidParameter

Update failed due to an invalid parameter passed

Query includes an invalid parameter.

400

updateFailedUserUnauthorized

Update failed. User unauthorized

The specified user does not have access to the desired resource.

400

userNotFound

User for requested user and passwordAdapter pair not found

Double check that the user parameter and passwordAdapter parameters are both correct.

400

userNotUnique

Multiple users exist with this name, please add passwordAdapter value in $filter to disambiguate.

Resubmit your query filtered on passwordAdapter.

404

approvableNotFound

Approvable not found

The query refers to an approvable not present in the system.

404

attachmentNotFound

Attachment not found

The query refers to an attachment not present in the system.

404

groupNotFound

Group not found

The query refers to a user group not present in the system.

404

notFound

Requested resource not found

The query requests a resource not present in the system.

405

methodNotAllowed

Operation (HTTP verb) is not allowed on the resource

You may have specified the incorrect HTTP verb for this query.

406

notAcceptable

Requested representation (content type as requested in the Accept header) not available for the resource

The value passed in the Accept header must be application/json

500

internalServerError

Internal Server Error

The internal system may have thrown an error.

If you set the value of the showErrorDetails parameter to true, the details of an error thrown by the internal system are included in the response error block in a detailssub-block. Details are localized to the region of the internal system.

501

notImplemented

Requested operation not supported

The $filter parameter supports only certain comparison operations. For GET /changes only gt is supported. For all other endpoints, only eq is supported.