Salesforce REST Connector Reference¶
The following operations allow you to work with the Salesforce REST Connector. Click an operation name to see parameter details and samples on how to use it.
Initialize the connector¶
Salesforce REST API uses the OAuth protocol to allow application users to securely access data without having to reveal their user credentials. For more information on how authentication is done in Salesforce, see Understanding Authentication. You can provide only access token and use it until it expires. After expiry, you will be responsible for getting a new access token and using it. Alternatively, you have the option of providing refresh token, client secret, and client ID which will be used to get access token initially and after every expiry by the connector itself. You will not be required to handle access token expiry in this case.
There also option to use basic authentication with username and password.
To use the Salesforce REST connector, add the <salesforcerest.init> element in your configuration before carrying out any other Salesforce REST operations.
salesforcerest.init
The salesforcerest.init operation initializes the connector to interact with the Salesforce REST API. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| apiVersion | The version of the Salesforce API. | Yes | v32.0 |
| accessToken | The access token to authenticate your API calls. | No | XXXXXXXXXXXX (Replace with your access token) |
| apiUrl | The instance URL for your organization. | Yes | https://ap2.salesforce.com |
| hostName | SalesforceOAuth endpoint when issuing authentication requests in your application. | Yes | https://login.salesforce.com |
| refreshToken | The refresh token that you received to refresh the API access token. | No | XXXXXXXXXXXX (Replace with your refresh token) |
| tokenEndpointHostname | The endpoint of the refresh token that you invoke to refresh the API access token. | No | XXXXXXXXXXXX (Replace this with your refresh token endpoint) |
| clientId | The consumer key of the connected application that you created. | No | XXXXXXXXXXXX (Replace with your client ID) |
| clientSecret | The consumer secret of the connected application that you created. | No | XXXXXXXXXXXX (Replace with your client secret) |
| blocking | Indicates whether the connector needs to perform blocking invocations to Salesforce. | Yes | false |
Sample configuration
<salesforcerest.init>
<accessToken>{$ctx:accessToken}</accessToken>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<hostName>{$ctx:hostName}</hostName>
<apiVersion>{$ctx:apiVersion}</apiVersion>
<blocking>{$ctx:blocking}</blocking>
</salesforcerest.init>Sample request
{
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"blocking" : "false"
}Or if you want conector to handle token expiry
Sample configuration
<salesforcerest.init>
<accessToken>{$ctx:accessToken}</accessToken>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<hostName>{$ctx:hostName}</hostName>
<apiVersion>{$ctx:apiVersion}</apiVersion>
<refreshToken>{$ctx:refreshToken}</refreshToken>
<clientId>{$ctx:clientId}</clientId>
<clientSecret>{$ctx:clientSecret}</clientSecret>
<blocking>{$ctx:blocking}</blocking>
</salesforcerest.init>Sample request
```json { "hostName": "https://login.salesforce.com", "apiVersion": "v32.0", "refreshToken":"XXXXXXXXXXXX (Replace with your refresh token)", "apiUrl":"https://(your_instance).salesforce.com", "clientId": "XXXXXXXXXXXX (Replace with your client ID)", "clientSecret": "XXXXXXXXXXXX (Replace with your client secret)", "blocking" : "false" }
salesforcerest.init for username/password flow
The salesforcerest.init operation initializes the connector to interact with the Salesforce REST API using a username/password flow. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| apiVersion | The version of the Salesforce API. | Yes | v32.0 |
| apiUrl | The instance URL for your organization. | Yes | https://ap2.salesforce.com |
| hostName | SalesforceOAuth endpoint when issuing authentication requests in your application. | Yes | https://login.salesforce.com |
| clientId | The consumer key of the connected application that you created. | Yes | XXXXXXXXXXXX (Replace with your client ID) |
| clientSecret | The consumer secret of the connected application that you created. | Yes | XXXXXXXXXXXX (Replace with your client secret) |
| username | The username for Salesforce. | Yes | youruser@gmail.com |
| password | The password for Salesforce (need to append the password with security key). | Yes | xxxxxxxxxxxxxxxxxxxxxx |
| blocking | Indicates whether the connector needs to perform blocking invocations to Salesforce. | Yes | false |
Sample configuration
<salesforcerest.init>
<apiUrl>{$ctx:apiUrl}</apiUrl>
<clientId>{$ctx:clientId}</clientId>
<clientSecret>{$ctx:clientSecret}</clientSecret>
<hostName>{$ctx:hostName}</hostName>
<apiVersion>{$ctx:apiVersion}</apiVersion>
<username>{$ctx:username}</username>
<password>{$ctx:password}</password>
<blocking>{$ctx:blocking}</blocking>
</salesforcerest.init>Sample request
{
"clientId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"clientSecret": "xxxxxxxxxxxxxxxxxxxxxxxx",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"username": "youruser@gmail.com",
"password": "xxxxxxxxxxxxxxxxxxxxxx",
"apiUrl":"https://(your_instance).salesforce.com",
"blocking" : "false"
}AppMenu¶
listItemsInMenu
To retrieve the list of items in either the Salesforce app drop-down menu or the Salesforce1 navigation menu, use salesforcerest.listItemsInMenu and specify the following property. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| menuType | The type of the menu, either AppSwitcher or Salesforce. | Yes | AppSwitcher, Salesforce |
Sample configuration
<salesforcerest.listItemsInMenu>
<menuType>{$ctx:menuType}</menuType>
</salesforcerest.listItemsInMenu>Sample request
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"menuType": "AppSwitcher",
}Sample response
{"NetworkTabs":"/services/data/v32.0/appMenu/NetworkTabs","Salesforce1":"/services/data/v32.0/appMenu/Salesforce1","AppSwitcher":"/services/data/v32.0/appMenu/AppSwitcher"} tabs
To retrieve a list of all tabs, use salesforcerest.tabs. See the related API documentation for more information.
Sample configuration
<salesforcerest.tabs/>Sample request
The following is a sample request that can be handled by the tabs operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample response
Given below is a sample response for the tabs operation.
{"output":"[{\"colors\":[{\"color\":\"4dca76\",\"context\":\"primary\",\"theme\":\"theme4\"},{\"color\":\"319431\",\"context\":\"primary\",\"theme\":\"theme3\"}],\"custom\":true,\"iconUrl\":\"https://sampletest-dev-ed.my.salesforce.com/img/icon/form32.png\",..}themes
To retrieve a list of icons and colors used by themes in the Salesforce application, use salesforcerest.themes. See the related API documentation for more information.
Sample configuration
<salesforcerest.themes/>Sample request
The following is a sample request that can be handled by the themes operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample response
Given below is a sample response for the themes operation.
{
"themeItems":[
{
"name":"Account",
"icons":[
{
"width":32,
"theme":"theme3",
"contentType":"image/png",
"url":"https://kesavan-dev-ed.my.salesforce.com/img/icon/accounts32.png",
"height":32
}
]
}
]
}Approvals¶
listApprovals
To retrieve the list of approvals in Salesforce, use salesforcerest.listApprovals. See the related API documentation for more information.
Sample configuration
<salesforcerest.listApprovals/>Sample request
The following is a sample request that can be handled by the listApprovals operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample response
Given below is a sample response for the listApprovals operation.
{
"approvals":{
}
}Event Monitoring¶
describeEventMonitoring
To retrieve the description of the event monitoring log, use salesforcerest.describeEventMonitoring. See the related API documentation for more information.
Sample configuration
<salesforcerest.describeEventMonitoring/>Sample request
The following is a sample request that can be handled by the describeEventMonitoring operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample response
Given below is a sample response for the describeEventMonitoring operation.
{
"updateable":false,
"activateable":false,
"childRelationships":[
],
"recordTypeInfos":[
],
"deprecatedAndHidden":false,
"searchLayoutable":false,
"deletable":false,
"replicateable":false,
"actionOverrides":[
],
.
.
],
"labelPlural":"Event Log Files",
"triggerable":false
}queryEventMonitoringData
To retrieve the field values from a record, use salesforcerest.queryEventMonitoringData and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| queryStringForEventMonitoringData | The query string to use to get the field values from the log. | Yes | SELECT+Id+,+EventType+,+LogFile+,+LogDate+,+LogFileLength+FROM+EventLogFile+WHERE+LogDate+>+Yesterday+AND+EventType+=+'API' |
Sample configuration
<salesforcerest.queryEventMonitoringData>
<queryStringForEventMonitoringData>{$ctx:queryStringForEventMonitoringData}</queryStringForEventMonitoringData>
</salesforcerest.queryEventMonitoringData>Sample request
The following is a sample request that can be handled by the queryEventMonitoringData operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"clientId": "3MVG9ZL0ppGP5UrBztM9gSLYyUe7VwAVhD9.yQnZX2mmCu_48Uwc._doxrBTgY4jqmOSDhxRAiUBf8gCr2mk7",
"refreshToken": "5Aep861TSESvWeug_ztpnAk6BGQxRdovMLhHso81iyYKO6hTm45JVxz3FLewCKgI4BbUp19OzGfqG2TdCfqa2ZU",
"clientSecret": "1187341468789253319",
"hostName": "https://login.salesforce.com",
"apiVersion": "v34.0",
"queryStringForEventMonitoringData": "SELECT+Id+,+EventType+,+LogFile+,+LogDate+,+LogFileLength+FROM+EventLogFile+WHERE+LogDate+>+Yesterday+AND+EventType+=+'API'",
}Sample response
Given below is a sample response for the queryEventMonitoringData operation.
{
"totalSize" : 4,
"done" : true,
"records" : [ {
"attributes" : {
"type" : "EventLogFile",
"url" : "/services/data/v32.0/sobjects/EventLogFile/0ATD000000001bROAQ" }
"Id" : "0ATD000000001bROAQ",
"EventType" : "API",
"LogFile" : "/services/data/v32.0/sobjects/EventLogFile/0ATD000000001bROAQ/LogFile",
"LogDate" : "2014-03-14T00:00:00.000+0000",
"LogFileLength" : 2692.0
},
.
]
}Invocable Actions¶
getListOfAction
To retrieve the list of general action types for the current organization, use salesforcerest.getListOfAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required |
|---|---|---|
| actionType | The type of the invocable action. | Yes |
Sample configuration
<salesforcerest.getListOfAction/>Sample request
The following is a sample request that can be handled by the getListOfAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample response
Given below is a sample response for the getListOfAction operation.
{
"standard":"/services/data/v32.0/actions/standard",
"custom":"/services/data/v32.0/actions/custom"
}getSpecificListOfAction
To retrieve an attribute of a single action, use salesforcerest.getAttributeOfSpecificAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| actionType | The type of the invocable action. | Yes | standard |
Sample configuration
<salesforcerest.getSpecificListOfAction>
<actionType>{$ctx:actionType}</actionType>
</salesforcerest.getSpecificListOfAction>Sample request
The following is a sample request that can be handled by the getSpecificListOfAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"actionType": "standard",
}Sample response
Given below is a sample response for the getSpecificListOfAction operation.
{
"standard":"/services/data/v32.0/actions/standard",
"custom":"/services/data/v32.0/actions/custom"
}getAttributeOfSpecificAction
To retrieve an attribute of a single action, use salesforcerest.getAttributeOfSpecificAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| actionType | The type of the invocable action. | Yes | standard |
| attribute | The attribute whose details you want to retrieve. | Yes | emailSimple |
Sample configuration
<salesforcerest.getAttributeOfSpecificAction>
<actionType>{$ctx:actionType}</actionType>
<attribute>{$ctx:attribute}</attribute>
</salesforcerest.getAttributeOfSpecificAction>Sample request
The following is a sample request that can be handled by the getAttributeOfSpecificAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"actionType": "standard",
"attribute": "emailSimple",
}Sample response
Given below is a sample response for the getAttributeOfSpecificAction operation.
{
"actions":[
{
"name":"chatterPost",
"label":"Post to Chatter",
"type":"CHATTERPOST"
},
{
"name":"emailSimple",
"label":"Send Email",
"type":"EMAILSIMPLE"
}
.
]
}Layouts¶
sObjectLayouts
To retrieve a list of layouts and descriptions (including for actions) for a specific object, use salesforcerest.sObjectLayouts and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose layouts and descriptions you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.sObjectLayouts>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.sObjectLayouts>Sample request
The following is a sample request that can be handled by the sObjectLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
}Sample Response
Given below is a sample response for the sObjectLayouts operation.
"layouts":[
{
"detailLayoutSections":[
{
"heading":"Account Information",
"columns":2,
"tabOrder":"TopToBottom",
"useCollapsibleSection":false,
"rows":8,
"useHeading":false,
"layoutRows":[
{
"layoutItems":[
{
"editableForUpdate":false,
"editableForNew":false,
"layoutComponents":[
{
"tabOrder":1,
"details":{
"defaultValue":null,
"precision":0,
"nameField":false,
"type":"reference",
"restrictedDelete":false,
"relationshipName":"Owner",
"calculatedFormula":null,
"controllerName":null,
"namePointing":false,
"defaultValueFormula":null,
"calculated":false,
"writeRequiresMasterRead":false,
"inlineHelpText":null,
"picklistValues":[
]
}
}
]
}
.
}globalSObjectLayouts
To retrieve descriptions of global publisher layouts, use salesforcerest.globalSObjectLayouts. See the related API documentation for more information.
Sample configuration
<salesforcerest.globalSObjectLayouts/>Sample request
The following is a sample request that can be handled by the globalSObjectLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the globalSObjectLayouts operation.
{
"layouts":[
{
"detailLayoutSections":[
],
"relatedContent":null,
"editLayoutSections":[
],
"relatedLists":[
],
"buttonLayoutSection":null,
"id":"00h28000001hExeAAE",
"offlineLinks":[
],
.
.
}
}compactLayouts
To retrieve a list of compact layouts for multiple objects, use salesforcerest.compactLayouts and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required |
|---|---|---|
| sObjectNameList | A comma-separated list of the objects whose compact layouts you want to retrieve. | Yes |
Sample configuration
<salesforcerest.compactLayouts/>Sample request
The following is a sample request that can be handled by the compactLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectNameList":"Account,User",
}Sample Response
Given below is a sample response for the compactLayouts operation.
{
"Account":{
"name":"SYSTEM",
"id":null,
"label":"System Default",
"actions":[
{
"showsStatus":false,
"custom":false,
"label":"Call",
"overridden":false,
"encoding":null,
"icons":[
{
"width":0,
"theme":"theme4",
"contentType":"image/svg+xml",
"url":"https://kesavan-dev-ed.my.salesforce.com/img/icon/t4v32/action/call.svg",
"height":0
},
],
"windowPosition":null,
"colors":[
{
"color":"F2CF5B",
"context":"primary",
"theme":"theme4"
}
],
.
.
],
"objectType":"User"
}
}sObjectApprovalLayouts
To retrieve a list of approval layouts for a specified object, use salesforcerest.sObjectApprovalLayouts and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose layouts you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.sObjectApprovalLayouts>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.sObjectApprovalLayouts>Sample request
The following is a sample request that can be handled by the sObjectApprovalLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
}Sample Response
Given below is a sample response for the sObjectApprovalLayouts operation.
{"approvalLayouts":[]}sObjectCompactLayouts
To retrieve a list of compact layouts for a specific object, use salesforcerest.sObjectCompactLayouts and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose layouts you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.sObjectCompactLayouts>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.sObjectCompactLayouts>Sample request
The following is a sample request that can be handled by the sObjectCompactLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
}Sample Response
Given below is a sample response for the sObjectCompactLayouts operation.
{
"compactLayouts":[
{
"name":"SYSTEM",
"id":null,
"label":"System Default",
"actions":[
{
"showsStatus":false,
"custom":false,
"label":"Call",
"overridden":false,
"encoding":null,
"icons":[
{
"width":0,
"theme":"theme4",
"contentType":"image/svg+xml",
"url":"https://kesavan-dev-ed.my.salesforce.com/img/icon/t4v32/action/call.svg",
"height":0
}
],
"defaultCompactLayoutId":null
.
]
}sObjectNamedLayouts
To retrieve information about alternative named layouts for a specific object, use salesforcerest.sObjectNamedLayouts and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose layouts you want to retrieve. | Yes | Account |
| layoutName | The type of layout. | Yes | UserAlt |
Sample configuration
<salesforcerest.sObjectNamedLayouts>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<layoutName>{$ctx:layoutName}</layoutName>
</salesforcerest.sObjectNamedLayouts>Sample request
The following is a sample request that can be handled by the sObjectCompactLayouts operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"layoutName": "UserAlt",
}Sample Response
Given below is a sample response for the sObjectCompactLayouts operation.
{
"layouts":[
{
"detailLayoutSections":[
{
"heading":"About",
"columns":2,
"tabOrder":"LeftToRight",
"useCollapsibleSection":false,
"rows":2,
"useHeading":false,
"layoutRows":[
{
"layoutItems":[
{
"editableForUpdate":false,
"editableForNew":false,
"layoutComponents":[
{
"components":[
{
"tabOrder":2,
"details":{
"defaultValue":null,
"precision":0,
"nameField":false,
"type":"string",
"restrictedDelete":false,
"relationshipName":null,
"calculatedFormula":null,
"controllerName":null,
"namePointing":false,
"defaultValueFormula":null,
"calculated":false,
"writeRequiresMasterRead":false,
"inlineHelpText":null,
"picklistValues":[
]
}
}
]
}
.
}List Views¶
listViews
To retrieve a list of list views for the specific sObject, use salesforcerest.listViews and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose list views you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.listViews>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.listViews>Sample request
The following is a sample request that can be handled by the listViews operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
}Sample Response
Given below is a sample response for the listViews operation.
{
"nextRecordsUrl":null,
"size":7,
"listviews":[
{
"resultsUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/results",
"soqlCompatible":true,
"id":"00B280000032AihEAE",
"label":"New This Week",
"describeUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/describe",
"developerName":"NewThisWeek",
"url":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE"
},
.
.
],
"done":true,
"sobjectType":"Account"
}listViewById
To retrieve the basic information about one list view for the specific sObject, use salesforcerest.listViewById and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose list of list views you want to retrieve. | Yes | Account |
| listViewId | The ID of the specific list view whose information you want to return. This can be obtained by listViews operation |
Yes | 00B28000002yqeVEAQ |
Sample configuration
<salesforcerest.listViewById>
<listViewID>{$ctx:listViewID}</listViewID>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.listViewById>Sample request
The following is a sample request that can be handled by the listViewById operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"listViewID":"00B28000002yqeVEAQ",
}Sample Response
Given below is a sample response for the listViewById operation.
{
"resultsUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/results",
"soqlCompatible":true,
"id":"00B280000032AihEAE",
"label":"New This Week",
"describeUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/describe",
"developerName":"NewThisWeek",
"url":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE"
}recentListViews
To retrieve the list of recently used list views for the given sObject type, use salesforcerest.recentListViews and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object whose recently used list views you want to return. | Yes | Account |
Sample configuration
<salesforcerest.recentListViews>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.recentListViews>Sample request
The following is a sample request that can be handled by the recentListViews operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
}Sample Response
Given below is a sample response for the recentListViews operation.
{
"nextRecordsUrl":null,
"size":2,
"listviews":[
{
"resultsUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/results",
"soqlCompatible":true,
"id":"00B280000032AihEAE",
"label":"New This Week",
"describeUrl":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE/describe",
"developerName":"NewThisWeek",
"url":"/services/data/v32.0/sobjects/Account/listviews/00B280000032AihEAE"
}
.
.
],
"done":true,
"sobjectType":"Account"
}describeListViewById
To retrieve detailed information (ID, columns, and SOQL query) about a specific list view for the given sObject type, use salesforcerest.describeListViewById and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object to which the list view applies. | Yes | Account |
| listViewID | The ID of the list view. | Yes | 00B28000002yqeVEAQ (obtained by listViews operation) |
Sample configuration
<salesforcerest.describeListViewById>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<listViewID>{$ctx:listViewID}</listViewID>
</salesforcerest.describeListViewById>Sample request
The following is a sample request that can be handled by the describeListViewById operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"listViewID":"00B28000002yqeVEAQ",
}Sample Response
Given below is a sample response for the describeListViewById operation.
{
"whereCondition":{
"field":"CreatedDate",
"values":[
"THIS_WEEK"
],
"operator":"equals"
},
"columns":[
{
"fieldNameOrPath":"Name",
"sortDirection":"ascending",
"hidden":false,
"sortIndex":0,
"ascendingLabel":"Z-A",
"label":"Account Name",
"sortable":true,
"type":"string",
"descendingLabel":"A-Z",
"selectListItem":"Name"
},
.
.
],
"query":"SELECT Name, Site, BillingState, Phone, toLabel(Type), Owner.Alias, Id, CreatedDate, LastModifiedDate, SystemModstamp FROM Account WHERE CreatedDate = THIS_WEEK ORDER BY Name ASC NULLS FIRST, Id ASC NULLS FIRST",
"scope":null,
"orderBy":[
{
"fieldNameOrPath":"Name",
"sortDirection":"ascending",
"nullsPosition":"first"
},
{
"fieldNameOrPath":"Id",
"sortDirection":"ascending",
"nullsPosition":"first"
}
],
"id":"00B280000032Aih",
"sobjectType":"Account"
}listViewResults
To execute the SOQL query for the list view and return the resulting data and presentation information, use salesforcerest.listViewResults and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object to which the list view applies. | Yes | Account |
| listViewID | The ID of the list view (obtained by listViews operation). |
Yes | 00B28000002yqeVEAQ |
Sample configuration
<salesforcerest.listViewResults>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<listViewID>{$ctx:listViewID}</listViewID>
</salesforcerest.listViewResults>Sample request
The following is a sample request that can be handled by the listViewResults operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"listViewID":"00B28000002yqeVEAQ",
}Sample Response
Given below is a sample response for the listViewResults operation.
{
"size":0,
"records":[
],
"columns":[
{
"fieldNameOrPath":"Name",
"sortDirection":"ascending",
"hidden":false,
"sortIndex":0,
"ascendingLabel":"Z-A",
"label":"Account Name",
"sortable":true,
"type":"string",
"descendingLabel":"A-Z",
"selectListItem":"Name"
},
.
.
],
"id":"00B280000032Aih",
"label":"New This Week",
"developerName":"NewThisWeek",
"done":true
}Process Rules¶
listProcessRules
To retrieve the list of process rules in the organization, use salesforcerest.listProcessRules. See the related API documentation for more information.
Sample configuration
<salesforcerest.listProcessRules/>Sample request
The following is a sample request that can be handled by the listProcessRules operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the listProcessRules operation.
{
"rules":{
}
}getSpecificProcessRule
To retrieve the metadata for a specific sObject process rule, use salesforcerest.getSpecificProcessRule and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object whose process rule you want to retrieve. | Yes | Account |
| workflowRuleId | The ID of the process rule. You can get IDs using operation listProcessRules. |
Yes | 01QD0000000APli |
Sample configuration
<salesforcerest.getSpecificProcessRule>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<workflowRuleId>{$ctx:workflowRuleId}</workflowRuleId>
</salesforcerest.getSpecificProcessRule>Sample request
The following is a sample request that can be handled by the getSpecificProcessRule operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"workflowRuleId": "01QD0000000APli",
}Sample Response
Given below is a sample response for the getSpecificProcessRule operation.
{
"actions" : [ {
"id" : "01VD0000000D2w7",
"name" : "ApprovalProcessTask",
"type" : "Task"
} ],
"description" : null,
"id" : "01QD0000000APli",
"name" : "My Rule",
"namespacePrefix" : null,
"object" : "Account"
}Queries¶
query
To retrieve data from an object, use salesforcerest.query and specify the following properties. If you want your results to include deleted records in the Recycle Bin, use salesforcerest.queryAll in place of salesforcerest.query. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value | |
|---|---|---|---|---|
| queryString | The SQL query to use to search for records. | Yes | select id, name from Account |
Sample configuration
query:
<salesforcerest.query>
<queryString>{$ctx:queryString}</queryString>
</salesforcerest.query>queryAll:
<salesforcerest.queryAll>
<queryString>{$ctx:queryString}</queryString>
</salesforcerest.queryAll>Sample request
The following is a sample request that can be handled by the query operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"queryString": "select id, name from Account",
}Sample Response
Given below is a sample response for the query operation.
{
"done" : false,
"totalSize" : 2014,
"nextRecordsUrl" : "/services/data/v20.0/query/01gD0000002HU6KIAW-2000",
"records" :
[
{
"attributes" :
{
"type" : "Account",
"url" : "/services/data/v20.0/sobjects/Account/001D000000IRFmaIAH"
},
"Name" : "Test 1"
},
{
"attributes" :
{
"type" : "Account",
"url" : "/services/data/v20.0/sobjects/Account/001D000000IomazIAB"
},
"Name" : "Test 2"
},
...
]
}queryMore
If the results from the query or queryAll operations are too large, the first batch of results is returned along with an ID that you can use with salesforcerest.queryMore to get additional results. If you want your results to include deleted records in the Recycle Bin, use salesforcerest.queryAllMore in place of salesforcerest.queryMore. See the related API documentation for queryMore and queryAllMore for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| nextRecordsUrl | The query identifier for retrieving additional results. | Yes | QWE45HUJ39D9UISD00 |
Sample configuration
queryMore:
<salesforcerest.queryMore>
<nextRecordsUrl>{$ctx:nextRecordsUrl}</nextRecordsUrl>
</salesforcerest.queryMore>queryAllMore:
<salesforcerest.queryAllMore>
<nextRecordsUrl>{$ctx:nextRecordsUrl}</nextRecordsUrl>
</salesforcerest.queryAllMore>Sample request
The following is a sample request that can be handled by the queryMore operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"nextRecordsUrl": "QWE45HUJ39D9UISD00",
}Sample Response
Given below is a sample response for the queryMore operation.
{
"done" : true,
"totalSize" : 3214,
"records" : [...]
}queryPerformanceFeedback
To get feedback on how Salesforce will execute your query, use the salesforcerest.queryPerformanceFeedback operation. It uses the Query resource along with the explain parameter to get feedback. Salesforce analyzes each query to find the optimal approach to obtain the query results. Depending on the query and query filters, an index or internal optimization might be used. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| queryString | The SQL query to use to get feedback for a query. | Yes | select id, name from Account |
Sample configuration
<salesforcerest.queryPerformanceFeedback>
<queryString>{$ctx:queryString}</queryString>
</salesforcerest.queryPerformanceFeedback>Sample request
The following is a sample request that can be handled by the queryPerformanceFeedback operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"queryString": "select id, name from Account",
}Sample Response
Given below is a sample response for the queryPerformanceFeedback operation.
{
"plans":[
{
"leadingOperationType":"TableScan",
"relativeCost":2.8324836601307193,
"sobjectCardinality":2549,
"fields":[
],
"cardinality":2549,
"sobjectType":"Account"
}
]
}listviewQueryPerformanceFeedback
For retrieving query performance feedback on a report or list view, use salesforcerest.listviewQueryPerformanceFeedback and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| listViewID | The ID of the report or list view to get feedback for a query. | Yes | 00B28000002yqeVEAQ |
Sample configuration
<salesforcerest.listviewQueryPerformanceFeedback>
<listViewID>{$ctx:listViewID}</listViewID>
</salesforcerest.listviewQueryPerformanceFeedback>Sample request
The following is a sample request that can be handled by the listviewQueryPerformanceFeedback operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"listViewID":"00B28000002yqeVEAQ",
}Sample Response
Given below is a sample response for the listviewQueryPerformanceFeedback operation.
{
"plans":[
{
"leadingOperationType":"Index",
"relativeCost":0,
"sobjectCardinality":2549,
"fields":[
"CreatedDate"
],
"cardinality":0,
"sobjectType":"Account"
},
.
.
]
}Quick Actions¶
quickActions
To retrieve a list of global actions, use salesforcerest.quickActions. See the related API documentation for more information.
| Parameter Name | Description | Required |
|---|---|---|
| queryString | The SQL query to use to search for records. | Yes |
Sample configuration
<salesforcerest.quickActions/>Sample request
The following is a sample request that can be handled by the quickActions operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the quickActions operation.
{
"output":"[
{\"label\":\"Log a Call\",
\"name\":\"LogACall\",
\"type\":\"LogACall\",
\"urls\":{\"defaultValues\":\"/services/data/v32.0/quickActions/LogACall/defaultValues\",\"quickAction\":\"/services/data/v32.0/quickActions/LogACall\",\"describe\":\"/services/data/v32.0/quickActions/LogACall/describe\",\"defaultValuesTemplate\":\"/services/data/v32.0/quickActions/LogACall/defaultValues/{ID}\"}},
.
.
]"
}sObjectAction
To retrieve a list of object-specific actions, use salesforcerest.sObjectAction and specify the following property. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object for which you want to retrieve a list of quick actions. | Yes | Account |
Sample configuration
<salesforcerest.sObjectAction>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.sObjectAction>Sample request
The following is a sample request that can be handled by the sObjectAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
}Sample Response
Given below is a sample response for the sObjectAction operation.
{
"output":"[
{\"label\":\"Log a Call\",
\"name\":\"LogACall\",\"type\":\"LogACall\",
\"urls\":{\"defaultValues\":\"/services/data/v32.0/quickActions/LogACall/defaultValues\",
\"quickAction\":\"/services/data/v32.0/quickActions/LogACall\",
\"describe\":\"/services/data/v32.0/quickActions/LogACall/describe\",
\"defaultValuesTemplate\":\"/services/data/v32.0/quickActions/LogACall/defaultValues/{ID}\"}},
.
.
]"
}getSpecificAction
To retrieve a specific action, use salesforcerest.getSpecificAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| actionName | The name of action to return. | Yes | hariprasath__LogACall |
Sample configuration
<salesforcerest.getSpecificAction>
<actionName>{$ctx:actionName}</actionName>
</salesforcerest.getSpecificAction>Sample request
The following is a sample request that can be handled by the getSpecificAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"actionName":"hariprasath__LogACall",
}Sample Response
Given below is a sample response for the getSpecificAction operation.
{
"iconName":null,
"targetRecordTypeId":null,
"targetSobjectType":"Task",
"canvasApplicationName":null,
"label":"Log a Call",
"accessLevelRequired":null,
"icons":[
{
"width":0,
"theme":"theme4",
"contentType":"image/svg+xml",
"url":"https://kesavan-dev-ed.my.salesforce.com/img/icon/t4v32/action/log_a_call.svg",
"height":0
},
.
.
],
"targetParentField":null,
"iconUrl":"https://kesavan-dev-ed.my.salesforce.com/img/icon/log_a_call_32.png",
"height":null
}getDescribeSpecificAction
To retrieve the description of a specific action, use salesforcerest.getDescribeSpecificAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| actionName | The action whose description you want to return. | Yes | hariprasath__LogACall |
Sample configuration
<salesforcerest.getDescribeSpecificAction>
<actionName>{$ctx:actionName}</actionName>
</salesforcerest.getDescribeSpecificAction>Sample request
The following is a sample request that can be handled by the getDescribeSpecificAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
}Sample Response
Given below is a sample response for the getDescribeSpecificAction operation.
{
"iconName":null,
"targetRecordTypeId":null,
"targetSobjectType":"Task",
"canvasApplicationName":null,
"label":"Log a Call",
"accessLevelRequired":null,
"icons":[
{
"width":0,
"theme":"theme4",
"contentType":"image/svg+xml",
"url":"https://kesavan-dev-ed.my.salesforce.com/img/icon/t4v32/action/log_a_call.svg",
"height":0
}
],
.
.
"targetParentField":null,
"iconUrl":"https://kesavan-dev-ed.my.salesforce.com/img/icon/log_a_call_32.png",
"height":null
}getDefaultValueOfAction
To return a specific action’s default values, including default field values, use salesforcerest.getDefaultValueOfAction and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| actionName | The specific action. | Yes | hariprasath__LogACall |
Sample configuration
<salesforcerest.getDefaultValueOfAction>
<actionName>{$ctx:actionName}</actionName>
</salesforcerest.getDefaultValueOfAction>Sample request
The following is a sample request that can be handled by the getDefaultValueOfAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"actionName":"hariprasath__LogACall",
}Sample Response
Given below is a sample response for the getDefaultValueOfAction operation.
{
"WhoId":null,
"Description":null,
"WhatId":null,
"attributes":{
"type":"Task"
},
"Subject":"Call"
}Records¶
create
To create a record, use salesforcerest.create and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object for which you will create a record. | Yes | Account |
| fieldAndValue | The .json format property used to create the record. Include all mandatory fields according to the requirements for the specified sObject. | Yes | {
"name": "wso2",
"description":"This Account belongs to MWARE ESB"}
|
Note: For example, if you are creating a record for the Account sObject, "name" is a mandatory parameter, and you might want to include the optional description, so the fieldAndValue property would look like this:
{ "name":"wso2", "description":"This account belongs to MWARE ESB" }
Sample configuration
<salesforcerest.create>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</salesforcerest.create>Sample request
The following is a sample request that can be handled by the create operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",,
"fieldAndValue": {
"name": "wso2",
"description":"This Account belongs to MWARE ESB"
}
}Sample Response
Given below is a sample response for the create operation.
{
"success":true,
"id":"0010K00001uiAn8QAE",
"errors":[
]
}createMultipleRecords
To create multiple records of the same sObject type, use salesforcerest.createMultipleRecords and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object for which you will create a record. | Yes | Account |
| fieldAndValue | The .json format property, which specifies each record as an entry within the records array. Include all mandatory fields according to the requirements for the specified sObject. | Yes | {
"records": [
{
"attributes": {"type": "Account", "referenceId": "ref1"},
"name": "wso2",
"phone": "1111111",
"website": "www.salesforce1.com"
},
{
"attributes": {"type": "Account", "referenceId": "ref2"},
"name": "slwso2",
"phone": "22222222",
"website": "www.salesforce2.com"
}]
}
|
Note: For example, if you are creating a record for the Account sObject, "name" is a mandatory parameter, and you might want to include the optional description, so the fieldAndValue property would look like this:
{ "records": [ { "attributes": {"type": "Account", "referenceId": "ref1"}, "name": "wso2", "phone": "1111111", "website": "www.salesforce1.com" }, { "attributes": {"type": "Account", "referenceId": "ref2"}, "name": "slwso2", "phone": "22222222", "website": "www.salesforce2.com" }] }
Sample configuration
<salesforcerest.createMultipleRecords>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</salesforcerest.createMultipleRecords>Sample request
The following is a sample request that can be handled by the createMultipleRecords operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",,
"fieldAndValue": {
"records": [
{
"attributes": {"type": "Account", "referenceId": "ref1"},
"name": "wso2",
"phone": "1111111",
"website": "www.salesforce1.com"
},
{
"attributes": {"type": "Account", "referenceId": "ref2"},
"name": "slwso2",
"phone": "22222222",
"website": "www.salesforce2.com"
}]
}
}Sample Response
Given below is a sample response for the createMultipleRecords operation.
{
"hasErrors" : false,
"results" : [{
"referenceId" : "ref1",
"id" : "001D000000K1YFjIAN"
},{
"referenceId" : "ref2",
"id" : "001D000000K1YFkIAN"
},{
"referenceId" : "ref3",
"id" : "001D000000K1YFlIAN"
},{
"referenceId" : "ref4",
"id" : "001D000000K1YFmIAN"
}]
}createNestedRecords
To create nested records for a specific sObject, use salesforcerest.createNestedRecords and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object for which you will create a record. | Yes | |
| fieldAndValue | The .json format property, which specifies each record as an entry within the records array. Include all mandatory fields according to the requirements for the specified sobject. | Yes | {
"records" :[{
"attributes" : {"type" : "Account", "referenceId" : "ref1"},
"name" : "SampleAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"type" : "Analyst",
"industry" : "Banking",
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref2"},
"lastname" : "Smith",
"Title" : "President",
"email" : "sample@salesforce.com"
},{
"attributes" : {"type" : "Account", "referenceId" : "ref3"},
"lastname" : "Evans",
"title" : "Vice President",
"email" : "sample@salesforce.com"
}]
}
},{
"attributes" : {"type" : "Account", "referenceId" : "ref4"},
"name" : "SampleAccount2",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "52000",
"type" : "Analyst",
"industry" : "Banking",
"childAccounts" : {
"records" : [{
"attributes" : {"type" : "Account", "referenceId" : "ref5"},
"name" : "SampleChildAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"type" : "Analyst",
"industry" : "Banking"
}]
},
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref6"},
"lastname" : "Jones",
"title" : "President",
"email" : "sample@salesforce.com"
}]
}
}]
}
|
Note: For example, if you are creating records for the Account sObject, "name" is a mandatory parameter, and you might want to include additional optional values for each record, so the fieldAndValue property might look like this:
{ "records" :[{ "attributes" : {"type" : "Account", "referenceId" : "ref1"}, "name" : "SampleAccount1", "phone" : "1234567890", "website" : "www.salesforce.com", "numberOfEmployees" : "100", "type" : "Analyst", "industry" : "Banking", "Contacts" : { "records" : [{ "attributes" : {"type" : "Contact", "referenceId" : "ref2"}, "lastname" : "Smith", "Title" : "President", "email" : "sample@salesforce.com" },{ "attributes" : {"type" : "Contact", "referenceId" : "ref3"}, "lastname" : "Evans", "title" : "Vice President", "email" : "sample@salesforce.com" }] } },{ "attributes" : {"type" : "Account", "referenceId" : "ref4"}, "name" : "SampleAccount2", "phone" : "1234567890", "website" : "www.salesforce.com", "numberOfEmployees" : "52000", "type" : "Analyst", "industry" : "Banking", "childAccounts" : { "records" : [{ "attributes" : {"type" : "Account", "referenceId" : "ref5"}, "name" : "SampleChildAccount1", "phone" : "1234567890", "website" : "www.salesforce.com", "numberOfEmployees" : "100", "type" : "Analyst", "industry" : "Banking" }] }, "Contacts" : { "records" : [{ "attributes" : {"type" : "Contact", "referenceId" : "ref6"}, "lastname" : "Jones", "title" : "President", "email" : "sample@salesforce.com" }] } }] }
Sample configuration
<salesforcerest.createNestedRecords>
<sObjectName>{$ctx:sObjectName}</sobject>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</salesforcerest.createNestedRecords>Sample request
The following is a sample request that can be handled by the createNestedRecords operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",,
"fieldAndValue":
{
"records" :[{
"attributes" : {"type" : "Account", "referenceId" : "ref1"},
"name" : "SampleAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"type" : "Analyst",
"industry" : "Banking",
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref2"},
"lastname" : "Smith",
"Title" : "President",
"email" : "sample@salesforce.com"
},{
"attributes" : {"type" : "Account", "referenceId" : "ref3"},
"lastname" : "Evans",
"title" : "Vice President",
"email" : "sample@salesforce.com"
}]
}
},{
"attributes" : {"type" : "Account", "referenceId" : "ref4"},
"name" : "SampleAccount2",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "52000",
"type" : "Analyst",
"industry" : "Banking",
"childAccounts" : {
"records" : [{
"attributes" : {"type" : "Account", "referenceId" : "ref5"},
"name" : "SampleChildAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"type" : "Analyst",
"industry" : "Banking"
}]
},
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref6"},
"lastname" : "Jones",
"title" : "President",
"email" : "sample@salesforce.com"
}]
}
}]
}
}Sample Response
Given below is a sample response for the createNestedRecords operation.
{
"hasErrors" : false,
"results" : [{
"referenceId" : "ref1",
"id" : "001D000000K0fXOIAZ"
},{
"referenceId" : "ref4",
"id" : "001D000000K0fXPIAZ"
},{
"referenceId" : "ref2",
"id" : "003D000000QV9n2IAD"
},{
"referenceId" : "ref3",
"id" : "003D000000QV9n3IAD"
},{
"referenceId" : "ref5",
"id" : "001D000000K0fXQIAZ"
},{
"referenceId" : "ref6",
"id" : "003D000000QV9n4IAD"
}]
}update
To update a record, use salesforcerest.update and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The type of object for which you will create a record. | Yes | Account |
| fieldAndValue | The json format property with the new definition for the record. | Yes | {
"name": "wso2",
"description":"This Account belongs to MWARE ESB"
}
|
| Id | The ID of the record you are updating. | Yes | 00128000002OOhD |
Sample configuration
<salesforcerest.update>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
<Id>{$ctx:Id}</Id>
</salesforcerest.update>Sample request
The following is a sample request that can be handled by the update operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"Id":"00128000002OOhD",,
"fieldAndValue": {
"name": "wso2",
"description":"This Account belongs to MWARE ESB"
}
}delete
To delete a record, use salesforcerest.delete and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type of the record. | Yes | Account |
| Id | The ID of the record you are deleting. | Yes | 00128000002OOhD |
Sample configuration
<salesforcerest.update>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
<Id>{$ctx:Id}</Id>
</salesforcerest.update>Sample request
The following is a sample request that can be handled by the delete operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"idToDelete":"00128000002OOhD",
}recentlyViewedItem
To retrieve the recently viewed items, use salesforcerest.recentlyViewedItem and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| limit | The maximum number of records to be returned. | Yes | 5 |
Sample configuration
<salesforcerest.recentlyViewedItem>
<limit>{$ctx:limit}</limit>
</salesforcerest.recentlyViewedItem>Sample request
The following is a sample request that can be handled by the recentlyViewedItem operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"limit":"5",
}Sample Response
Given below is a sample response for the recentlyViewedItem operation.
{
"output":"[{\"attributes\":
{\"type\":\"User\",
\"url\":\"/services/data/v32.0/sobjects/User/00528000000ToIrAAK\"},
\"Id\":\"00528000000ToIrAAK\",
\"Name\":\"kesan yoga\"},
.
.
]"
}retrieveFieldValues
To retrieve specific field values for a specific sObject, use salesforcerest.retrieveFieldValues and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose metadata you want to retrieve. | Yes | Account |
| rowId | The ID of the record whose values you want to retrieve. | Yes | 00128000005YjDnAAK |
| fields | A comma-separated list of fields whose values you want to retrieve. | Yes | AccountNumber,BillingPostalCode |
Sample configuration
<salesforcerest.recentlyViewedItem>
<limit>{$ctx:limit}</limit>
</salesforcerest.recentlyViewedItem>Sample request
The following is a sample request that can be handled by the retrieveFieldValues operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"rowId":"00128000005YjDnAAK",
"fields":"AccountNumber,BillingPostalCode",
}Sample Response
Given below is a sample response for the retrieveFieldValues operation.
{
"AccountNumber" : "CD656092",
"BillingPostalCode" : "27215",
}upsert
To create or update (upsert) a record using an external ID, use salesforcerest.upsert and specify the following properties. This method is used to create records or update existing records based on the value of a specified external ID field. See the related API documentation for more information.
* If the specified value does not exist, a new record is created.
* If a record does exist with that value, the field values specified in the request body are updated.| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose value you want to upsert. | Yes | Account |
| externalIDField | The external Id Field of the subject. | Yes | sample__c |
| Id | The value of the customExtIdField. | Yes | 15222 |
| fieldAndValue | The json format property/payload used to create the record. | Yes | { "Name":"john" } |
Sample configuration
<salesforcerest.upsert>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<externalIDField>{$ctx:externalIDField}</externalIDField>
<Id>{$ctx:Id}</Id>
<fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</salesforcerest.upsert>Sample request
The following is a sample request that can be handled by the upsert operation.
{
"accessToken":"00D280000017q6q!AQoAQMMZWoN9MQZcXLW475YYoIdJFUICTjbGh67jEfAeV7Q57Ac2Ov.0ZuM_2Zx6SnrOmwpml8Qf.XclstTQiXtCYSGRBcEv",
"apiUrl":"https://(your_instance).salesforce.com",
"clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
"refreshToken": "5Aep861TSESvWeug_ztpnAk6BGQxRdovMLhHso81iyYKO6hTm68KfebpK7UYtEzF0ku8JCz7CNto8b3YMRmZrhy",
"clientSecret": "9104967092887676680",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",,
"intervalTime" : "2400000",
"externalIDField":"sample__c",
"Id":"15222",
"fieldAndValue":
{
"Name":"john"
}
}Sample Response
Given below is a sample response for the upsert operation.
{
"id" : "00190000001pPvHAAU",
"errors" : [ ],
"success" : true
}getDeleted
To retrieve a list of individual records that have been deleted within the given timespan for the specified object, use salesforcerest.getDeleted. The date and time should be provided in ISO 8601 format:YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object where you want to look for deleted records | Yes | Account |
| startTime | Starting date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-05T12:30:30+05:30 |
| endTime | Ending date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-10T20:30:30+05:30 |
Sample configuration
<salesforcerest.getDeleted>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<startTime>{$ctx:startTime}</startTime>
<endTime>{$ctx:endTime}</endTime>
</salesforcerest.getDeleted>Sample request
The following is a sample request that can be handled by the getDeleted operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"startTime":"2015-10-05T12:30:30+05:30",
"endTime":"2015-10-10T20:30:30+05:30"
}Sample Response
Given below is a sample response for the getDeleted operation.
{
"earliestDateAvailable":"2018-09-20T07:52:00.000+0000",
"deletedRecords":[
],
"latestDateCovered":"2018-10-27T15:00:00.000+0000"
}getUpdated
To retrieve a list of individual records that have been updated within the given timespan for the specified object, use salesforcerest.getUpdated. The date and time should be provided in ISO 8601 format:YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object where you want to look for updated records | Yes | Account |
| startTime | Starting date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-05T12:30:30+05:30 |
| endTime | Ending date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-10T20:30:30+05:30 |
Sample configuration
<salesforcerest.getUpdated>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<startTime>{$ctx:startTime}</startTime>
<endTime>{$ctx:endTime}</endTime>
</salesforcerest.getUpdated>Sample request
The following is a sample request that can be handled by the getUpdated operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"startTime":"2015-10-05T12:30:30+05:30",
"endTime":"2015-10-10T20:30:30+05:30"
}Sample Response
Given below is a sample response for the getDeleted operation.
{
"ids":[
],
"latestDateCovered":"2018-10-27T15:00:00.000+0000"
}sObjects¶
describeGlobal
To retrieve a list of the objects that are available in the system, use salesforcerest.describeGlobal. You can then get metadata for an object or objects as described in the next sections. See the related API documentation for more information.
Sample configuration
<salesforcerest.describeGlobal/>Sample request
The following is a sample request that can be handled by the describeGlobal operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the describeGlobal operation.
{
"maxBatchSize":200,
"sobjects":[
{
"updateable":false,
"activateable":false,
"deprecatedAndHidden":false,
"layoutable":false,
"custom":false,
"deletable":false,
"replicateable":false,
"undeletable":false,
"label":"Accepted Event Relation",
"keyPrefix":null,
"searchable":false,
"queryable":true,
"mergeable":false,
"urls":{
"rowTemplate":"/services/data/v32.0/sobjects/AcceptedEventRelation/{ID}",
"describe":"/services/data/v32.0/sobjects/AcceptedEventRelation/describe",
"sobject":"/services/data/v32.0/sobjects/AcceptedEventRelation"
},
"createable":false,
"feedEnabled":false,
"retrieveable":true,
"name":"AcceptedEventRelation",
"customSetting":false,
"labelPlural":"Accepted Event Relations",
"triggerable":false
},
.
.
],
"encoding":"UTF-8"
}describeSObject
To get metadata (such as name, label, and fields, including the field properties) for a specific object type, use salesforcerest.describeSObject and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose metadata you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.describeSObject>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.describeSObject>Sample request
The following is a sample request that can be handled by the describeSObject operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
}Sample Response
Given below is a sample response for the describeSObject operation.
{
"updateable":true,
"activateable":false,
"childRelationships":[
{
"relationshipName":"ChildAccounts",
"field":"ParentId",
"deprecatedAndHidden":false,
"childSObject":"Account",
"cascadeDelete":false,
"restrictedDelete":false
},
{
"relationshipName":"AccountCleanInfos",
"field":"AccountId",
"deprecatedAndHidden":false,
"childSObject":"AccountCleanInfo",
"cascadeDelete":true,
"restrictedDelete":false
},
.
]
}listAvailableApiVersion
To retrieve a list of summary information about each REST API version that is currently available, use salesforcerest.listAvailableApiVersion. See the related API documentation for more information.
Sample configuration
<salesforcerest.listAvailableApiVersion/>Sample request
The following is a sample request that can be handled by the listAvailableApiVersion operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the listAvailableApiVersion operation.
{
"output":"[
{\"label\":\"Winter '11\",\"url\":\"/services/data/v20.0\",\"version\":\"20.0\"},
.
.
]"
}listOrganizationLimits
To retrieve the limit information for your organization, use salesforcerest.listOrganizationLimits. See the related API documentation for more information.
Sample configuration
<salesforcerest.listOrganizationLimits/>Sample request
The following is a sample request that can be handled by the listOrganizationLimits operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the listOrganizationLimits operation.
{
"DailyApiRequests":{
"Dataloader Bulk":{
"Max":0,
"Remaining":0
},
"test":{
"Max":0,
"Remaining":0
},
"Max":5000,
"Salesforce Mobile Dashboards":{
"Max":0,
"Remaining":0
},
.
.
}listResourcesByApiVersion
To retrieve the resources that are available in the specified API version, use salesforcerest.listResourcesByApiVersion. You can then get the details of those resources. See the related API documentation for more information.
Sample configuration
<salesforcerest.listResourcesByApiVersion/>Sample request
The following is a sample request that can be handled by the listResourcesByApiVersion operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the listResourcesByApiVersion operation.
{
"tooling":"/services/data/v32.0/tooling",
"folders":"/services/data/v32.0/folders",
"eclair":"/services/data/v32.0/eclair",
"prechatForms":"/services/data/v32.0/prechatForms",
"chatter":"/services/data/v32.0/chatter",
"tabs":"/services/data/v32.0/tabs",
"appMenu":"/services/data/v32.0/appMenu",
"quickActions":"/services/data/v32.0/quickActions",
"queryAll":"/services/data/v32.0/queryAll",
"commerce":"/services/data/v32.0/commerce",
.
}sObjectBasicInfo
To retrieve the individual metadata for the specified object, use salesforcerest.sObjectBasicInfo. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose metadata you want to retrieve. | Yes | Account |
Sample configuration
<salesforcerest.sObjectBasicInfo>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.sObjectBasicInfo>Sample request
The following is a sample request that can be handled by the sObjectBasicInfo operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
}Sample Response
Given below is a sample response for the sObjectBasicInfo operation.
{
"objectDescribe":{
"updateable":true,
"activateable":false,
"deprecatedAndHidden":false,
"layoutable":true,
"custom":false,
"deletable":true,
"replicateable":true,
"undeletable":true,
"label":"Account",
"keyPrefix":"001",
"searchable":true,
"queryable":true,
"mergeable":true,
"urls":{
"compactLayouts":"/services/data/v32.0/sobjects/Account/describe/compactLayouts",
"rowTemplate":"/services/data/v32.0/sobjects/Account/{ID}"
},
"createable":true,
"feedEnabled":true,
"retrieveable":true,
"name":"Account",
"customSetting":false,
"labelPlural":"Accounts",
"triggerable":true
},
.
}sObjectGetDeleted
To retrieve a list of individual records that have been deleted within the given timespan for the specified object, use salesforcerest.sObjectGetDeleted. The date and time should be provided in ISO 8601 format:YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose metadata you want to retrieve. | Yes | Account |
| startTime | Starting date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-05T12:30:30+05:30 |
| endTime | Ending date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-10T20:30:30+05:30 |
Sample configuration
<salesforcerest.sObjectGetDeleted>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<startTime>{$ctx:startTime}</startTime>
<endTime>{$ctx:endTime}</endTime>
</salesforcerest.sObjectGetDeleted>Sample request
The following is a sample request that can be handled by the sObjectGetDeleted operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"startTime":"2015-10-05T12:30:30+05:30",
"endTime":"2015-10-10T20:30:30+05:30",
}Sample Response
Given below is a sample response for the sObjectGetDeleted operation.
{
"objectDescribe":{
"updateable":true,
"activateable":false,
"deprecatedAndHidden":false,
"layoutable":true,
"custom":false,
"deletable":true,
"replicateable":true,
"undeletable":true,
"label":"Account",
"keyPrefix":"001",
"searchable":true,
"queryable":true,
"mergeable":true,
"urls":{
"compactLayouts":"/services/data/v32.0/sobjects/Account/describe/compactLayouts",
"rowTemplate":"/services/data/v32.0/sobjects/Account/{ID}"
},
"createable":true,
"feedEnabled":true,
"retrieveable":true,
"name":"Account",
"customSetting":false,
"labelPlural":"Accounts",
"triggerable":true
},
.
}sObjectGetUpdated
To retrieve a list of individual records that have been updated within the given timespan for the specified object, use salesforcerest.sObjectGetUpdated. The date and time should be provided in ISO 8601 format:YYYY-MM-DDThh:mm:ss+hh:mm. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type whose metadata you want to retrieve. | Yes | Account |
| startTime | Starting date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-05T12:30:30+05:30 |
| endTime | Ending date/time (Coordinated Universal Time (UTC)—not local—timezone) of the timespan for which to retrieve the data. | Yes | 2015-10-10T20:30:30+05:30 |
Sample configuration
<salesforcerest.sObjectGetUpdated>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<startTime>{$ctx:startTime}</startTime>
<endTime>{$ctx:endTime}</endTime>
</salesforcerest.sObjectGetUpdated>Sample request
The following is a sample request that can be handled by the sObjectGetUpdated operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"startTime":"2015-10-05T12:30:30+05:30",
"endTime":"2015-10-10T20:30:30+05:30",
}Sample Response
Given below is a sample response for the sObjectGetUpdated operation.
{
"ids":[
],
"latestDateCovered":"2018-10-27T15:00:00.000+0000"
}sObjectPlatformAction
To retrieve the description of the PlatformAction, use salesforcerest.sObjectPlatformAction. See the related API documentation for more information.
Sample configuration
<salesforcerest.sObjectPlatformAction/>Sample request
The following is a sample request that can be handled by the sObjectPlatformAction operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the sObjectPlatformAction operation.
{
"objectDescribe":{
"updateable":false,
"activateable":false,
"deprecatedAndHidden":false,
"layoutable":false,
"custom":false,
"deletable":false,
"replicateable":false,
"undeletable":false,
"label":"Platform Action",
"keyPrefix":"0JV",
"searchable":false,
"queryable":true,
"mergeable":false,
"urls":{
"rowTemplate":"/services/data/v32.0/sobjects/PlatformAction/{ID}",
"describe":"/services/data/v32.0/sobjects/PlatformAction/describe",
"sobject":"/services/data/v32.0/sobjects/PlatformAction"
},
"createable":false,
"feedEnabled":false,
"retrieveable":false,
"name":"PlatformAction",
"customSetting":false,
"labelPlural":"Platform Actions",
"triggerable":false
},
"recentItems":[
]
}sObjectRows
To retrieve details of a specific record, use salesforcerest.sObjectRows. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectName | The object type of the record. | Yes | Account |
| rowId | The ID of the record whose details you want to retrieve. | Yes | 00128000005YjDnAAK |
Sample configuration
<salesforcerest.sObjectRows>
<sObjectName>{$ctx:sObjectName}</sObjectName>
<rowId>{$ctx:rowId}</rowId>
</salesforcerest.sObjectRows>Sample request
The following is a sample request that can be handled by the sObjectRows operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName":"Account",
"rowId":"00128000005YjDnAAK",
}Sample Response
Given below is a sample response for the sObjectRows operation.
{
"AccountNumber" : "CD656092",
"BillingPostalCode" : "27215"
}Search¶
search
To search for records, use salesforcerest.search and specify the search string. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| searchString | The SQL query to use to search for records. | Yes | sample string |
Sample configuration
<salesforcerest.search>
<searchString>{$ctx:searchString}</searchString>
</salesforcerest.search>Sample request
The following is a sample request that can be handled by the search operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"searchString": "FIND {map*} IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead",
}Sample Response
Given below is a sample response for the search operation.
{
{"output":"[{\"attributes\":{\"type\":\"Account\",\"url\":\"/services/data/v32.0/sobjects/Account/00128000005dMcSAAU\"},\"Id\":\"00128000005dMcSAAU\",\"Name\":\"GenePoint\"}]"}
}searchScopeAndOrder
To retrieve the search scope and order for the currently logged-in user, use salesforcerest.searchScopeAndOrder. See the related API documentation for more information.
Sample configuration
<salesforcerest.searchScopeAndOrder/>Sample request
The following is a sample request that can be handled by the searchScopeAndOrder operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
}Sample Response
Given below is a sample response for the searchScopeAndOrder operation.
{
{"output":"[]"}
}searchResultLayout
To retrieve the search result layouts for one or more sObjects, use salesforcerest.searchResultLayout and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| sObjectNameList | A comma-delimited list of the objects whose search result layouts you want to retrieve. | Yes | Account,User |
Sample configuration
<salesforcerest.searchResultLayout>
<sObjectNameList>{$ctx:sObjectNameList}</sObjectNameList>
</salesforcerest.searchResultLayout>Sample request
The following is a sample request that can be handled by the searchResultLayout operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectNameList": "Account,User",
}Sample Response
Given below is a sample response for the searchResultLayout operation.
{
{"output":"[{\"errorMsg\":null,\"label\":\"Search Results\",\"limitRows\":25,\"objectType\":\"Account\",\"searchColumns\":[{\"field\":\"Account.Name\",\"format\":null,\"label\":\"Account Name\",\"name\":\"Name\"},{\"field\":\"Account.Site\",\"format\":null,\"label\":\"Account Site\",\"name\":\"Site\"},.]"}
}searchSuggestedRecords
To return a list of suggested records whose names match the user’s search string, use salesforcerest.searchSuggestedRecords and specify the following properties. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| stringForSearch | The object type that the search is scoped to. | Yes | hari |
| sObjectName | The SOQL query to execute the search. | Yes | Account |
Sample configuration
<salesforcerest.searchSuggestedRecords>
<stringForSearch>{$ctx:stringForSearch}</stringForSearch>
<sObjectName>{$ctx:sObjectName}</sObjectName>
</salesforcerest.searchSuggestedRecords>Sample request
The following is a sample request that can be handled by the searchSuggestedRecords operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"sObjectName": "Account",
"stringForSearch": "hari",
}Sample Response
Given below is a sample response for the searchSuggestedRecords operation.
{
{"autoSuggestResults":[],"hasMoreResults":false}
}Users¶
getUserInformation
To retrieve information about a specific user, use salesforcerest.getUserInformation and specify the following property. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| userId | The ID of the user whose information you want to retrieve. | Yes | 00528000000yl7j |
Sample configuration
<salesforcerest.getUserInformation>
<userId>{$ctx:userId}</userId>
</salesforcerest.getUserInformation>Sample request
The following is a sample request that can be handled by the getUserInformation operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"userId": "00528000000yl7j",
}Sample Response
Given below is a sample response for the getUserInformation operation.
{
"ProfileId":"00e28000000xIEQAA2",
"LastModifiedDate":"2016-11-29T05:40:45.000+0000",
"Address":{
"country":"LK",
"city":null,
"street":null,
"latitude":null,
"postalCode":null,
"geocodeAccuracy":null,
"state":null,
"longitude":null
},
"LanguageLocaleKey":"en_US",
"EmailPreferencesAutoBccStayInTouch":false
.
.
}resetPassword
To reset the password of a specific user, use salesforcerest.resetPassword and specify the following property. See the related API documentation for more information.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| userId | The ID of the user whose information you want to retrieve. | Yes | 00528000000yl7j |
Sample configuration
<salesforcerest.getUserInformation>
<userId>{$ctx:userId}</userId>
</salesforcerest.getUserInformation>Sample request
The following is a sample request that can be handled by the getUserInformation operation.
{
"accessToken":"XXXXXXXXXXXX (Replace with your access token)",
"apiUrl":"https://(your_instance).salesforce.com",
"hostName": "https://login.salesforce.com",
"apiVersion": "v32.0",
"userId": "00528000000yl7j",
}Sample Response
Given below is a sample response for the getUserInformation operation.
{
"NewPassword" : "myNewPassword1234"
}Reports¶
getReport
To retrieve information about a report, use salesforcerest.getReport and specify the following property. See the related API documentation for more information.
Note: This operation is available only with Salesforce REST Connector v1.1.2 and above.
| Parameter Name | Description | Required | Sample Value |
|---|---|---|---|
| reportId | The ID of the report that you want to retrieve. | Yes | 00O8d000004MWaGEAW |
Sample configuration
<salesforcerest.getReport>
<reportId>{$ctx:reportId}</reportId>
</salesforcerest.getReport>Sample request
The following is a sample request that can be handled by the getReport operation.
{
"reportId": "00O8d000004MWaGEAW",
}Sample Response
Given below is a sample response from the getReport operation.
{
"attributes": {
"describeUrl": "/services/data/v55.0/analytics/reports/00O8d000004MWaGEAW/describe",
"instancesUrl": "/services/data/v55.0/analytics/reports/00O8d000004MWaGEAW/instances",
"reportId": "00O8d000004MWaGEAW",
"reportName": "SampleReport",
"type": "Report"
},
"allData": true,
"factMap": {
"T!T": {
"aggregates": [
{
"label": "13",
"value": 13
}
],
"rows": [
{
"dataCells": [
{
"label": "Customer - Direct",
"recordId": "0018d00000FgQblAAF",
"value": "Customer - Direct"
},
{
"label": "Warm",
"recordId": "0018d00000FgQblAAF",
"value": "Warm"
},
{
"label": "-",
"recordId": "0018d00000FgQblAAF",
"value": null
},
{
"label": "16/08/2022",
"value": "2022-08-15"
},
.
.
.
]
}
]
}
}
}