- sara.next
- Technologia
- Skrypty REST: format odpowiedzi i przykład
Technologia · Dokumentacja
Skrypty REST: format odpowiedzi i przykład
Skrypt REST opisuje żądanie HTTP, które sara.next wyśle do systemu docelowego przez skonfigurowane połączenie. Zwraca mapę z metodą, ścieżką i opcjonalnie treścią oraz nagłówkami.
- Groovy
- REST
- przykład
Zasady
Co zwraca skrypt implementacyjny
Skrypty Create, Replace, Modify i Delete zwracają mapę Map<String, Object> z następującymi kluczami.
| Klucz | Typ | Wymagany | Opis |
|---|---|---|---|
method | String | Tak | Metoda HTTP: GET, POST, PUT, PATCH, DELETE |
path | String | Tak | Ścieżka względna, dołączana do adresu baseUrl połączenia |
body | String | Nie | Treść żądania, np. napis JSON |
headers | Map<String, String> | Nie | Dodatkowe nagłówki żądania |
Skrypt weryfikujący zwraca mapę w tym samym formacie — zwykle jest to żądanie GET. Wynik: true, jeśli odpowiedź HTTP ma status 2xx; w przeciwnym razie false.
Przykład
Pełny przykład: REST Demo
Przykład zakłada rolę z wymiarami RESOURCE (zasób) i PERMISSIONS (lista uprawnień rozdzielona przecinkami). Gdy wymiar nie ma wartości, skrypt przyjmuje default i read.
UwagaEndpoint /accesses należy do przykładowego systemu docelowego — nie jest to API sara.next. Wartości wstawiane do ścieżki i treści żądania powinny być walidowane zgodnie z modelem danej aplikacji.
Skrypt Create
Żądanie POST tworzy przypisanie dla loginu, zasobu i listy uprawnień.
String login = user.samAccountName
String resource = dimensions["RESOURCE"] ?: "default"
String perms = dimensions["PERMISSIONS"] ?: "read"
def permList = perms.split(",").collect { '"' + it.trim() + '"' }.join(",")
[method: "POST", path: "/accesses",
body: '{"login":"' + login + '","resource":"' + resource + '","permissions":[' + permList + ']}']Skrypt Modify
Żądanie PUT zmienia listę uprawnień istniejącego przypisania.
String login = user.samAccountName
String resource = dimensions["RESOURCE"] ?: "default"
String perms = dimensions["PERMISSIONS"] ?: "read"
def permList = perms.split(",").collect { '"' + it.trim() + '"' }.join(",")
[method: "PUT", path: "/accesses/" + login + "/" + resource,
body: '{"permissions":[' + permList + ']}']Skrypt Delete
Login pochodzi z oldUser, a zasób z poprzednich wartości wymiarów odczytanych z request.oldAtar.
String login = oldUser.samAccountName
def oldDims = [:]
request.oldAtar?.dimensionValues?.each { dv ->
if (dv.dimension != null) oldDims[dv.dimension.systemName] = dv.value
}
String resource = oldDims["RESOURCE"] ?: "default"
[method: "DELETE", path: "/accesses/" + login + "/" + resource]Skrypt Verify
Żądanie GET sprawdza, czy przypisanie istnieje. Status 2xx oznacza true; dla wniosku Delete wynik jest odwracany przez harmonogram.
String resource = dimensions["RESOURCE"] ?: "default"
[method: "GET", path: "/accesses/" + login + "/" + resource]Odpowiedź 2xx potwierdza, że endpoint odpowiedział. W systemach, które wykonują zmiany asynchronicznie, warto rozważyć, czy weryfikacja powinna następować natychmiast.
Czytaj dalej
Powiązane dokumenty
Przygotuj skrypty REST z naszym zespołem
Sprawdzimy API systemu docelowego i sposób weryfikacji zmiany.