Importing API Definition

This article explains how API definitions can be imported from local files or URLs into the Element Repository to automatically create Webservice elements and streamline API configuration.

You can import API Definition into the Element Repository using following options:

Create Folder (+) icon
Ellipsis (...) icon

Importing API Definition using Create Folder (+) Icon

To Import API Definition in Element Repository using Create Folder (+) icon, perform the following actions:

On the Home page, under Projects, select the required Project.
Select Design Studio. In the Element Repository page, locate the Create Folder (+) icon.
Select Create Folder (+) icon and select Create new folder to create a new folder for element repository. A new folder is created.
In the New Folder text box, enter the element repository folder name.

Select the newly created element repository folder and select Create Folder (+) icon.
From the menu options, select Import API Definition. The Import API Definition dialog box appears.

You can import API definition using the following options:
- File
- URL

File

To import an API definition using File option, perform the following actions:

In the Import API Definition dialog box, select the Upload JSON File button.
Select the appropriate JSON File from your local system.
Select the Import API to import the selected JSON File.

After the API definition is imported, it appears in the Element Repository page.

URL

To import an API definition using URL option, perform the following actions:

In the Source label text box, enter the API endpoint URL.
From the Protocol dropdown, select the required protocol.

Note:

When using SOAP service, make sure to enter ?WSDL at the end of URL entered in Source label text box which automatically selects prototype as WSDL. For example: https://ecs.syr.edu/faculty/fawcett/code/calcWebService/Calc.asmx?WSDL
When using Rest service, Swagger protocol must be selected.

Select Import API button to import API Definition.

After the API definition is imported, it appears in the Element Repository page.

Select the send button to execute the imported API definition.

After executing the API request, you can go to Response tab to view the result. To learn more, click here.

Select the save button to store the configuration as a Webservice element.

Importing API Definition using Ellipsis (...) Icon

To Import API Definition in Element Repository by selecting ellipsis (...) icon, perform the following actions:

In Element Repository page, select the parent folder in which you want to import the API definition.
Select the ellipsis (...) icon corresponding to that folder.
From the menu options, select Import Definition. The Import API Definition dialog box appears.

You can import API definition using the following options:
- File
- URL