Api Explorer
Api Explorer module allows you to execute any of Salesforce REST or SOAP APIs in a Postman client type interface. Support for saving to APIs collections, access to standard Salesforce REST APIs and Salesforce Graphql APIs will be added in coming releases.
Usage
APIs module can be accessed by clicking on the AppMenu ->
Modules -> Apis. Once you open the module, it should have created a first empty request. You can make changes to the
request and then click Send which should execute the api and show the result in the bottom panel.
Overview
The following screenshot highlights various UI elements and usage.
Json Path
You can search to filter the lines matching the API Response by entering the text you are looking for. If your search
starts with $ it is treated as Json Path and it shows the response matching that Json Path.
See this page on syntax of Json Path.
Here is an example of Json Path filtering
Variables
This version has initial support for using variables in the API requests. Variables are enclosed between {{ and }}
without any spaces between them. For ex., {{variableName}}. Note that at this time, you cannot have spaces between
them. For ex., {{ variableName }} is not a valid expression.
We support the following standard variables. Support for custom variables will be added in future releases.
| Name | Data Type | Description |
|---|---|---|
bb.version | String | Current connection API Version. Connection API Version is specified in the Edit Connection dialog, defaults to latest api version supported by Brobench |