Page History

...

Polish

Info
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.).

Info
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 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

jsonPath

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" oraz w przypadku gdy parametr "Szablon" jest pusty - 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
W przypadku parametru typu "Parametr Header" zdefiniowane id zostanie użyte jako klucz w nagłówku wysyłanego żądania

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

Parametr URL - parametr zostanie przekazany w adresie URL.

Parametr Body - parametr zostanie przekazany w ciele żądania.

Parametr Header - parametr zostanie przekazany w nagłówku żądania.

Warning
Parametrów typu "Parametr Body" nie należy dodawać do żądań typu "GET"!

Ścieżka w formacie jsonPath określająca docelowy element tablicowy struktury JSON, w którym zostaną powielone lub rozpakowane wartości wejściowych parametrów tabelarycznych.

Opcjonalny

Parametry wyjściowe

Id parametrów wyjściowych

Nazwy parametrów wyjściowych

Klucz

Żródło

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

Image Modified

W przypadku źródła typu "Parametr Header", w polu podajemy nazwę klucza z nagłówka odpowiedzi.

Parametr Body - wartość zostanie pobrana z "ciała" wiadomości odpowiedzi według podanego klucza (parametr "Klucz");
Parametr Header - wartość zostanie pobrana z nagłówka wiadomości odpowiedzi według podanego klucza;

Warning
W przypadku wyboru "Parametr Body" w polu "Klucz" należy podać ścieżkę do parametru w formacie jsonPath.

Opcjonalny

Szablon

Szablon wejściowy w formacie JSON, który zostanie przekazany w treści wiadomości wysyłanej. Wartości parametrów podanych w klamrach, np.: "{param1}" zostaną zastąpione wartościami parametrów wejściowych o danym id (w tym przypadku: param1).

Jeżeli parametr podany w klamrach znajduje się w obiekcie (JSON object) w strukturze listy w szablonie JSON oraz został dla niego określony element tablicowy w definicji parametru wejściowego (parametr jsonPath) a także jeśli parametr wejściowy jest typu tabelarycznego to obiekt do którego należy parametr w klamrach w szablonie JSON zostanie powielony tyle razy ile wynosi długość przekazanej tablicy parametru wejściowego.

Jeżeli parametr podany w klamrach znajduje się w tablicy(JSON array) w strukturze listy w szablonie JSON oraz został dla niego określony element tablicowy w definicji parametru wejściowego (parametr jsonPath) a także jeśli parametr wejściowy jest typu tabelarycznego to tablica do której należy parametr w klamrach w szablonie JSON zostanie wypełniona wartościami z tablicy parametru wejściowego.

Info
Jeśli szablon pozostanie pusty to jako treść wiadomości wysyłanej zostanie wygenerowany prosty schemat JSON w formacie: "{"{param1}":"param1_wartoscwartość"}" zgodnie z przekazanymi parametrami wejściowymi.

Opcjonalny

Separator zmiennych tabelarycznych

Znak tekstowy określający separator danych w tabelarycznych parametrach wejściowych.

Wartość domyślna: ";"

Wymagany

Przykłady konfiguracji:

Info

title	Przykład konfiguracji

Przykładowa konfiguracja, wykorzystująca publiczne API https://api.publicapis.org/:

View file

name	DS_rest_publicapis.json
height	150

Konfiguracja źródła

Wynik wywołania

Odpowiedź API

Opis

Code Block

language	js

{
  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

Code Block

language	js

{
  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")

English

Info
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 datasources 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.).

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

Configuration description:

Name of the parameter

Description

Optionality

Authorization

Request authorization scheme. If the requested endpoint does not require authorization, leave the field blank. Description of defining authorization templates is HERE.

Optional

Additional headers

The parameter allows adding additional headers to the request. The parameter can be used, for example, to force a response from the API in JSON format. In this case, add a row in the described parameter and enter "Accept" in the "Header" field, and "application/json" in the "Value" field.

A properly configured API should return data in JSON format on request with the above header or reply with an error in case this request cannot be answered in JSON format.

Optional

HTTP method

List of HTTP protocol methods. Available methods: GET, HEAD, POST, PUT, DELETE, PATCH. Choose the required request method according to the API documentation.

Required

URL

Endpoint URL to which the request will be sent. If you call an action from the API of the same PlusWorkflow system in which the datasource is configured, the URL must contain the domain "localhost".

Required

Content-Type

The parameter allows defining the format of the data transferred in the body of the request. The parameter is used only if the "Parameters Body" type parameters are among the input parameters. In other cases the value of this parameter does not matter.

Required

Input parameters

Input parameters id

Input parameters names

Input parameters types

Specifies the id of the input parameters.

In the case of a "URL param" parameter, you must substitute the defined id in the URL of the request in the {id} format, e.g.. http://localhost/{parametr}
In the case of a "Body param" parameter, the defined id will be used as the key of the transmitted data in the body of the request
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#multipartform-data

Specifies the display name of the input parameters

URL param - the parameter will be passed in the URL

Body param - the parameter will be passed in the request body

Warning
Parameters of type "Body param" should not be added to requests of type "GET"!

Optional

Output parameters

Output parameters id	Output parameters names	JsonPath
Specifies the id of the output parameters used in mapping	Specifies the display name of the output parameters	A path (similar to XPath) used to extract data from the resulting JSON. Documentation for using JsonPath - https://github.com/json-path/JsonPath

Optional

Configuration samples:

Datasource configuration

Result of query

API response

Description

Code Block

language	js

{
  success: true,
  message: "user was   created"
}

The source adds the user to the example.com API and responds with information about the success of the operation and a message from the server.

Datasource configuration

Result of query

API response

Description

Code Block

language	js

{
  data: [
    {
      ...,
      userName: "admin",
      ...
    },
    {
      ...,
      userName: "administrator",
      ...
    }
  ],
  total: 2
}

The datasource returns a list of PlusWorkflow system user names, containing the value passed in the "filter" parameter and the number of all results returned for each returned username.

(executed with following query param: filter="admin")

...

Versions Compared

Old Version 14

New Version 15

Key

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

Opis konfiguracji:

Przykłady konfiguracji:

The plugin contains the implementation of datasources operating on the RESTful API.

Configuration description:

Configuration samples: