Identity Manager 9.1.3 - API-Entwicklungshandbuch

HTTP-Anfragen verwenden zwei Arten von Parametern:

• Pfad-Parameter

• Abfrage-Parameter

Verwandte Themen

• Datumsformate

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.

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)

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