REST-API für Datenintegrationsdienst – Übersicht
Verwenden Sie die REST-API des Datenintegrationsdiensts, um REST-API-Anfragen an den Datenintegrationsdienst zu senden. Sie können die REST-API zum Automatisieren von Aufgaben in einer CI-/CD-Pipeline verwenden, wie z. B. Versionskontrollvorgänge, Anwendungsbereitstellung, Anwendungs-Updates und Tests.
Bestimmte REST-API-Anfragen akzeptieren eine Abfrage als Anfrageparameter. Bei den von der Abfrage zurückgegebenen Objekten handelt es sich um die Objekte, die von der Anfrage bearbeitet werden. Wenn Sie beispielsweise eine Anfrage zum Kennzeichnen von Objekten ausführen, geben Sie eine Abfrage an, die die zu kennzeichnenden Objekte bestimmt. In ähnlicher Weise können Sie eine Abfrage angeben, um einen bestimmten Satz an Entwurfszeitobjekten in einer Anwendungs-Patch-Archivdatei bereitzustellen.
Zum Erstellen einer Abfrage verwenden Sie Abfrageparameter, die die abzurufenden Objekte festlegen. Auf Grundlage der von Ihnen verwendeten Typen von Abfrageparametern, Operatoren und Klauseln können Sie spezifischere Abfragen erstellen.
Zur Anzeige der von Ihnen zu verwendenden REST-API-Anfragen und der Parameter für jede Anfrage greifen Sie über das Administrator Tool auf die REST-API-Dokumentation zu. Wenn Sie über den ROH-Dienst auf die REST-API-Dokumentation zugreifen, müssen Sie den Reverse-Proxy-Server aktivieren und dessen Eigenschaften konfigurieren. Weitere Informationen hierzu finden Sie unter
Eigenschaften des Reverse-Proxy-Servers.
In der folgenden Tabelle werden die verschiedenen Anfragekategorien beschrieben, die Sie beim Zugriff auf die REST-API-Dokumentation anzeigen können:
Kategorie | Beschreibung |
|---|
Objekte | Anfragen zum Durchführen von Vorgängen für Entwurfszeitobjekte. |
Anwendungen | Anfragen zum Durchführen von Vorgängen für Laufzeitobjekte in einer Anwendung. |
Zuordnungsdienst | Anfragen zum Durchführen von Vorgängen für bereitgestellte Zuordnungen. |
Dienstprogramme | Anfragen zum Ausführen von Dienstprogrammen für den Datenintegrationsdienst. Über die Dienstprogramme werden dem Datenintegrationsdienst erweiterte Kapazitäten bereitgestellt. Der Datenintegrationsdienst kann beispielsweise zwei Zuordnungen vergleichen und einen Bericht zurückgeben, in dem die Unterschiede dargestellt werden. |