Using Business Directory to Run the REST API Methods

To use the Business Directory API methods

1.

Select Help > REST API.

A new browser tab opens with a list of REST methods, grouped by what they act on and what they do.

2.

Ensure that you have an SSL connection. For example, your URL should be:

https://localhost:9502/directory/api-docs/

3.

Click the text on the method you want to look at or use.

The method description expands to display its description, the rights required, examples of its use, and a Try it out! button.

4.

To use a method, type values for required parameters and click Try it out!.

Note: Although the button says Try it out, the method executes “live” on the instance to which it points.
Commands the require a file input or output cannot be run from the Try it out! button.

5.

Review the information.