Sie können die folgenden Arten von API-Methoden definieren.
-
Entity-Methoden
-
Benutzerdefinierte Methoden
-
SQL-Methoden
Sie können die folgenden Arten von API-Methoden definieren.
Entity-Methoden
Benutzerdefinierte Methoden
SQL-Methoden
Entity-Methoden arbeiten mit kleinen Teilen des Objektmodells, um Daten aus der Datenbank zu lesen beziehungsweise in diese zu schreiben. Wenn Sie eine Entity-Methode erstellen müssen Sie nur Tabellen- und Spaltennamen sowie gegebenenfalls eine Filterbedingung (WHERE-Klausel) angeben. Die interne Abarbeitung wird durch den API Server übernommen. Das Schema der Eingabe- und Ausgabedaten ist ebenfalls fest vorgegeben.
Beispiele zur Definition von Entity-Methoden finden Sie im SDK unter Sdk01_Basics\01-BasicQueryMethod.cs.
Deklarieren Sie in der URL von Entity-Methoden, die Operationen vom Typ Update oder Create unterstützen, keine Pfad-Parameter.
HINWEIS: Entity-basierte Methoden arbeiten standardmäßig mit einer Limitierung, um unabsichtliches Laden extrem großer Datenmengen zu vermeiden.
Mithilfe der folgenden Abfrage-Parameter können Sie die Anzahl der zurückgegebenen Datensätze begrenzen, um mehrere Datensätze in aufeinanderfolgenden Antworten zu erhalten:
| Abfrage-Parameter | Standardwert | Beschreibung |
|---|---|---|
| PageSize | 20 |
Legen Sie fest, wie viele Datensätze in der Antwort maximal enthalten sein dürfen. Wenn Sie nur die Gesamtanzahl ermitteln, aber keine einzelnen Datensätze erhalten möchten, verwenden Sie den Wert -1. |
| StartIndex | 0 |
Legen Sie fest, ab welchem Datensatz die Ergebnisse in der Antwort zurückgegeben werden. Dieser Parameter ist nullbasiert (das erste Element wird mit dem Wert 0 angesprochen). |
Beispiel
Die folgende Anfrage gibt 50 Identitäten zurück und beginnt dabei bei der 101. Identität:
https://<Host-Name>/ApiServer/portal/person?PageSize=50&StartIndex=100
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Nutzungsbedingungen Datenschutz Cookie Preference Center