Manage API Configuration

Efficiently manage multiple API Configurations with flexible Edit, View, and Filter options.

View

You can view the list of configured API(s) using following options:

• Filters
• Search
• Edit

To view the list of configured API(s), perform the following steps:

1. Navigate to Design Studio > Select Application >  Service Management > Select Module > API Configuration.

The API Configuration list page is displayed. A sample screenshot is shown below:

Figure: List Page - Filters, Grid

For more information on the list page, refer to the table below. 

The above page displays the list of configured API(s). A specific list of API(s) can be viewed based on applied filter criteria.

Filters

You have the provision to apply filters on all of the columns or individual columns. This functionality allows you to control the exclusion or inclusion of specific data as per your requirement. You can now focus on relevant data and quickly identify the information required, leading to improved data organization and clarity.

You can apply the individual filters on all the columns. Also, you can arrange the rows in ascending order or descending order.

To apply filters on all the columns as well as on individual columns, perform the following steps:

1. On the API(s) list page, click Filters icon on the top left corner just above the list of forms.Figure: Filters
   
   
2. Specify the filter criteria based on your requirement. Select the Match All or Match Any option from the list to filter the data based on the condition selected. The Match All option is selected, by default.
   
   
3. Select the option to compare the data based on the conditions. Available options are as follows:
4. • Starts With
   • Contains
   • Not contains
   • Ends with
   • Equals
   • Not equals
   • Less than
   • Less than or equal to
   • Greater than
   • Greater than or equal to
   • Date is 
   • Date is not
   • Date is before
   • Date is after
   • Active
   • Not Active
     Note

     The following filter options are available for numeric column values:

     • Less than
     • Less than or equal to
     • Greater than
     • Greater than or equal to

     The following filter options are available for date column values:

     • Date is 
     • Date is not
     • Date is before
     • Date is after

     The following filter options are available for toggle switch Active:

     • Active
     • Not Active 
5. Click Clear to clear the configured filter and apply to set the filter condition.

Search

The Search option in API Configuration helps to easily search configured API's from the list page. 

Figure: Search icon

Edit

The edit API(s) enables you to edit configured API details based on the requirement.

To edit API(s) details, perform the following steps:

1. Navigate to Design Studio, select the required application. Select a module.
2. Go to API Configuration. The list page and the API Configuration(s) details are displayed. Click the ID hyperlink to view the configured details for API.
   Figure: Edit API Configuration Details page
   
   
3.  Edit the required details of the form and click Update.