API Configurations

You can configure the API for POST or GET methods by providing details such as data source name, service URL, type of request, and the request payload. To configure the Service Automation in Summit, we need to get the data from Summit. Information such as incident details, Service Request, Custom attributes, customer names and location names can be configured as API in the API Configurations screen. It displays the total API configurations along with individual count for the specific method type.

To Configure the API:

Perform the following steps to configure the API:

Select Service Automation > API Configurations. The API Configurations page is displayed with a list of pre-populated APIs.

Figure: API Configurations

Field Description

Field	Description
Date Sources
Data Source Name	Displays the data source name.
Method Type	Displays the method type. Available options are as follows: POST GET
Content Type	Displays the content type. Available options are as follows: Application/json
Active	Displays the status as True if it is active
Created By	Displays the name of the user who has created the API.
Last Updated By	Displays the name of the user who has last updated the API.
Last Updated Date	Displays the date on which the API was last updated.

Select a specific API row and click on it. API Configurations page is displayed.
Specify the required details.

Figure: API Configurations
On the Dynamic Payload Values, specify the parameter values, and click Test.

Click Save. The API is configured.

Field	Description
Data Source Name	Specify the data source name.
Active	Select Active to enable the API as active.
URL	Specify the URL. Click Validate to check the validity of the URL.
Method Settings
Method Type	Select the method type. Available options are as follows: POST GET
Content Type	Select the method type. Available options are as follows: Application/json
Headers
Key	Specify the key.
Value	Specify the value.
Action	Specify the action.
Payload	Displays the payload values.
Dynamic Payload Values	Parameters are dynamic and depends on the API Payload. Specify the parameter values to test the API. Few examples of parameters are as follows: Tenant Module Code Source Type Catalog ID Category ID

Import: Click Import icon. Available options are as follows:

Import from Existing – It displays the list of already configured APIs. Select the specific API and click Import. With minor configurations modifications, you can create a new API from the existing APIs.
Import from External Directory – The json file exported under Export to External Directory, gets imported here.

Export: Click Export icon. Available options are as follows:

Export to New – It creates a copy of the existing configuration with minor modifications, a new API can be created.
Export to External Directory – It exports the new configured API in json file.

View Response: Click View Response icon to display the status and output you get from the API call while providing values and performing test under Dynamic Payload Values.

Filters Pop-up

Click icon, Filters Pop-up page is displayed.

Figure: Filters Pop-up page

Field Description

The following table describes the fields on the Filters Pop-up page:

Field	Description
Load Filters	Select to view the available filters.
Data Source Name	Specify the filter value for Data Source column.
Created By	Specify the filter value for Created By column.
Created Date	Specify the filter value for Created Date Source column.
Last Updated By	Specify the filter value for Last Updated By column.
Last Updated Date	Specify the filter value for Last Updated Date column.
Apply	Click Apply to apply the mentioned filters and the filtered APIs gets displayed in API List page.
Clear	Click Clear to delete the selected filters.
Save/Update Filters	You can provide a name to the multiple filters. Click Save/Update filter to save it and later you can view it under Load Filters.

API Configurations

To Configure the API:

Release Notes | Installation Guide | Other Documents