Configure WebAPI
It allows you to configure REST, SOAP and BAPI APIs (Application
Programming Interface) in Automation Studio.
To configure a windows application:
1. In
the Admin menu, click
the (Add
Application) icon to add an application. The Add
Application dialog box appears.

2. In
the Application Type list,
select WebAPI.
3. In
the Application Name field,
enter a desired name of the windows application you want to add.
The name must not contain any special character or space.
4. Click
ADD. A message for successful
addition of the application is displayed.
5. Close
the displayed message and enter the following details in the Application Properties pane. Mandatory
fields are highlighted in a red box.
Property Name |
Usage |
Details |
Login URL |
The login URL of the API
you want to access. This is a mandatory field.
Note:
Do not provide the input path or the query parameter to
the URL of the REST API added to Automation Studio. |
SignIn |
Signifies if sign in for
the application is required. |
Type |
The type of API added.
Available options are:
· BAPI
· REST
· SOAP |
Display |
Application Description |
A small description of
the application added. |
Display Name |
The desired name of the
application entered by the use. This is a mandatory
field. |
General |
Application Name |
Name of the API entered
at the time of adding the application. It auto populates
as per the name of the application entered while configuring
the application. |
Misc |
Is Application Tracked |
Is applicable only for
AssistEdge Engage.
Signifies if the application
is tracked for time spent by Engage during the process
execution. It used for activity
tracking report and tracking time spent on each application
in the execution dashboard
reports. By default, it is selected and can be edited. |
6. Click
the (Save Properties)
icon to save the application.
The API is configured.
|