Chat now with support
Chat mit Support

Identity Manager 9.0 LTS - API-Entwicklungshandbuch

Antwortformate

Die meisten API-Methoden liefern Ergebnisse im JSON-Format (application/json) zurück. Des Weiteren wird die Rückgabe von Ergebnissen in den Formaten CSV und PDF unterstützt, soweit das Ergebnis der entsprechenden API-Methode als exportierbar deklariert ist (über das Flag AllowExport). Grundsätzlich kann eine API-Methode Ergebnisse in beliebigen Formaten zurückgeben, die mit HTTP kompatibel sind.

Um Ergebnisse im CSV-Format zu erhalten

  • Setzen Sie den Accept header in der Anfrage auf text/csv.

Um Ergebnisse im PDF-Format zu erhalten

  • Setzen Sie den Accept header in der Anfrage auf application/pdf.

    HINWEIS: Um Ergebnisse im PDF-Format zu erhalten, muss in Ihrem System das Modul RPS installiert sein.

Verwandte Themen

Antwortcodes

Antworten, die von der REST-API versendet werden, verwenden die nachfolgenden Codes. Wenn Anfragen fehlschlagen, wird eine erklärende Fehlermeldung angezeigt.

Antwortcodes

Beschreibung

200

Die Anfrage war erfolgreich.

204

Die Anfrage war erfolgreich. Die Antwort enthält keinen Inhalt.

401

Der Zugriff ist unautorisiert. Die Sitzung muss zuerst authentifiziert werden.

404

Die angegebene Ressource konnte nicht gefunden werden.

405

Die verwendete HTTP-Methode ist für diese Anfrage nicht erlaubt.

500

Ein Server-Fehler ist aufgetreten. Die Fehlermeldung wird in der Antwort mitgesendet. Aus Sicherheitsgründen ist keine detaillierte Fehlermeldung in der Antwort enthalten. Weitere Informationen können Sie der Anwendungs-Log-Datei auf dem Server entnehmen.

Verwandte Themen

Deadlocks vermeiden

Bei der API-Entwicklung wird viel asynchroner Code mit async/await-Konstrukt geschrieben. Um sogenannte Deadlocks (Verklemmungen) zu verhindern, verwenden Sie für jedes await-Schlüsselwort die Methode ConfigureAwait(false).

Weitere Informationen finden Sie unter https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html und https://devblogs.microsoft.com/dotnet/configureawait-faq/.

Beispiele und Hilfe – Software Development Kit

Um Ihnen die Entwicklung Ihrer API einfacher zu gestalten, stellt Ihnen One Identity ein Software Development Kit (SDK) mit vielen kommentierten Code-Beispielen zur Verfügung.

Das SDK finden Sie unter auf dem Installationsmedium im Verzeichnis QBM\dvd\AddOn\ApiSamples.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen