Functions of org.wso2.ballerina.connectors.salesforcesoap package
function addFields(xml payload, map fields, string xpath)
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | xml | |
fields | map | |
xpath | string |
function isSessionExpired(xml soapResponse) (boolean )
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
soapResponse | xml |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
boolean |
function login(string username, string password, string loginUrl, string soapVersion) (xml )
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
username | string | |
password | string | |
loginUrl | string | |
soapVersion | string |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml |
Connectors of org.wso2.ballerina.connectors.salesforcesoap package
connector ClientConnector (string username, string password, string loginUrl, string soapVersion)
Salesforcesoap client connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
username | string | Salesforce Username |
password | string | Salesforce Password + Security Token |
loginUrl | string | Login Url of Salesforce |
soapVersion | string | Soap version |
action createRecord()
Adds one or more new records to your organization???s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
fields | map | Map of fields of records |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action deleteRecord()
Deletes one or more records from your organization???s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
recordId | string | Id of Record to be deleted |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action describeGlobal()
Lists the available objects and their metadata for your organization???s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action describeSObject()
Retrieves metadata (field list and object properties) for the specified object type
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
type | string | Name of SObject |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action describeSObjects()
An array-based version of describeSObject
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
type | string | Name of SObject |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action query()
Executes a query against the specified object and returns data that matches the specified criteria
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
query | string | Query String |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action queryAll()
Retrieves data from specified objects, whether or not they have been deleted
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
query | string | Query String |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action queryMore()
Retrieves the next batch of objects from a query
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
queryLocator | string | Url to retrieve the balance query results |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action retrieve()
Retrieves one or more records based on the specified IDs
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
fieldList | string | List of fields that needs to be retrieved |
type | string | Name of SObject |
recordId | string | Id of Record |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action search()
Executes a text search in your organization???s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
query | string | Search String |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action updateRecord()
Updates one or more existing records in your organization???s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
fields | map | Map of fields of records |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |
action upsertRecord()
Creates new records and updates existing records
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s | ClientConnector | The salesforcesoap connector instance |
headers | xml[] | Soap header values |
externalId | string | External Id |
fields | map | Map of fields of records |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | response message |