Chatee ahora con Soporte
Chat con el soporte

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

Abfrage zusätzlicher Parameter

Mithilfe des Abfrage-Parameters withProperties können Sie festlegen, welche zusätzlichen Informationen aus bestimmten Tabellenspalten in der zurückgegebenen Antwort enthalten sein sollen.

HINWEIS: Um Tabellenspalten für diese Abfragen freizugeben, aktivieren Sie im Designer für die entsprechenden Spalten in den Spalteneigenschaften die Option Anzeige in Assistenten.

TIPP: Sie können die Namen mehrerer Spalten kommasepariert angeben.

Beispiel

Die folgende Anfrage ermittelt die Menge aller Identitäten und gibt zusätzlich deren bevorzugten Namen und Titel zurück:

https://<Host-Name>/ApiServer/portal/person/all?withProperties=PreferredName,Title

Antwort:

{
    "TotalCount": 105950,
    "TableName": "Person",
    "Entities": [
        {
            "Display": "100, User (USER1)",
            "LongDisplay": "100, User (USER1)",
            "Keys": [
                "bbf3f8e6-b719-4ec7-be35-cbd6383ef370"
            ],
            "Columns": {
                "DefaultEmailAddress": {
                    "Value": "USER1@qs.ber",
                    "IsReadOnly": true
                },
                "IdentityType": {
                    "Value": "Primary",
                    "IsReadOnly": true,
                    "DisplayValue": "Primary identity"
                },
                "PreferredName": {
                    "Value": "Johnny",
                    "IsReadOnly": true
                },
                "Title": {
                    "Value": "Dr.",
                    "IsReadOnly": true
                },
                "XObjectKey": {
                    "Value": "<Key><T>Person</T><P>bbf3f8e6-b719-4ec7-be35-cbd6383ef370</P></Key>",
                    "IsReadOnly": true
                }
            }
}

Typsichere Klassen

Verwenden Sie die typsichere Klassen, um das Datenbankmodell typsicher zu verwenden. Daraus ergeben sich folgende Vorteile:

  • Beim Kompilieren der Skripte wird geprüft, ob die verwendeten Klassen korrekt sind. Dadurch erkennen Sie bereits sehr früh Tippfehler in Tabellen- und Spaltennamen.

  • Die Entwicklungsumgebung kann eine automatische Vervollständigung anbieten.

  • Der Datentyp der Spalten ist bekannt, wodurch Typkonvertierungsfehler vermieden werden.

Um typsichere Klassen zu verwenden

  1. Bearbeiten Sie das entsprechende API-Plugin (siehe API-Plugins bearbeiten) und nehmen Sie dabei folgende Aktion vor:

    • Fügen Sie eine Referenz auf die Bibliothek für typsichere Klassen des entsprechenden Datenbankmoduls hinzu (zum Beispiel AOB.TypedWrappers.dll).

      Die Klassen für dieses Modul sind daraufhin im Namensraum <Modulname>.TypedWrappers verfügbar (zum Beispiel AOB.TypedWrappers).

Benutzerdefinierte Methoden

Benutzerdefinierte Methoden sind Methoden, deren Abarbeitung, Eingabe- und Ausgabedaten Sie im Code vollständig definieren. Dieser Typ bietet daher die größte Flexibilität.

Beispiele zur Definition von benutzerdefinierten Methoden finden Sie im SDK unter Sdk01_Basics\03-CustomMethod.cs.

SQL-Methoden

SQL-Methoden sind Methoden, die Daten aus einer vordefinierten SQL-Abfrage über die API zur Verfügung stellen. Die Parameter einer Anfrage legen Sie als SQL-Parameter an.

Beispiele zur Definition von SQL-Methoden finden Sie im SDK unter Sdk01_Basics\02-BasicSqlMethod.cs.

Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación