REST Web Service

Funkcjonalność pozwala na wywołanie dowolnej metody Web Service'u opartego na architekturze REST i wykorzystanie zwracanych wartości jako źródła danych wewnątrz platformy WEBCON BPS. W konfiguracji źródła danych należy wskazać, m.in. adres URL do zasobu Web Service'u, opcjonalne dodatkowe nagłówki oraz – w przypadku metod HTTP, takich jak POST/PUT/PATCH – opcjonalną treść żądania (request body) w formacie JSON.

Po dokonaniu wstępnej konfiguracji w zakładce Odpowiedź możliwe jest pobranie struktury odpowiedzi (przycisk Wczytaj) i wskazanie kolekcji danych, która będzie używana przez źródło danych.

Wszelka parametryzacja wywołania opiera się na użyciu znaczników w treści żądania JSON lub w parametrach dopisywanych w adresie URL (metody GET/DELETE). Źródło danych REST Web Service wspiera także wyszukiwanie w polu wyboru z wyszukiwaniem.

Obsługa większości usług Web Service oraz zapewnienie dwóch trybów filtrowania pozwala na obsługę większości scenariuszy integracji z systemami zewnętrznymi poprzez wykorzystanie wyłącznie konfiguracji WEBCON BPS Designer Studio bez implementacji źródeł danych SDK.

1. ID

Identyfikator źródła danych (jeżeli wartość jest mniejsza od „0”, oznacza to, że źródło nie zostało jeszcze zapisane w bazie).

2. Nazwa

Nazwa źródła danych wprowadzona przez użytkownika.

3. Źródło nadrzędne

Każde ze źródeł danych może zawierać źródła zależne powiązane z daną spółką. W przypadku odwołania do źródła nadrzędnego z elementu obiegu wykonywane jest zapytanie zdefiniowane w źródle zależnym (o ile źródło nadrzędne zawiera źródło zależne ze spółką, do której należy element). Jeżeli dla źródła określono źródło nadrzędne, wymagane jest również podanie spółki, dla której jest ono zdefiniowane.

4. Spółka

Spółka, do której należy zdefiniowane źródło. Jeżeli dla źródła określono spółkę, wymagane jest również podanie źródła nadrzędnego.

5. Typ źródła

Typ aktualnego źródła danych. Określa miejsce skąd pobierane są dane.

6. Połączenie

Służy do definiowania autoryzacji dostępu do bazy danych.

7. Opis

Opis źródła danych zdefiniowany przez użytkownika.

8. Źródło zawiera dane osobowe

Opcja pozwala wskazać, czy źródło danych jest źródłem danych osobowych dla innych procesów. Powiązanie miedzy słownikiem danych osobowych a konkretnym procesem korzystającym i przechowującym kopie danych osobowych konfigurowane jest dodatkowo dla każdego atrybutu oznaczonego jako przechowujący dane osobowe. Tak określone powiązanie pozwala prześledzić, z jakiego elementu słownika danych osobowych atrybut zaczerpnął wartość. Dzięki temu akcje, które usuwają i modyfikują (anonimizują) dane osobowe, mogą odnaleźć wszystkie miejsca, w których zaczerpnięto dane ze wskazanego elementu słownika.

Skonfigurowanie źródła danych jako źródła danych osobowych wymaga dodatkowo wskazania, która kolumna ze źródła będzie traktowana jako unikalny identyfikator osoby w tym źródle. Zaleca się, aby kolumna ta zawierała unikalne, numeryczne identyfikatory bazodanowe.

9. Identyfikator danych osobowych

Pole pozwala wskazać unikalny identyfikator w postaci kolumny bazy danych.

10. Środowisko testowe

Wybór środowiska, w kontekście którego zostanie wykonany test źródła danych w edytorach oraz wczytanie odpowiedzi.

11. Dane żądania

Zakładka umożliwia wpisanie adresu URL danego zasobu, wybranie metody protokołu HTTP, jak również ustawienie niestandardowych nagłówków.

• Suffix żądania URL – przyrostek dodawany do adresu URL bazowej instancji serwisu. Określenie przyrostka umożliwia dynamiczne modyfikowanie adresu URL żądania, np. poprzez dodanie dodatkowych ścieżek lub parametrów.
• Typ metody HTTP – parametr określa, jakiego rodzaju operacja zostanie wykonana na wskazanym endpoincie API.
• Na podstawie Swaggera – pole umożliwia automatyczne zaimportowanie struktury API na podstawie pliku Swagger.
• Parametry – przy wyborze żądania opartego na dokumentacji Swagger możliwe jest przypisanie parametrów URL. Parametry są wczytywane automatycznie w oparciu o strukturę dokumentacji (możliwe jest także dodanie ich ręcznie). Typy parametrów dzielą się ze względu na ich lokalizację: Path: /users/{id}, Query: /users?role=admin. Parametry nieposiadające wartości będą pomijane przy żądaniu.
• Dodatkowe parametry nagłówka – pole umożliwia dodanie niestandardowych nagłówków HTTP do wysyłanych zapytań. Nagłówki takie mogą zawierać dodatkowe informacje o żądaniu, które są wymagane przez serwer API. Za pomocą nagłówków możliwa jest, m.in. obsługa niestandardowych wymagań API, określanie formatu danych, czy też uwierzytelnianie.
• Tryb filtrowania – pole umożliwia określenie sposobu filtrowania danych. Wybranie opcji Po stronie BPS skutkuje pobraniem wszystkich danych ze źródła, a następnie zastosowaniem filtrowania, z kolei opcja Po stronie web serwisu skutkuje przesłaniem wartości filtra do web serwisu i pobraniem wyłącznie przefiltrowanych danych.