Response format for errors

Released: JSON representation

In this chapter, you will learn about the output format for errors. Depending on the result of the storage process, the HTTP request is answered with different HTTP status codes. Descriptive information can be returned as an option.

Example for a response upon a failed request:

Response

HTTP/1.1 400 BadRequest
  
{
    "reason": "10019: Missing value for a mandatory property.",
    "severity": 1,
    "errorCode": 10019
}

Description of parameters for response upon a failed request:

Property

Description

reason

An optional short description of why the error has occurred. This text is used as the error message’s title.

hint

An optional message for the user containing troubleshooting tips.

details

Optional detailed information about the error.

severity

Optional error severity. Possible values are:

Success = 0,
Information = 1,
Warning = 2,
Error = 3

errorCode

An optional error code, as returned by d.3 server.

requestId

ID of the associated request During additional requests, the ID is transferred to other apps and serves tracing purposes when an action is processed.

Additional parameters, if the DMS object to be stored is recognized as a duplicate:

Property

Description

dmsObjectId

Contains the ID of the already existing DMS object.

_links

Contains the link relation dmsobject referencing the already existing DMS object.

The exclusive processing of a DMS object is required so users in Microsoft Office 365 can process an element. If processing via Office 365 is not complete, the request fails, and you receive the status code 403 Forbidden with the corresponding error information as the response. Please repeat the request at a later time.