Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with Quick Actions. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with Quick Actions, see Sample configuration

To retrieve
OperationDescription
Working with Quick Action
quickActionsRetrieves a list of global actions.
sObjectAction
To retrieve
Retrieves a list of object-specific actions.

Working with Quick Action

To retrieve

getSpecificAction

Retrieves a specific action for a specific object.
Working with Quick ActionTo retrieve
getDescribeSpecificActionRetrieves the description of a specific action for a specific object.
Working with Quick ActionTo return
getDefaultValueOfActionRetrieves a specific action’s default values, including default field values.

Operation details

This section provides further details on the operations related to Quick Actions. Quick Actions Returns return a list of global actions and object-specific actions.

Anchor
quickActions
quickActions

...

Retrieving quick actions

To retrieve a list of global actions, use salesforcerest.quickActions.

Code Block
languagexml
titlequickActions
<salesforcerest.quickActions/>

...

Sample request

Following is a sample REST request that can be handled by the quickActions operation.

Code Block
languagexml
titleSample request for quickActions operation
{
  "accessToken":"00D280000017q6q!AQoAQOeXcp7zKo3gUdy6r064_LsJ5bYYrUn_qAZG9TtKFLPfUMRxiato.E162_2XAtCTZLFQTbNk2Rz6Zm_juSakFE_aaBPp",
  "apiUrl":"https://ap2.salesforce.com",
  "clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
  "refreshToken": "5Aep861TSESvWeug_xvFHRBTTbf_YrTWgEyjBJo7Xr34yOQ7GCFUN5DnNPxzDIoGoWi4evqOl_lT1B9nE5dAtSb",
  "clientSecret": "9104967092887676680",
  "hostName": "https://login.salesforce.com",
  "intervalTime" : "100000",
  "apiVersion": "v32.0",
  "registryPath": "connectors/SalesforceRest"
 }
Related Salesforce REST

...

documentation

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_quickactions.htm

Anchor
sObjectActions
sObjectActions

...

Retrieving quick actions for a specific object

To retrieve a list of object-specific actions, use salesforcerest.sObjectAction and specify the following property.

Code Block
languagexml
titlesObjectAction
<salesforcerest.sObjectAction>
    <sobject><sObjectName>{$ctx:sobjectsObjectName}</sobject>sObjectName>
</salesforcerest.sObjectAction>
Properties
  • sobject
    sObjectName: The type of object
    for that we are going to retrieve a list of quick action.

...

  •  for which you want to retrieve a list of quick actions.
Sample request

Following is a sample REST request that can be handled by the sObjectAction operation.

Code Block
languagexml
titleSample request for sObjectAction operation
{
  "accessToken":"00D280000017q6q!AQoAQOeXcp7zKo3gUdy6r064_LsJ5bYYrUn_qAZG9TtKFLPfUMRxiato.E162_2XAtCTZLFQTbNk2Rz6Zm_juSakFE_aaBPp",
  "apiUrl":"https://ap2.salesforce.com",
  "clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
  "refreshToken": "5Aep861TSESvWeug_xvFHRBTTbf_YrTWgEyjBJo7Xr34yOQ7GCFUN5DnNPxzDIoGoWi4evqOl_lT1B9nE5dAtSb",
  "clientSecret": "9104967092887676680",
  "hostName": "https://login.salesforce.com",
  "intervalTime" : "100000",
  "apiVersion": "v32.0",
  "sobjectsObjectName": "Account",
  "registryPath": "connectors/SalesforceRest"
 }

 

Related Salesforce REST

...

documentation

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_quickactions.htm

Anchor
getSpecificAction
getSpecificAction

...

Retrieving a specific

...

action

To retrieve a specific action for a specific object, use salesforcerest.getSpecificAction and specify the following properties.

Code Block
languagexml
titlegetSpecificAction
<salesforcerest.getSpecificAction>
    <actionName>{$ctx:actionName}</actionName>
</salesforcerest.getSpecificAction>
Properties
  • actionName: The specific action to return.
Anchor
request
request
Sample request

Following is a sample REST request that can be handled by the getSpecificAction operation.

Code Block
languagexml
titleSample request for getSpecificAction operation
{
  "accessToken":"00D280000017q6q!AQoAQOeXcp7zKo3gUdy6r064_LsJ5bYYrUn_qAZG9TtKFLPfUMRxiato.E162_2XAtCTZLFQTbNk2Rz6Zm_juSakFE_aaBPp",
  "apiUrl":"https://ap2.salesforce.com",
  "clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
  "refreshToken": "5Aep861TSESvWeug_xvFHRBTTbf_YrTWgEyjBJo7Xr34yOQ7GCFUN5DnNPxzDIoGoWi4evqOl_lT1B9nE5dAtSb",
  "clientSecret": "9104967092887676680",
  "hostName": "https://login.salesforce.com",
  "intervalTime" : "100000",
  "apiVersion": "v32.0",
  "actionName":"hariprasath__LogACall",
  "registryPath": "connectors/SalesforceRest"
 }

 

Related Salesforce REST

...

documentation

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_quickactions.htm

Anchor
getDescribeSpecificAction
getDescribeSpecificAction

...

Retrieving the description of a specific action

...

To retrieve the description of a specific action for a specific object, use salesforcerest.getDescribeSpecificAction and specify the following properties.

Code Block
languagexml
titlegetDescribeSpecificAction
<salesforcerest.getDescribeSpecificAction>
    <actionName>{$ctx:actionName}</actionName>
</salesforcerest.getDescribeSpecificAction>

Properties
  • actionName: The specific action .

...

  • whose description you want to retrieve.
Sample request

Following is a sample REST request that can be handled by the getDescribeSpecificAction operation.

Code Block
languagexml
titleSample request for getDescribeSpecificAction operation
{
  "accessToken":"00D280000017q6q!AQoAQOeXcp7zKo3gUdy6r064_LsJ5bYYrUn_qAZG9TtKFLPfUMRxiato.E162_2XAtCTZLFQTbNk2Rz6Zm_juSakFE_aaBPp",
  "apiUrl":"https://ap2.salesforce.com",
  "clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
  "refreshToken": "5Aep861TSESvWeug_xvFHRBTTbf_YrTWgEyjBJo7Xr34yOQ7GCFUN5DnNPxzDIoGoWi4evqOl_lT1B9nE5dAtSb",
  "clientSecret": "9104967092887676680",
  "hostName": "https://login.salesforce.com",
  "intervalTime" : "100000",
  "apiVersion": "v32.0",
  "actionName":"hariprasath__LogACall",
  "registryPath": "connectors/SalesforceRest"
 }
Related Salesforce REST

...

documentation

https://developer.salesforce.com/docs/atlas.en-us.198.0.api_rest.meta/api_rest/resources_sobject_quickactions.htm

Anchor
getDefaultValueOfAction
getDefaultValueOfAction

...

Retrieving a specific action’s default values

To Return return a specific action’s default values, including default field values, use salesforcerest.getDefaultValueOfAction and specify the following properties.

Code Block
languagexml
titlegetDefaultValueOfAction
<salesforcerest.getDefaultValueOfAction>
    <actionName>{$ctx:actionName}</actionName>
</salesforcerest.getDefaultValueOfAction>
Properties
  • actionName: The specific action.

...

Sample request

Following is a sample REST request that can be handled by the getDefaultValueOfAction operation.

Code Block
languagexml
titleSample request for getDefaultValueOfAction operation
{
  "accessToken":"00D280000017q6q!AQoAQOeXcp7zKo3gUdy6r064_LsJ5bYYrUn_qAZG9TtKFLPfUMRxiato.E162_2XAtCTZLFQTbNk2Rz6Zm_juSakFE_aaBPp",
  "apiUrl":"https://ap2.salesforce.com",
  "clientId": "3MVG9ZL0ppGP5UrBrnsanGUZRgHqc8gTV4t_6tfuef8Zz4LhFPipmlooU6GBszpplbTzVXXWjqkGHubhRip1s",
  "refreshToken": "5Aep861TSESvWeug_xvFHRBTTbf_YrTWgEyjBJo7Xr34yOQ7GCFUN5DnNPxzDIoGoWi4evqOl_lT1B9nE5dAtSb",
  "clientSecret": "9104967092887676680",
  "hostName": "https://login.salesforce.com",
  "intervalTime" : "100000",
  "apiVersion": "v32.0",
  "actionName":"hariprasath__LogACall",
  "registryPath": "connectors/SalesforceRest"
 }
Related Salesforce REST

...

documentation

https://developer.salesforce.com/docs/atlas.en-us.198.0.api_rest.meta/api_rest/resources_sobject_quickactions.htm

Anchor
sample
sample
Sample configuration

Following is a sample proxy service that illustrates how to connect to salesforce Salesforce with the init operation and then use the getSpecificAction operation. The sample request for this proxy can be found in the create sample getSpecificAction sample request.

Code Block
languagexml
titleSample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse" name="getSpecificAction"
       statistics="disable" trace="disable" transports="https http">
    <target>
        <inSequence>
            <property name="accessToken" expression="json-eval($.accessToken)"/>
            <property name="apiUrl" expression="json-eval($.apiUrl)"/>
            <property name="actionName" expression="json-eval($.actionName)"/>
            <property name="clientId" expression="json-eval($.clientId)"/>
            <property name="refreshToken" expression="json-eval($.refreshToken)"/>
            <property name="clientSecret" expression="json-eval($.clientSecret)"/>
            <property name="hostName" expression="json-eval($.hostName)"/>
            <property name="apiVersion" expression="json-eval($.apiVersion)"/>
            <property name="registryPath" expression="json-eval($.registryPath)"/>
			<property name="intervalTime" expression="json-eval($.intervalTime)"/>
            <salesforcerest.init>
                <accessToken>{$ctx:accessToken}</accessToken>
                <apiUrl>{$ctx:apiUrl}</apiUrl>
                <apiVersion>{$ctx:apiVersion}</apiVersion>
                <hostName>{$ctx:hostName}</hostName>
                <clientSecret>{$ctx:clientSecret}</clientSecret>
                <clientId>{$ctx:clientId}</clientId>
                <refreshToken>{$ctx:refreshToken}</refreshToken>
                <registryPath>{$ctx:registryPath}</registryPath>
				<intervalTime>{$ctx:intervalTime}</intervalTime>
            </salesforcerest.init>
            <log category="INFO" level="full" separator=","/>
            <salesforcerest.getSpecificAction>
                <actionName>{$ctx:actionName}</actionName>
            </salesforcerest.getSpecificAction>
            <send/>
        </inSequence>
    </target>
</proxy>