JAR - 

Instrukcja tworzenia źródeł danych w systemie - http://192.168.1.52:8081/confluence/pages/viewpage.action?pageId=13272439

Wtyczka zawiera implementację źródeł danych operujących na RESTful API.

Za pomocą opisywanych źródeł danych można odczytywać i przekazywać dane pomiędzy systemem PlusWorkflow a zewnętrznym API z wykorzystaniem metod protokołu HTTP (GET, POST itd.).

Istnieje również możliwość komunikacji z wewnętrznym API systemu. W takim przypadku w adresie URL należy użyć domeny "localhost"

 

Opis konfiguracji:

Nazwa parametruOpis parametruWymagalność
AutoryzacjaSchemat autoryzacji żądania. Jeśli żądany endpoint nie wymaga autoryzacji pole należy zostawić puste. Opis definiowania szablonów autoryzacji znajduje się TUTAJ.Opcjonalny
Dodatkowe nagłówkiParametr pozwala na dodanie dodatkowych nagłówków do żądania. Parametr można wykorzystać np. do wymuszenia odpowiedzi z API w formacie JSON. W takim wypadku należy dodać wiersz w opisywanym parametrze i w polu "Nagłówek" podać wartość "Accept", natomiast w polu "Wartość" podać "application/json".


Poprawnie skonfigurowane API na żądanie z powyższym nagłówkiem powinno zwrócić dane w formacie JSON lub odpowiedzieć błędem w przypadku, gdy na to żądanie nie można odpowiedzieć w formacie JSON.		Opcjonalny
Metoda HTTPLista metod protokołu HTTP. Dostępne metody: GET, HEAD, POST, PUT, DELETE, PATCH. Należy wybrać wymaganą metodę żądania zgodnie z dokumentacją API.Wymagany
URLAdres URL endpointu, do którego wysłane zostanie żądanie. W przypadku wywołania akcję z API tego samego systemu PlusWorkflow, w którym skonfigurowane jest źródło adres URL musi zawierać domenę "localhost".Wymagany
Content-TypeParametr pozwala na zdefiniowanie formatu danych przekazywanych w ciele żądania. Parametr jest stosowany tylko, gdy wśród parametrów wejściowych znajdują się parametry typu "Parametr Body". W pozostałych przypadkach wartość tego parametru nie ma znaczenia.Wymagany
Parametry wejściowe
Id parametrów wejściowychNazwy parametrów wejściowychTypy parametrów wejściowych

Określa id parametrów wejściowych.

Określa wyświetlaną nazwę parametrów wejściowych

Parametr URL - parametr zostanie przekazany w adresie URL

Parametr Body - parametr zostanie przekazany ciele żądania

Parametrów typu "Parametr Body" nie należy dodawać do żądań typu "GET"!
Opcjonalny
Parametry wyjściowe
Id parametrów wyjściowychNazwy parametrów wyjściowychJsonPath
Określa id parametrów wyjściowych używane w mappinguOkreśla wyświetlaną nazwę parametrów wyjściowychŚcieżka (podobna do XPath) służąca do wyodrębnienia danych z wynikowego JSON-a. Dokumentacja korzystania z JsonPath - https://github.com/json-path/JsonPath

Opcjonalny

Przykłady konfiguracji:

 

Konfiguracja źródłaWynik wywołaniaOdpowiedź APIOpis
{
  success: true,
  message: "user was   created"
}
Źródło dodaje użytkownika do API example.com i w odpowiedzi wyświetla informację o sukcesie operacji oraz wiadomość z serwera.
Konfiguracja źródłaWynik wywołaniaOdpowiedź APIOpis
{
  data: [
    {
      ...,
      userName: "admin",
      ...
    },
    {
      ...,
      userName: "administrator",
      ...
    }
  ],
  total: 2
}

Źródło zwraca listę nazw użytkowników systemu PlusWorkflow, zawierających wartość przekazaną w parametrze "filter" oraz liczbę wszystkich zwróconych wyników przy każdej zwróconej nazwie użytkownika.


(Wywołanie dla filter="admin")

Instructions for creating data sources in the system - http://192.168.1.52:8081/confluence/pages/viewpage.action?pageId=13272439

The plugin contains the implementation of data sources operating on the RESTful API.

Described data sources allow for read and transfer data between the PlusWorkflow system and an external API using the HTTP protocol methods (GET, POST, etc.).

It is also possible to communicate with the PWFL system's internal API. In this case, use "localhost" in the URL

 

Configuration description:

Nazwa parametru
Opis parametru
Wymagalność
AutoryzacjaSchemat autoryzacji żądania. Jeśli żądany endpoint nie wymaga autoryzacji pole należy zostawić puste. Opis definiowania szablonów autoryzacji znajduje się TUTAJ.Opcjonalny
Dodatkowe nagłówkiParametr pozwala na dodanie dodatkowych nagłówków do żądania. Parametr można wykorzystać np. do wymuszenia odpowiedzi z API w formacie JSON. W takim wypadku należy dodać wiersz w opisywanym parametrze i w polu "Nagłówek" podać wartość "Accept", natomiast w polu "Wartość" podać "application/json".


Poprawnie skonfigurowane API na żądanie z powyższym nagłówkiem powinno zwrócić dane w formacie JSON lub odpowiedzieć błędem w przypadku, gdy na to żądanie nie można odpowiedzieć w formacie JSON.		Opcjonalny
Metoda HTTPLista metod protokołu HTTP. Dostępne metody: GET, HEAD, POST, PUT, DELETE, PATCH. Należy wybrać wymaganą metodę żądania zgodnie z dokumentacją API.Wymagany
URLAdres URL endpointu, do którego wysłane zostanie żądanie. W przypadku wywołania akcję z API tego samego systemu PlusWorkflow, w którym skonfigurowane jest źródło adres URL musi zawierać domenę "localhost".Wymagany
Content-TypeParametr pozwala na zdefiniowanie formatu danych przekazywanych w ciele żądania. Parametr jest stosowany tylko, gdy wśród parametrów wejściowych znajdują się parametry typu "Parametr Body". W pozostałych przypadkach wartość tego parametru nie ma znaczenia.Wymagany
Parametry wejściowe
Id parametrów wejściowych
Nazwy parametrów wejściowych
Typy parametrów wejściowych

Określa id parametrów wejściowych.

Określa wyświetlaną nazwę parametrów wejściowych

Parametr URL - parametr zostanie przekazany w adresie URL

Parametr Body - parametr zostanie przekazany ciele żądania

Parametrów typu "Parametr Body" nie należy dodawać do żądań typu "GET"!
Opcjonalny
Parametry wyjściowe
Id parametrów wyjściowych
Nazwy parametrów wyjściowych
JsonPath
Określa id parametrów wyjściowych używane w mappinguOkreśla wyświetlaną nazwę parametrów wyjściowychŚcieżka (podobna do XPath) służąca do wyodrębnienia danych z wynikowego JSON-a. Dokumentacja korzystania z JsonPath - https://github.com/json-path/JsonPath

Opcjonalny

 

Przykłady konfiguracji:

 

Konfiguracja źródła
Wynik wywołania
Odpowiedź API
Opis
{
  success: true,
  message: "user was   created"
}
Źródło dodaje użytkownika do API example.com i w odpowiedzi wyświetla informację o sukcesie operacji oraz wiadomość z serwera.
Konfiguracja źródła
Wynik wywołania
Odpowiedź API
Opis
{
  data: [
    {
      ...,
      userName: "admin",
      ...
    },
    {
      ...,
      userName: "administrator",
      ...
    }
  ],
  total: 2
}

Źródło zwraca listę nazw użytkowników systemu PlusWorkflow, zawierających wartość przekazaną w parametrze "filter" oraz liczbę wszystkich zwróconych wyników przy każdej zwróconej nazwie użytkownika.

 

(Wywołanie dla filter="admin")