Page History

In this example, we would like to test a sample List API we created in the default Expenses Claims App.

First, click on the desired API to test. This will expand the configurations available for the API.

In this case, we are testing an API method that lists all or partial records of the "Expense All" datalist.

In the "Parameters" section, we can observe all the available parameters of this API, along with its data type, parameter type, and a short description about its function/purpose.

In the "Responses" section, here shows all the possible responses that this API may return. In the 'Example Value' field, we can expect the JSON value that this API will return, depending on a successful or unsuccessful/misconfigured request.

Now let's try out this API method! Click on "Try it out" button located on the right side of the "Parameter" section header.

Depending on the parameter requirements of an API element, some parameters may be mandatory. Do fill up sample data into any mandatory parameter(s).

In this case, the List API by default will return all records found in a datalist, if none of the parameters contain a value.