Versions Compared

Old Version 1

changes.mady.by.user Piotr Teresiak

Saved on

compared with

New Version 2

changes.mady.by.user Piotr Teresiak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Image Added
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

Warning
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

Image Added
Opcjonalny

 

 

 

 

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

 

Image Added

Configuration description:

Name of the parameter
Description
Optionality
AuthorizationRequest authorization scheme. If the requested endpoint does not require authorization, leave the field blank. Description of defining authorization templates is HERE.Optional
Additional headersThe 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.

Image Added
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 methodList of HTTP protocol methods. Available methods: GET, HEAD, POST, PUT, DELETE, PATCH. Choose the required request method according to the API documentation.Required
URLEndpoint 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-TypeThe 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.

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 mappingSpecifies the display name of the output parametersA path (similar to XPath) used to extract data from the resulting JSON. Documentation for using JsonPath - https://github.com/json-path/JsonPath

Image Added
Optional