Connectors of org.wso2.ballerina.connectors.salesforcerest package
connector ClientConnector (string accessToken, string clientId, string clientSecret, string refreshToken, string apiInstance, string refreshEndpoint)
Salesforcerest client connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
accessToken | string | The accessToken of the salesforce connected app to access the salesforce REST API |
clientId | string | The clientId of the salesforce connected app to access the salesforce REST API |
clientSecret | string | The clientSecret of the salesforce connected app to access the salesforce REST API |
refreshToken | string | The refreshToken of the salesforce connected app to access the salesforce REST API |
apiInstance | string | The api instance of the organization |
refreshEndpoint | string | accessToken: The accessToken of the salesforce connected app to access the salesforce REST API |
action createMultipleRecords()
Create multiple records
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
payload | json | json payload containing record data |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action createRecord()
Creates new records
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
payload | json | json payload containing record data |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action delete()
Deletes existing record
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
deleteId | string | apiVersion: The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action describeGlobal()
Lists the available objects and their metadata for your organization’s data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action listAvailableApiVersion()
Lists summary information about each REST API version currently available
Parameters:
Parameter Name | Data Type | Description |
---|
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action listOrganizationLimits()
Lists limits information for your organization
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action listResourcesByApiVersion()
Lists the resources available for the specified API version
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
requestingApiVersion | string | The api version to get resources |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action listviewQueryPerformanceFeedback()
Get feedback on how Salesforce will execute your list view
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
listViewId | string | The id of the listview to get the feedback from |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action query()
Executes the specified SOQL query
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
queryString | string | The request SOQL query |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action queryAll()
QueryAll will return records that have been deleted because of a merge or delete, archived Task and Event records
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
queryString | string | The request SOQL query |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action queryAllMore()
If the queryAll results are too large, retrieve the next batch of results
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
nextRecordsUrl | string | The url sent with first batch of queryAll results to get the next batch |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action queryMore()
If the query results are too large, retrieve the next batch of results
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
nextRecordsUrl | string | The url sent with first batch of query results to get the next batch |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action queryPerformanceFeedback()
Get feedback on how Salesforce will execute your query
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
queryString | string | The request SOQL query |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action retrieveFieldValues()
Retrieve field values from a record
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
rowId | string | The row ID of the required record |
fields | string | The comma separated set of required fields |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action retrieveFieldValuesFromExternalObject()
Retrieve field values from an external record
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
rowId | string | The row ID of the required record |
fields | string | The comma separated set of required fields |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action retrieveStandardFieldValuesFromExternalObjectWithExternalId()
Retrieve field values from an external record with external ID
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
externalId | string | The row ID of the required external record |
fields | string | The comma separated set of required fields |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectBasicInfo()
Describes the individual metadata for the specified object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
sobjectName | string | The relevant sobject name |
apiVersion | string | The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectDescribe()
Completely describes the individual metadata at all levels for the specified object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
sobjectName | string | The relevant sobject name |
apiVersion | string | The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectGetDeleted()
Retrieves the list of individual records that have been deleted within the given timespan for the specified object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
startTime | string | The start time of the time span |
endTime | string | The end time of the time span |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectGetUpdated()
Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
startTime | string | The start time of the time span |
endTime | string | The end time of the time span |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectPlatformAction()
Query for actions displayed in the UI, given a user, a context, device format, and a record ID
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectRows()
Accesses records based on the specified object ID
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
rowId | string | apiVersion: The api version to send request to |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action sObjectRowsByExternalId()
Creates new records or updates existing records (upserts records) based on the value of a specified external ID field
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
fieldId | string | The external field id |
fieldValue | string | The external field value |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action update()
Updates an existing record
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobjectName | string | The relevant sobject name |
recordId | string | apiVersion: The api version to send request to |
payload | json | json payload containing record data |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |
action upsert()
If record exists, update it else inserts it
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
apiVersion | string | The api version to send request to |
sobject | string | apiVersion: The api version to send request to |
externalField | string | The external field id |
fieldValueId | string | The external field value |
payload | json | json payload containing record data |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response message |