Working with REST

Last modified on February 14, 2023

This topic describes how to control the settings when working with APIs. Before reviewing this material, check out the Quick Start and the Tutorials.

Setting Operation Parameters

Headings and Parameters

By default, the Headings & Parameters control is displayed. You can type your parameters into the Path field at the top of the window or you can modify current parameter settings and add new parameters from the table:

Authorization settings

If your API requires authentication, you can click on the Authorization Settings control to specify the type of authorization and your credentials.

Body settings

By default, the body of the request is in JSON. You can also specify XML or plain text by clicking on the Body control.

Connection settings

The following Connection settings options are available:

Viewing Response Headers

By default, the body of the response is displayed at the bottom of the main API Exploration window. To display the headers instead of the body, click on the Headers option at the left of the Response section.

Viewing the Raw Data Stream

The Raw slider button allows you to change the display of API Exploration to show the raw data stream instead of the parsed components.

Highlight search results