Tchater maintenant avec le support
Tchattez avec un ingénieur du support

Identity Manager 8.2.1 - API-Entwicklungshandbuch

Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit API-Konfiguration Eigene APIs implementieren Der API Designer Schnellstart – Eine API mit dem API Designer erstellen Arbeiten mit dem API Designer
API Designer starten Projekttypen Benutzeroberfläche Globale Einstellungen Datenbankobjekte Änderungen kennzeichnen Suchen und Ersetzen Mehrsprachige Texte Datenbankabfragen verwalten Tabreiter verwalten Layouts verwalten Änderungshistorie anzeigen (Befehlsliste) Lesezeichen API kompilieren Versionen verwalten (Kompilierungszweige) API testen C#-Projekte mit dem API Designer verbinden
API-Projekte API-Dateien ImxClient-Kommandozeilenprogramm

Parameterformate

HTTP-Anfragen verwenden zwei Arten von Parametern:

Verwandte Themen

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

Verwandte Themen

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

Verwandte Themen

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
Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation