RESTful API datasources

JAR -

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ść

Autoryzacja

Schemat 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łówki

Parametr 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 HTTP

Lista metod protokołu HTTP. Dostępne metody: GET, HEAD, POST, PUT, DELETE, PATCH. Należy wybrać wymaganą metodę żądania zgodnie z dokumentacją API.

Wymagany

URL

Adres 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-Type

Parametr 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.

W przypadku parametru typu "Paramter URL" należy podstawić zdefiniowane id do adresu URL żądania w formacie {id} np. http://localhost/{parametr}
W przypadku parametru typu "Parametr Body" zdefiniowane id zostanie użyte jako klucz przekazywanych danych w ciele żądania
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#multipartform-data

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 mappingu	Okreś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")

DSREST-1 - Getting issue details... STATUS