Dokumentacja API
API dab Nexus jest dostepne od wersji 1.20.
Czym jest API?
API (Application Programming Interface) to zestaw reguł pozwalajacych róznym aplikacjom programistycznym komunikowac sie ze soba, wymieniac dane, funkcjonalnosci oraz mozliwosci.
API Nexus umozliwia naszym klientom pobieranie informacji o Workspaces, zadaniach i uruchomieniach z dab Nexus, na przyklad do celów raportowych.
Jakie sa podstawowe funkcje API?
- Get: na przyklad pobranie zadania po ID lub parametru po Analytic Group ID
- Post: na przyklad utworzenie zadania lub anulowanie uruchomienia
- Put: na przyklad aktualizacja harmonogramu zadania lub wylaczenie zadania
- Delete: na przyklad usuniecie Workspace lub zadania
Czym jest Nexus API?
Publiczny interfejs Nexus API pozwala na programistyczny dostep do dab Nexus. Mozliwe jest zarzadzanie Workspaces, tworzenie lub planowanie zadan analitycznych, wywolywanie i Monitor uruchomien oraz rozwiazywanie identyfikatorów i parametrów obiektów.
API oferuje rózne funkcje:
- Pobierz jeden lub wszystkie Workspaces po ID, lub utwórz, zaktualizuj bądź usun Workspaces
- Pobierz zadanie po ID, utwórz nowe zadanie, zaktualizuj czas startu lub harmonogram, wylacz lub wlacz je albo usun zadanie
- Pobierz uruchomienie po ID lub Task ID albo anuluj je
- Pobierz rodzaje obiektów, takie jak SAP Connections, SQL Connections czy Parameter Tables po ich ID lub nazwie
- Pobierz wszystkie parametry na podstawie ich Analytic Group ID lub Extraction Package ID
Wszystkie endpointy sa szczególowo opisane w tej sekcji.
Jak polaczyc sie z Nexus API
Aby nawiazac polaczenie z API, bedzie potrzebny klucz API. Szczególowe informacje znajduja sie w tym artykule.
Kody statusów HTTP
| Kod | Krotki opis | Opis |
|---|---|---|
| 200 | OK | Wywolanie API przebieglo pomyslnie |
| 400 | Bad Request | Zadanie nie zostalo przyjete, czesto z powodu braku wymaganych parametrów |
| 401 | Unauthorized | Klucz API jest nieprawidlowy |
| 402 | Request Failed | Parametry byly prawidlowe, ale zadanie nie powiodlo sie |
| 403 | Forbidden | Klucz API nie posiada uprawnien do wykonania zadania |
| 404 | Not Found | Zasób nie istnieje |
| 409 | Conflict | Konflikt z innym zadaniem |
| 424 | External Dependency Failed | Nie udalo sie zrealizowac zadania ze wzgledu na blad zewnetrznej zaleznosci spoza Nexus |
| 429 | Too Many Requests | Wyslano zbyt wiele zapytan do API w krótkim czasie |
| 500 502 503 504 | Server Errors | Wystapil problem po stronie dab Nexus |