Error Handling

Format

Errors will be returned in a format containing:

Error Message errorMessage
Unique Error ID errorId
HTTP Error Code errorCode
A timestamp of the time the error occurred timestamp

For example, this is an error returned when supplying a DITA Map input but not specifying the master file parameter:

Response (XML)

XML

<error>
    <errorMessage>When dxFormatB is set to ditamap, dxMasterFileB also needs to be specified</errorMessage>
    <errorId>02bc760f-8963-44e4-bf45-be9905519a70</errorId>
    <errorCode>400</errorCode>
    <timestamp>2023-09-22T13:16:23.000+0000</timestamp>
</error>

Response (JSON)

JSON

{
    "errorMessage": "When dxFormatB is set to ditamap, dxMasterFileB also needs to be specified",
    "errorId": "02bc760f-8963-44e4-bf45-be9905519a70",
    "errorCode": 400,
    "timestamp": "2023-09-22T13:16:23.000+0000"
}

Content Type

If set, the error will be returned in the content type specified in the Accept header of the request.
E.g. if there was an error getting a Job's information and you set Accept to application/json, it will be returned in JSON format.

If no Accept header is set, and you posted XML or JSON inputs, it will return in the content type of your inputs.
For example, posting a comparison in XML with incorrect file paths will return something like this:

XML

<error>
    <errorMessage>inputB: cannot read ditamap.zip</errorMessage>
    <errorId>6c6bacd8-a06f-4dc6-a9de-f0891170ff04</errorId>
    <errorCode>400</errorCode>
    <timestamp>2023-09-22T13:17:51.944+0000</timestamp>
</error>

If neither of those previous conditions are set (e.g. no Accept header and posted a comparison using multipart/form-data) it will fallback to XML format.