All Products
Search
Document Center

Test an API operation

Last Updated: Jun 29, 2020

This topic describes how to test API operations in the data service module of Data Management Service (DMS).

Procedure

  1. Log on to the DMS console.
  2. In the top navigation bar, choose Data Factory > Data Service.
  3. On the Data Service page, click API Test in the left-side navigation pane. The APITest page appears.

    You can also open this page by finding a published API operation on the APIPublishList page and then clicking Test in the Operation column.

  4. On the APITest page, click on the drop-down arrow. All your published API operations are displayed in the drop-down list. Select an API operation that you want to test.

    If you open the APITest page from the APIPublishList page, the corresponding API operation is automatically selected.

  5. Enter a value in the input box in the Parameter value column and click Test. The system will use the entered value to execute the SQL statement in the API operation.

    After you select an API operation, all request parameters defined for the API operation are automatically displayed. The Parameter value column provides input boxes for you to enter values for testing.

  6. After the execution is completed, view the execution information and results respectively in the ExecuteInformation and ReturnResults sections on the right of the page.

    Returned results are displayed both in a table and in the JSON format.

    Data Service API test1

    Data Service API test2