REST/API

It is possible to connect to any kind of API that you have access to. The added Data Sources are visible in the Plugin Configuration under Data Sources Tab:

Open

Data Sources Tab

The possible actions for the data sources are:

• Edit Data Source

• Test Connection to the Data Source (see https://twinit.atlassian.net/wiki/spaces/JDA/pages/541098177/REST+API#Test-Connection for more details)

• Delete the Data Source

To add data source go to the tab “Data Sources”, click the “Add Data Source” button and choose Source type “Rest/API“:

Open

REST/API data source type

Fill the required field to save the Data Source:

Name

Enter the name of the data source, it will be used later in the “Field Configuration”.

URL

Enter the URL of the endpoint from where the data should be retrieved from.

For Example:

• https://test.com/users/

  • This URL can be used if Async Select is selected in Field Type in https://twinit.atlassian.net/wiki/spaces/JDA/pages/531235195. In this case, no additional parameter is needed to retrieve the data.

• https://test.com/users/{param}

• https://test.com/users?username={param}

  • If 'george' is typed into external async field, Unlimited Async External Data for Jira plugin will replace the data source URL {param} with 'george', and the resulting URL will be: https://test.com/users/george

Authentification

We support Basic Authentification and Authentification by Token.

• In case of Basic Authentication, please enter the username and password for the data source

• In case of a Token, please enter toke completely

  • The token usually is an alphanumeric string, e.g.: 27a63b41dw37ieem56n288msl109

Test Connection

With the Test button, it is possible to test the connection to the data source. After clicking “Test", a popup will show up and after clicking Test Connection button, the test will be run and the results will be displayed below:

In case the test is not successful, the error message will be displayed:

Save Data Source

After filling in the required information, click Save.

After saving, the REST/API data source will be added to the list. You can add as many data sources, as needed. You can delete the source by clicking the “Bin” icon, or edit the data source by clicking the “Pencil” icon.