Operacje na instancji elementów

Zakładka Dostęp do elementów procesu umożliwia zdefiniowanie operacji, które mają być wykonane na elementach procesu poprzez wywołanie skonfigurowanego endpointa API. Oznacza to, że dane z formularzy w WEBCON BPS mogą być odczytywane, zmieniane lub uzupełniane z poziomu zewnętrznych aplikacji – bez potrzeby logowania się do samego systemu. W ramach konfiguracji API określa się zakres danych podlegających operacji oraz sposób ich mapowania.

Dostępne są następujące typy operacji:

1. Pobieranie danych – umożliwia odczyt danych wskazanego elementu po podaniu jego ID w wywołaniu endpointa, np.: https://webcon.bps/api/udef/db/1/MyEndpoint/123

• Obsługiwane wywołania: GET
• Zakres zwracanych danych definiuje się w zakładce Dane elementu.
• Dane mogą obejmować atrybuty formularza, Listy pozycji oraz wartości z systemowych pól: komentarzy oraz Kolekcji załączników.
• Każda wartość jest mapowana do pola Nazwa, które będzie używane w odpowiedzi API.
• Dane zwracane są w formacie JSON, np.:

{
    "Data":
    {
        "Field1": "value1",
        "ItemsList": 
        [
            "value1","value2"
        ]
    }  
}

 

W przeciwieństwie do Pobierania danych trzy poniższe operacje służą do przesyłania danych do BPS. W przypadku każdej z nich:

• Zakres danych konfiguruje się w zakładce Dane żądania.
• Można mapować wartości żądania na atrybuty formularza oraz Listy pozycji.
• System umożliwia również mapowanie wybranych pól systemowych, takich jak pola komentarza na instancji elementu oraz atrybuty Kolekcji załączników do utworzenia w ramach operacji.

2. Zapis elementu – umożliwia aktualizację wartości elementu na podstawie danych przesłanych w treści żądania (np. zmiana statusu, dodanie komentarza). Aby wskazać element, należy w wywołaniu endpointa podać jego ID, np.: https://webcon.bps/api/udef/db/1/MyEndpoint/123

• Obsługiwane wywołania: PATCH
• Przykładowa struktura żądania:

{ 
  "Field1": "value1", 
  "ItemsList": [ 
    { 
      "ItemsList": "value1" 
    } 
  ] 
} 

3. Start obiegu – umożliwia uruchomienie nowej instancji elementu zgodnie z konfiguracją w Studio. W definicji należy wskazać obieg dokumentów, typ formularza, ścieżkę startową oraz spółkę, dla której instancja ma zostać uruchomiona. Przykładowy endpoint, który można wywołać: https://bpsod.webcon.pl/5790/api/udef/db/1/start/

• Obsługiwane wywołania: POST

4. Przejście ścieżką – umożliwia wykonanie przejścia ścieżką w istniejącej instancji elementu (np. akceptacja, odrzucenie). Można również przekazać w treści żądania dane, które zostaną ustawione na elemencie. W tym celu w adresie endpointa należy podać ID elementu oraz dodatkowy sufiks adresu URL odpowiadający ścieżce przejścia, np.: https://bpsod.webcon.pl/5790/api/udef/db/1/myendpoint/{Id}/go

• Obsługiwane wywołania: PATCH