Przejdź do głównej zawartości
Wersja: 2025 R2

Odczyt źródła danych

Zakładka Źródło danych umożliwia konfigurację źródła danych aplikacji, którego zawartość będzie dostępna do pobrania przez endpoint zdefiniowany w trybie Pobierz dane ze źródła danych.

Źródło danych

Wskazanie źródła oraz filtrowanie danych​

Źródło danych aplikacji, dostępne dla tego endpointu, należy wskazać w polu Źródło danych.
W polu Filtr można zdefiniować warunki zawężające zakres zwracanych danych. Domyślnie endpoint zwraca maksymalnie 1000 wierszy.

Filtr może wykorzystywać parametry zdefiniowane w zakładce Parametry, co pozwala na dynamiczne ograniczanie danych na podstawie wartości przekazywanych przy wywołaniu endpointa.
Wartości parametrów należy przekazać w query stringu. Nazwy parametrów w query stringu muszą być zgodne z nazwami zdefiniowanymi w zakładce Parametry, np.:

https://webconbps.com/api/udef/db/1/MyEndpoint?Param1=value1

Pobranie danych ze źródła podrzędnego​

Jeśli udostępnione źródło danych posiada źródła podrzędne definiowane dla spółek, do pobrania danych z konkretnego źródła podrzędnego należy użyć predefiniowanego parametru businessEntity. Parametr ten może przyjmować wartość: ID, GUID lub kod spółki. Dzięki temu możliwe będzie pobranie danych ze źródła przypisanego do wskazanej spółki.

https://webconbps.com/api/udef/db/1/MyEndpoint?businessEntity=82

Zakres zwracanych danych​

Zakres zwracanych danych, czyli kolumny przesyłane w odpowiedzi po wywołaniu endpointu, określa się w polu Zwracane kolumny. Nazwy kolumn w odpowiedzi odpowiadają wartościom wprowadzonym jako Nazwa wyświetlana w konfiguracji zwracanych kolumn. Wynik wywołania zwracany jest w formacie JSON. Dane wyjściowe są umieszczone w tablicy znajdującej się w węźle Data, np.:

{
    "Data":
    [
        {
            "Instance number": "744453",
            "Assigned to": "Tom Green",
            "Data rejestracji": "2025-04-28"
        }
    ]
}

Uprawnienia​

Jeśli udostępnionym źródłem jest Źródło BPS, zakres zwracanych danych jest dodatkowo ograniczany z uwzględnieniem uprawnień użytkownika, w kontekście którego nastąpiło wywołanie endpointu, do poszczególnych elementów w źródle.
W przypadku, gdy w konfiguracji źródła ustawiono opcję Dostęp do danych w kontekście konta systemowego lub gdy źródło jest innego typu, nieuwzględniającego uprawnień użytkownika, dostęp do danych nie jest ograniczany uprawnieniami do elementów.