API-Dokumentation
Die dab Nexus API ist ab Version 1.20 verfügbar.
Was ist eine API?
Eine API (Application Programming Interface) ist eine Sammlung von Regeln, die es verschiedenen Software-Anwendungen ermöglicht, miteinander zu kommunizieren und Daten, Funktionen sowie Funktionalitäten auszutauschen. Die Nexus API erlaubt es unseren Kunden, Informationen über Workspaces, Aufgaben und Ausführungen aus dab Nexus abzurufen, beispielsweise für Berichtszwecke.
Was sind die Hauptfunktionen einer API?
- Get: z.B. eine Aufgabe nach ID abrufen oder einen Parameter nach Analytic Group ID erhalten
- Post: z.B. eine Aufgabe erstellen oder eine Ausführung abbrechen
- Put: z.B. den Aufgabenplan aktualisieren oder eine Aufgabe deaktivieren
- Delete: z.B. einen Workspace oder eine Aufgabe löschen
Was ist die Nexus API?
Die öffentliche Nexus API ermöglicht den programmgesteuerten Zugriff auf dab Nexus. Sie kann verwendet werden, um Workspaces zu verwalten, analytische Aufgaben zu erstellen oder zu planen, Ausführungen zu starten und Monitor sowie Objekt-IDs und Parameter aufzulösen.
Die API bietet verschiedene Funktionen:
- Abrufen eines oder aller Workspaces nach ID sowie Erstellen, Aktualisieren oder Löschen von Workspaces
- Eine Aufgabe nach ID abrufen, eine neue Aufgabe erstellen, die Startzeit oder den Zeitplan aktualisieren, sie deaktivieren oder aktivieren oder die Aufgabe löschen
- Eine Ausführung nach ID oder Aufgaben-ID abrufen oder abbrechen
- Objekttypen wie SAP Connections, SQL Connections oder Parameter Tables nach deren ID oder Name abrufen
- Alle Parameter nach Analytic Group ID oder Extraction Package ID abrufen
Alle Endpunkte sind in diesem Abschnitt beschrieben.
Wie verbindet man sich mit der Nexus API
Für die Verbindung zur API benötigen Sie einen API-Schlüssel. Alle Informationen finden Sie in diesem Artikel.
HTTP-Statuscodes
| Code | Kurzbeschreibung | Beschreibung |
|---|---|---|
| 200 | OK | API-Aufruf wurde wie erwartet ausgeführt |
| 400 | Bad Request | Die Anfrage wurde nicht akzeptiert, oft wegen fehlender Pflichtparameter |
| 401 | Unauthorized | Der API-Schlüssel ist nicht gültig |
| 402 | Request Failed | Die Parameter waren gültig, aber die Anfrage konnte nicht erfolgreich ausgeführt werden |
| 403 | Forbidden | Der API-Schlüssel hat keine Berechtigungen für die Anfrage |
| 404 | Not Found | Die angeforderte Ressource existiert nicht |
| 409 | Conflict | Die Anfrage steht im Konflikt mit einer anderen Anfrage |
| 424 | External Dependency Failed | Die Anfrage konnte wegen eines Fehlers in einer externen Abhängigkeit zu Nexus nicht abgeschlossen werden |
| 429 | Too Many Requests | Zu viele Anfragen wurden in kurzer Zeit an die API geschickt |
| 500 502 503 504 | Serverfehler | Auf der Seite von dab Nexus ist ein Fehler aufgetreten |