Developer Portal 10.11 | Using Developer Portal | APIs | Trying APIs | Trying a OData API
 
Trying a OData API
 
Authorization fields
This section explains how you can test a OData API.
Pre-requisites
*If the API that you are trying is protected with API key, JWT, or OAuth, then create an application to establish your identification. For information about creating applications, see Creating an application.
*To try a OData API
1. Navigate to the Try API page using one of the following ways:
*Click the Tryout icon in the corresponding API tile.
*Click Try API from the API details page of the corresponding API.
The Try API page appears. The resources that you can test appear in the left pane.
2. Expand the required resource and click the required method.
3. In the Query builder tab, select the required query parameters and click Add .
The specified parameters are included as a query in the request URL.
4. Provide the following values in the Parameters tab:
*Key. Key value of the parameter.
*Value. Value of the corresponding key parameter.
You can click Add new and add multiple entries.
5. Provide the following required values in the Headers tab:
*Key. Type a header key value.
*Value. Type the corresponding value of the key parameter.
You can click Add new and add multiple entries.
6. Provide the authorization details from the Authorization tab.
For information about the authorization types and required inputs, see Authorization fields.
7. Select the required request form from the Request body tab and provide your request:
*form-data. To send your request in the form of the key-value pairs. You can select Text and provide your form key and value or select File and attach the request file.
*x-www-form-encoded. To send your request in the form of the encoded key-value pairs.
*raw. To provide any request. You can provide the request in JSON or XML format.
*None. To send the test request without a request body.
8. Click Send.
The response body and headers appear in their respective sections.