Page Comparison

You can configure the API for the API to 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 typedata from other services.

To Configure the API

1. Select Service Automation Orchestration > New API ConfigurationsConfiguration. The  The API ConfigurationsCONFIGURATION page is displayed with a list of pre-populated APIs.
   Image Removed
   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.

2. Select a specific API row and click on it. API Configurations page is displayed.
3. Specify the required details.
   Image Removed
   Figure: API Configurations
   On the Dynamic Payload Values. 
   
   Image Added
   
   
4. Specify the required details to configure the API.
5. Click TEST button.
6. On the PAYLOAD pop-up page, specify the parameter values, and click Testclick TEST button.
7. Click Save SUBMIT. The API is configured.

Field Description

The following table describes the fields on the API CONFIGURATION page:

Specify the data source name.

Active

Specify the URL. Click Validate to check the validity of the URL.

Method Settings

Select the method type. Available options are as follows:

Select the method type. Available options are as follows:

Specify the key.

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:

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 Image Removed icon, Filters Pop-up page is displayed.
Image Removed

Figure: Filters Pop-up page

Field Description

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.