Chat now with support
Chat mit Support

Identity Manager 9.2.1 - API-Entwicklungshandbuch

Über dieses Handbuch Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren ImxClient-Kommandozeilenprogramm

Pfad-Parameter

Pfad-Parameter setzen den URL-Pfad fort. Als Trennzeichen wird hierbei ein Schrägstrich verwendet.

Wenn eine Anfrage Pfad-Parameter verwendet, werden diese im URI-Format für die Anfrage angegeben.

Beispiel

https://<Host-Name>/ApiServer/imx/sessions/exampleparameter

Abfrage-Parameter

Abfrage-Parameter werden der URL über ein Frage- oder das &-Zeichen angehangen.

Dem ersten Abfrage-Parameter muss ein Fragezeichen vorangestellt werden. Dabei muss folgendes Format verwendet werden:

?Parametername=Parameterwert (beispielsweise ?orderBy=LastName)

Den nachfolgenden Abfrage-Parametern muss ein & vorangestellt werden. Dabei muss folgendes Format verwendet werden:

&Parametername=Parameterwert (beispielsweise ?sortOrder=ascending)

HINWEIS: Unbekannte Abfrage-Parameter werden vom Server mit dem Fehlercode 400 abgelehnt. Das betrifft auch Abfrage-Parameter mit einer fehlerhaften Groß-/Kleinschreibung.

Beispiel

https://<Host-Name>/AppServer/portal/person?orderBy=LastName

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.

403

Der Anmeldevorgang ist fehlgeschlagen. Diese Antwort wird beispielsweise versendet, wenn ein falscher Benutzername oder ein falsches Kennwort übermittelt wurde.

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 Anwendungsprotokolldatei auf dem Server entnehmen.

Verwandte Themen
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen