Format der Antwort bei Fehlern

Freigegeben: JSON-Repräsentation

In diesem Kapitel erfahren Sie, in welchem Format Fehler ausgegeben werden. Abhängig vom Verarbeitungsergebnis des Ablagevorgangs wird die HTTP-Anforderung mit verschiedenen HTTP-Statuscodes beantwortet. Optional werden beschreibende Informationen zurückgeliefert.

Beispiel für eine Antwort für eine fehlgeschlagene Anforderung (Request):

Response

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

Beschreibung der Parameter zu der Antwort auf die fehlerhafte Anforderung:

Eigenschaft

Beschreibung

reason

Ein optionaler kurzer Beschreibungstext, weshalb der Fehler aufgetreten ist. Dieser Text wird als Titel der Fehlermeldung verwendet.

hint

Ein optionaler Hinweistext für den Anwender mit Tipps für die Fehlerbehebung.

details

Optionale Detailinformationen zum Fehler.

severity

Optionaler Schweregrad des Fehlers. Folgende Werte sind möglich:

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

errorCode

Ein optionaler Fehlercode, den d.3 server zurückgegeben hat.

requestId

ID der zugehörigen Anforderung. Die ID wird bei weiteren Anforderungen an andere Apps übergeben und dient der Nachverfolgung bei der Verarbeitung einer Aktion.

Zusätzliche Parameter, wenn das abzulegende DMS-Objekt als Duplikat erkannt wird:

Eigenschaft

Beschreibung

dmsObjectId

Enthält die ID des bereits existierenden DMS-Objektes.

_links

Enthält die Linkrelation dmsobject, die auf das bereits existierende DMS-Objekt verweist.

Die Bearbeitung eines Elements durch Anwender in Microsoft Office 365 erfordert die exklusive Bearbeitung eines DMS-Objektes. Falls die Verarbeitung durch Office 365 noch nicht abgeschlossen ist, schlägt die Anforderung fehl und Sie erhalten als Antwort den Statuscode 403 Forbidden mit entsprechenden Fehlerinformation. Bitte wiederholen Sie die Anforderung zu einem späteren Zeitpunkt.