sfdcGetOpportunity
- Jonathan Muse
- Shane Smith
Owned by Jonathan Muse
Syntax
sfdcGetOpportunity(sfdcConnection, sfdcOpportunityId, [sfdcAPIVersion])
Description
Retrieves data related to an opportunity from the Salesforce environment.
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
sfdcConnection | Yes | Salesforce Connection - it is the object resulted from the call to the connectToSalesforce function. | |
sfdcOpportunityId | string | Yes | ID of the Salesforce opportunity to be retrieved. |
sfdcAPIVersion | string | No | Salesforce API version to be called when creating the opportunity, it should have the following form: "vXX.X" - eg: "v43.0", "v42.0". It is not required and if empty, the latest available version will be used. |
Return type
SFDCOpportunity (predefined type)
Example
The following example will retrieve information about the opportunity ins Salesforce.
SFDCConnection conn = connectToSalesforce("SFDC_test");
logPrint("WARN", "Connected to SF: " + conn.instance_url + " - " + conn.access_token);
SFDCOpportunity opp;
opp = sfdcGetOpportunity(conn, "opportunity ID", "v43.0");
logPrint("WARN", "Retrieved opportunity: " + opp.Name);