Example: retrieve data with the Salesforce API

This topic provides an example on how you retrieve data with the Salesforce API.

Prerequisites

You have set up a connection via API from your Neptune DXP - Open Edition to Salesforce.
Salesforce provided you with the corresponding endpoint of the API.

It is described in the documentation how to add an operation with the API Designer.

In the Cockpit, go to the API Designer and open the API connected to Salesforce.
In the Operations tab, select Add.
In Path, add the following: /services/data/v43.0/query/?q=SELECT (columns) FROM Account
Add GET as method.
Give a summary on what the API does, for example, "Retrieves columns from the account table".
Go to the Request tab.
Add a Parameter and enter a Name, for example, columns.
Select In Path and Required.
Select Save.

You can test your API with the API Client.