Using cURL Commands to Run the REST API Methods
The REST API page displays several cURL examples for each method on the page. You can use a command window to run the cURL command and get results or modify your Business Directory instance.
Typically, UNIX and Cygwin command line windows come with the cURL tool installed, For Windows, you might need to obtain and install the cURL tool.
These instructions assume that running in insecure mode. If you want to configure secure execution of the cURL commands, see an example set up in
Setting Up Secure cURL Execution ExampleTo use a command window to run the Business Directory REST 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. 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.
3. Copy the text of the cURL example that appears closest to what you might need to use.
4. Open your favorite command window.
5. Paste the cURL command, optionally add a ‘-k’ to the command to run in insecure mode, and click Return.
6. Review the results.
