Nav

Salesforce Connector Reference v9.1.0

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

  • Password

  • OAuth v2.0

  • OAuth JWT

  • OAuth SAML

  • OAuth Username Password

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees it fit.

Fetch All Apex SOAP Metadata

Boolean

If checked then DataSense is performed for all Apex classes in the organization, otherwise it is performed only for the classes in Apex class names. If the organization contains a lot of Apex classes this might cause ConnectionTimeout during DataSense. Default value is false.

false

Fetch All Apex REST Metadata

Boolean

If checked, DataSense occurs for all Apex classes in the organization, otherwise DataSense only occurs for the classes in Apex class names. If the organization contains many Apex classes, this can cause a ConnectionTimeout during DataSense. Default value is false.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Username Password Connection Type

Parameters

Name Type Description Default Value Required

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP has been white listed on Salesforce

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.

https://login.salesforce.com/services/Soap/u/41.0

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

PoolingProfile

Characteristics of the connection pool

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

Client Id

String

Client ID for partners.

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceExtension#getUpdatedObjects.

Batch Sobject Max Depth

Number

Creating a batch creates SObjects using this value for the MAX_DEPTH check.

5

Session Id

String

Service Endpoint

String

Disable session invalidation

Boolean

If set to true, the session is not invalidated if the connection pool decides a connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with a null value. Default value is false.

false

Host

String

Host name of the proxy. If this property is not set, a proxy is not used. If the property is set, you must use a proxy and specify a proxy host.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

OAuth v2.0 Connection Type

Parameters

Name Type Description Default Value Required

Display

Enumeration, one of:

  • PAGE

  • POPUP

  • TOUCH

x

Immediate

Enumeration, one of:

  • TRUE

  • FALSE

FALSE

Prompt

Enumeration, one of:

  • LOGIN

  • CONSENT

LOGIN

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

PoolingProfile

Characteristics of the connection pool.

Read Timeout

Number

Specifies the amount of time in milliseconds that the consumer waits for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time in milliseconds that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

Client Id

String

Client ID for partners.

Time Object Store

ObjectStore

An Object Store instance to use in SalesforceExtension#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch creates SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

41.0

Disable session invalidation

Boolean

If set to true, the session is not invalidated if the connection pool decides a connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, to clear a field, a name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Host

String

Host name of the proxy. If this property is not set, a proxy is not used. If the property is set, you must use a proxy and specify a proxy host.

Port

Number

Port of the proxy. If host is set, this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Consumer Key

String

The OAuth consumerKey as registered with the service provider.

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider.

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL

https://login.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to be executed right before starting the OAuth dance.

After

String

The name of a flow to be executed right after an accessToken has been received.

Listener Config

String

A reference to a <http:listener-config /> to be used to create the listener that catches the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint.

x

Authorize Path

String

The path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback.

Object Store

String

A reference to the object store to use to store data for each resource owner ID. If not specified, runtime automatically provisions the default object store.

OAuth JWT Connection Type

Parameters

Name Type Description Default Value Required

Consumer Key

String

Consumer key for Salesforce connected app.

x

Key Store

String

Path to key store used to sign data during authentication.

x

Store Password

String

Password of key store.

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

PoolingProfile

Characteristics of the connection pool.

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

Client Id

String

Client ID for partners.

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceExtension#getUpdatedObjects.

Batch Sobject Max Depth

Number

Creating a batch creates SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

41.0

Disable session invalidation

Boolean

If set to true, the session is not invalidated if the connection pool decides a connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false. No change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with a null value. Default value is false.

false

Host

String

Host name of the proxy. If this property is not set, a proxy is not used. If the property is set, you must use a proxy and specify a proxy host.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

OAuth SAML Connection Type

Parameters

Name Type Description Default Value Required

Consumer Key

String

Consumer key for Salesforce connected app.

x

Key Store

String

Path to key store used to sign data during authentication

x

Store Password

String

Password of key store

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

PoolingProfile

Characteristics of the connection pool

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

Client Id

String

Client ID for partners.

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceExtension#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch creates SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

41.0

Disable session invalidation

Boolean

If set to true, the session is not invalidated if the connection pool decides a connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with a null value. Default value is false.

false

Host

String

Host name of the proxy. If this property is not set, a proxy is not used. If the property is set, you must use a proxy and specify a proxy host.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

OAuth Username Password Connection Type

Parameters

Name Type Description Default Value Required

Consumer Key

String

Consumer key for Salesforce connected app

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user.

x

Security Token

String

User’s security token. It can be omitted if your IP has been white listed on Salesforce.

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

PoolingProfile

Characteristics of the connection pool

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer attempts to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

Client Id

String

Client ID for partners.

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceExtension#getUpdatedObjects.

Batch Sobject Max Depth

Number

Creating a batch creates SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

41.0

Disable session invalidation

Boolean

If set to true, the session is not invalidated if the connection pool decides a connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, to clear a field, its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with a null value. Default value is false.

false

Host

String

Host name of the proxy. If this property is not set, a proxy is not used. If the property is set, you must use a proxy and specify a proxy host.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Supported Operations

  • abortJob

  • batchInfo

  • batchInfoList

  • batchResult

  • batchResultStream

  • changeOwnPassword

  • closeJob

  • convertLead

  • create

  • createBatch

  • createBatchForQuery

  • createBatchStream

  • createBulk

  • createJob

  • createMetadata

  • createSingle

  • delete

  • deleteMetadata

  • deployMetadata

  • describeGlobal

  • describeMetadata

  • describeSobject

  • findDuplicates

  • findDuplicatesByIds

  • getDeleted

  • getDeletedRange

  • getServerTimestamp

  • getSessionId

  • getUpdated

  • getUpdatedObjects

  • getUpdatedRange

  • getUserInfo

  • hardDeleteBulk

  • invokeApexRestMethod

  • invokeApexSoapMethod

  • jobInfo

  • listMetadata

  • merge

  • nonPaginatedQuery

  • publishPlatformEventMessage

  • publishStreamingChannel

  • publishTopic

  • pushGenericEvent

  • query

  • queryAll

  • queryResultStream

  • querySingle

  • readMetadata

  • renameMetadata

  • resetPassword

  • retrieve

  • retrieveMetadata

  • search

  • setPassword

  • unauthorize

  • update

  • updateBulk

  • updateMetadata

  • updateSingle

  • upsert

  • upsertBulk

  • upsertMetadata

Associated Sources

  • deleted-object

  • modified-object

  • new-object

  • replay-channel

  • replay-topic

  • subscribe-channel

  • subscribe-topic

Operations

Abort Job

<salesforce:abort-job>

Aborts an open Job given its ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The Job ID identifying the Job to be aborted.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type JobInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Batch Info

<salesforce:batch-info>

Access latest BatchInfo of a submitted BatchInfo. Allows tracking of the execution status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

BatchInfo

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored

#[payload]

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Batch Info List

<salesforce:batch-info-list>

Get information about all batches in a job.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job Id

String

id of the job that you want to retrieve batch information for

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Batch Result

<salesforce:batch-result>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Batch Result Stream

<salesforce:batch-result-stream>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Change Own Password

<salesforce:change-own-password>

Changes the password of the user linked to the connector’s configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Old Password

String

The old password to be changed

x

New Password

String

The new password to be changed

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Close Job

<salesforce:close-job>

Closes an open Job given its ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The Job ID identifying the Job to be closed.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type JobInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Convert Lead

<salesforce:convert-lead>

Converts a Lead into an Account, Contact, or (optionally) an Opportunity.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Lead Convert Request

LeadConvertRequest

Information needed for lead conversion.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type LeadConvertResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create

<salesforce:create>

Adds one or more new records to your organization’s data.

When you map your objects to the input of this message processor, keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2018-02-13" it’s sent to Salesforce as a string, which rejects the operation because CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object using a Groovy expression evaluator such as #[groovy:Date.parse("yyyy-MM-dd", "2018-02-13")].

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of record to add.

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Batch

<salesforce:create-batch>

Creates a Batch using the given objects within the specified Job. The Job can be of XML or CSV type. This call uses the Bulk API. The operation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

JobInfo

The com.sforce.async.JobInfo in which the batch is created. The job can be of XML, JSON, or CSV type.

x

sObjects

Array of Object

A list of one or more sObject objects. This parameter defaults to payload content. The com.sforce.async.JobInfo in which the batch is created. The Job can be of XML, JSON, or CSV type.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check.

5

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Batch For Query

<salesforce:create-batch-for-query>

Creates a Batch using the given query. This call uses the Bulk API. The operation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

JobInfo

The JobInfo in which the batch is created.

x

Query

String

The query to be executed.

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Batch Stream

<salesforce:create-batch-stream>

Creates a Batch using the given stream within the specified Job. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format. This call uses the Bulk API. The operation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

JobInfo

The JobInfo in which the batch is created. This parameter defaults to payload content.

x

Stream

Binary

A stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Bulk

<salesforce:create-bulk>

Adds one or more new records to your organization’s data. This call uses the Bulk API. The creation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to create

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Job

<salesforce:create-job>

Creates a Job to perform one or more batches through Bulk API Operations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

The OperationEnum that is executed by the job.

x

Type

String

The type of Salesforce object that the job processes.

x

Create Job Request

CreateJobRequest

containing: externalIdFieldName - Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects (only required for Upsert Operations). contentType The Content Type for this Job results. When specifying a content type different from XML for a query type use queryResultStream(BatchInfo) method to retrieve results. concurrencyMode is the concurrency mode of the job, either Parallel or Serial.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type JobInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Create Metadata

<salesforce:create-metadata>

Create metadata: Adds one or more new metadata components to your organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The Metadata Type to be created

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to create.

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Create Single

<salesforce:create-single>

Adds one new record to your organization’s data.

When you map your objects to the input of this message processor, keep in mind that they need to match the expected type of the object at Salesforce.

Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2018-02-13" it’s sent to Salesforce as a string, which rejects the operation because CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object using a Groovy expression evaluator such as #[groovy:Date.parse("yyyy-MM-dd", "2018-02-13")].

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of record to add.

x

Record

Object

Record to add to your organization.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Delete

<salesforce:delete>

Deletes one or more records from your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Delete Metadata

<salesforce:delete-metadata>

Deletes one or more metadata components from your organization, given the object(s) API Name(s).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to delete

x

Full Names

Array of String

Full names of the components to delete

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Deploy Metadata

<salesforce:deploy-metadata>

Deploy. File-based call to deploy XML components. Use this call to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Deploy Metadata Request

DeployMetadataRequest

Data needed by this operation.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Describe Global

<salesforce:describe-global>

Retrieves a list of available objects for your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type DescribeGlobalResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Describe Metadata

<salesforce:describe-metadata>

Describe metadata: This call retrieves the metadata which describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type DescribeMetadataResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Describe Sobject

<salesforce:describe-sobject>

Describes metadata (field list and object properties) for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization.

x

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type DescribeSObject

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Find Duplicates

<salesforce:find-duplicates>

Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. findDuplicates() applies the rules to the values to do the search. The output identifies the detected duplicates for each sObject.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of sobjects to find duplicates for

x

Criteria

Array of Object

List of SObject used as a criterion when searching for duplicates.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of FindDuplicatesResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Find Duplicates By IDs

<salesforce:find-duplicates-by-ids>

Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. findDuplicatesByIds() applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List of object ids used when searching for duplicates

Array of String

List of IDs to find duplicates.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of FindDuplicatesResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Deleted

<salesforce:get-deleted>

Retrieves the list of individual records that have been deleted since a time in the past specified in minutes before now.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Duration

Number

The amount of time, counted from now to some point in the past, for which to return records.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type GetDeletedResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Deleted Range

<salesforce:get-deleted-range>

Retrieves the list of individual records that have been deleted since a time in the past specified in minutes before now.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Start

DateTime

Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

End

DateTime

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If it is not provided, the current server time is used.

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type GetDeletedResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Server Timestamp

<salesforce:get-server-timestamp>

Retrieves the current system timestamp (Coordinated Universal Time (UTC) time zone) from the API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type DateTime

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Session ID

<salesforce:get-session-id>

Retrieves the Session ID of the current session.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type String

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Updated

<salesforce:get-updated>

Retrieves the list of individual records that have been created or updated within the given time frame for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Duration

Number

The amount of time in minutes, counted from now to some point in the past, to specify the range you want updated records from.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type GetUpdatedResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Updated Objects

<salesforce:get-updated-objects>

Retrieves the list of records that have been updated between the last time this method was called and now. This method saves the timestamp of the latest date covered by Salesforce represented by GetUpdatedResult#latestDateCovered. IMPORTANT: To use this method in a reliable way, ensure that right after this method returns, the result is stored in a persistent way since the timestamp of the latest. To reset the latest update time use resetUpdatedObjectsTimestamp(String).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Initial Time Window

Number

Time window (in minutes) used to calculate the start time (in time range) the first time this operation is called. For example, if initialTimeWindow equals 2, the start time is the current time (now) minus 2 minutes, then the range to retrieve the updated object is (now - 2 minutes; now). After first call the start time is calculated from the object store getting the last time this operation was exec.

x

Fields

Array of String

The fields to retrieve for the updated objects.

x

Update Headers

RequestHeaders

Salesforce Headers

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get Updated Range

<salesforce:get-updated-range>

Retrieves the list of individual records that have been created/updated within the given time frame for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Start

DateTime

Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

End

DateTime

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If it is not provided, the current server time is used.

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type GetUpdatedResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Get User Info

<salesforce:get-user-info>

Retrieves personal information for the user associated with the current session.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type GetUserInfoResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Hard Delete Bulk

<salesforce:hard-delete-bulk>

Deletes one or more records from your organization’s data. The deleted records are not stored in the Recycle Bin. Instead, they become immediately eligible for deletion. This call uses the Bulk API. The deletion occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to delete

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check.

5

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Invoke Apex Rest Method

<salesforce:invoke-apex-rest-method>

Invokes any operation from an Apex class that is exposed as REST web service

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Object

Object containing request information.

#[payload]

Apex Class Name

String

x

Apex Class Method Name

String

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:RETRY_EXHAUSTED

Invoke Apex Soap Method

<salesforce:invoke-apex-soap-method>

Invokes any operation from an Apex class that is exposed as SOAP web service.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input

Binary

Input Stream with an XML containing information about the method to be invoked and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Apex Class Name

String

x

Apex Class Method Name

String

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:RETRY_EXHAUSTED

Job Info

<salesforce:job-info>

Access latest JobInfo of a submitted JobInfo. Allows to track execution status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

the Job ID of the Job being monitored

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type JobInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

List Metadata

<salesforce:list-metadata>

Retrieves property information about metadata components in your organization

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type used as criteria when querying for information

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of FileProperties

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Merge

<salesforce:merge>

Merge up to three records into one.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Records To Merge Ids

Array of String

A list of ids of the objects to be merged

#[payload]

Type

String

type of record to be merged

x

Master Record

Object

Must provide the ID of the object that other records is merged into. Optionally, provide the fields to be updated and their values.

x

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type MergeResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Non Paginated Query

<salesforce:non-paginated-query>

Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the appropriate type using DataWeave in a Transform Message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Publish Platform Event Message

<salesforce:publish-platform-event-message>

Adds one new platform event to your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Event name

String

name of platform event to create

x

Platform Event Message

Object

PlatformEventMessage to create

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Publish Streaming Channel

<salesforce:publish-streaming-channel>

Creates a streaming channel on which generic, custom messages can be pushed.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Channel Name

String

Descriptive name of the StreamingChannel. Limit: 80 characters, must start with "/u/". This value identifies the channel and must be unique.

x

Owner Id

String

Identifier fir the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit: 255 characters

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Publish Topic

<salesforce:publish-topic>

Creates a topic representing a query, which is used to notify listeners when changes are made to records in an organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Name

String

x

Query

String

x

Description

String

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Push Generic Event

<salesforce:push-generic-event>

Pushes generic streaming custom events to the specified streaming channel.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Events

Array of GenericStreamingEvent

The event list

x

Channel Id

String

The streaming channel name

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of PushEventResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Query

<salesforce:query>

Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the appropriate type using DataWeave in a Transform Message..

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

map with values for placeholders within salesforceQuery

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure if repeatable streams should be used and their behavior.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Query All

<salesforce:query-all>

Retrieves data from specified objects, whether or not they have been deleted.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure if repeatable streams should be used and their behavior.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Query Result Stream

<salesforce:query-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo. Internally the InputStreams contained in the sequence is requested on-demand (lazy-loading). They should be used only with query jobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

BatchInfo

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored.

#[payload]

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Query Single

<salesforce:query-single>

Executes a query against the specified object and returns the first record that matches the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery.

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Read Metadata

<salesforce:read-metadata>

Returns one or more metadata components from your organization, given the object(s) API Name(s). . === Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to read

x

Full Names

Array of String

List of full names of the components to read.

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Rename Metadata

<salesforce:rename-metadata>

Renames a Metadata component in your organization, given its old API Name and the new name.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to rename.

x

Old Full Name

String

The current component full name

x

New Full Name

String

The new component full name

x

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Reset Password

<salesforce:reset-password>

Resets the password of the user linked to the connector’s configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

User Id

String

The user to reset the password for. If not set, the current user is used.

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ResetPasswordResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Retrieve

<salesforce:retrieve>

Retrieves one or more records based on the specified IDs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be retrieved

x

Retrieve Request

RetrieveRequest

Must provide the ID of the object that other records is merged into. Optionally, provide the fields to be updated and their values.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Retrieve Metadata

<salesforce:retrieve-metadata>

Retrieve. This call retrieves XML file representations of components in an organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Package Names

Array of String

A list of package names to be retrieved. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null.

Unpackaged

Binary

A stream containing a list of components to retrieve that are not in a package.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

<salesforce:search>

Search for objects using Salesforce Object Search Language. Mimics using the search box inside the Salesforce UI.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders within searchString

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type SearchResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Set Password

<salesforce:set-password>

Change the password of a User or SelfServiceUser to a value that you specify.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

User Id

String

The user to set the password for.

x

New Password

String

The new password for the user.

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Unauthorize

<salesforce:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner to invalidate.

For Configurations

  • sfdc-config

Update

<salesforce:update>

Updates one or more existing records in your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of record to update.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Update Bulk

<salesforce:update-bulk>

Updates one or more existing records in your organization’s data. This call uses the Bulk API. The creation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to update

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check.

5

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Update Metadata

<salesforce:update-metadata>

Updates one or more metadata components in your organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the updated components.

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to update.

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Update Single

<salesforce:update-single>

Updates one record in your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of object to update.

x

Record

Object

Record to upsert in your organization.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Result

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Upsert

<salesforce:upsert>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

Type

String

Type of record to upsert.

x

Records

Array of Object

Records to add to your organization.

#[payload]

Headers

Object

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of UpsertResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Upsert Bulk

<salesforce:upsert-bulk>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records. This call uses the Bulk API. The creation occurs asynchronously.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

The type of the given objects. The list of objects to upsert must be homogeneous.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

sObjects

Array of Object

The objects to upsert

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check.

5

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type BatchInfo

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:INVALID_REQUEST_DATA

Upsert Metadata

<salesforce:upsert-metadata>

Creates or updates one or more metadata components in your organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to create or update.

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to upsert.

#[payload]

Target Variable

String

The name of a variable to store this operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of UpsertResult

For Configurations

  • sfdc-config

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:UNKNOWN

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:INVALID_REQUEST_DATA

Sources

Deleted Object

<salesforce:deleted-object>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

Specify a date in the YYYY-MM-DD hh:mm:ss format, such as 2018-03-12 16:30:40. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy.

Configures the scheduler that triggers the polling.

x

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

Attributes Type

Any

For Configurations

  • sfdc-config

Modified Object

<salesforce:modified-object>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

Specify a date in the YYYY-MM-DD hh:mm:ss format, such as 2018-03-12 16:30:40. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy.

Configures the scheduler that triggers the polling.

x

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

Attributes Type

Any

For Configurations

  • sfdc-config

New Object

<salesforce:new-object>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

Specify a date in the YYYY-MM-DD hh:mm:ss format, such as 2018-03-12 16:30:40. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy.

Configures the scheduler that triggers the polling.

x

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Object

Attributes Type

Any

For Configurations

  • sfdc-config

Replay Channel

<salesforce:replay-channel>

Subscribe to a streaming channel. First the streaming channel must be published and after that a subscription to that channel created. Salesforce lets you subscribe to an inexistent streaming channel, but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Channel

String

The name of the streaming channel to subscribe to.

x

Replay Option

Enumeration, one of:

  • FROM_REPLAY_ID

  • ONLY_NEW

  • ALL

Enum with the following values: ONLY_NEW: -1 Subscriber receives new events that are broadcast after the client subscribes. ALL: -2 Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription. FROM_REPLAY_ID: Subscriber only receives events with a replay ID value greater than the specified replay ID.

x

Replay Id

String

Subscriber receives all events after the event specified by its replayId value. The value is ignored if replay option is set on ALL or ONLY_NEW.

Resume from the Last Replay Id

Boolean

If true, when a source starts, it starts to consume data from where it was left last time.

false

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Any

Attributes Type

Any

For Configurations

  • sfdc-config

Replay Topic

<salesforce:replay-topic>

Salesforce stores events for 24 hours and allows you to retrieve stored and new events. Subscribers can choose which events to receive by using replay options.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic

String

x

Replay Option

Enumeration, one of:

  • FROM_REPLAY_ID

  • ONLY_NEW

  • ALL

Enum with the following values: ONLY_NEW: -1 Subscriber receives new events that are broadcast after the client subscribes. ALL: -2 Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription. FROM_REPLAY_ID: Subscriber only receives events with a replay ID value greater than the specified replay ID.

x

Replay Id

String

Subscriber receives all events after the event specified by its replayId value. The value is ignored if replay option is set on ALL or ONLY_NEW.

Resume from the Last Replay Id

Boolean

If true, when a source starts, it starts to consume data from where it was left last time.

false

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Any

Attributes Type

Any

For Configurations

  • sfdc-config

Subscribe Channel

<salesforce:subscribe-channel>

Subscribe to a streaming channel. First the streaming channel must be published and after that a subscription to that channel created. Attention: Salesforce lets you subscribe to an inexistent streaming channel but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Channel

String

The name of the streaming channel to subscribe to

x

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Any

Attributes Type

Any

For Configurations

  • sfdc-config

Subscribe Topic

<salesforce:subscribe-topic>

Subscribe to a topic. First the topic must be published and after that a subscription to that topic created.

Note: Salesforce lets you subscribe to an inexistent topic, but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic

String

x

Primary Node Only

Boolean

Whether this source should only execute on the primary node when running in a cluster.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Any

Attributes Type

Any

For Configurations

  • sfdc-config

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects is evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which throws a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which blocks by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which creates a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it blocks for at most that many milliseconds, after which a NoSuchElementException is thrown. If maxThreadWait is a negative value, it blocks indefinitely.

Initialization Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (loads one initial component into the pool on startup), or INITIALISE_ALL (loads all components in the pool on startup).

Disabled

Boolean

Whether pooling should be disabled.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it’s expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much is buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Job Info

Field Type Description Default Value Required

Apex Processing Time

Number

Api Active Processing Time

Number

Api Version

Number

Assignment Rule Id

String

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Created By Id

String

Created Date

DateTime

External Id Field Name

String

Fast Path Enabled

Boolean

Id

String

Number Batches Completed

Number

Number Batches Failed

Number

Number Batches In Progress

Number

Number Batches Queued

Number

Number Batches Total

Number

Number Records Failed

Number

Number Records Processed

Number

Number Retries

Number

Object

String

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

System Modstamp

DateTime

Total Processing Time

Number

Batch Info

Field Type Description Default Value Required

Apex Processing Time

Number

Api Active Processing Time

Number

Created Date

DateTime

Id

String

Job Id

String

Number Records Failed

Number

Number Records Processed

Number

State

Enumeration, one of:

  • Queued

  • InProgress

  • Completed

  • Failed

  • NotProcessed

State Message

String

System Modstamp

DateTime

Total Processing Time

Number

Batch Result

Field Type Description Default Value Required

Partial Result

Boolean

Result

Array of Result

Result

Field Type Description Default Value Required

Errors

Array of Error

Id

String

Success

Boolean

Error

Field Type Description Default Value Required

Fields

Array of String

Message

String

Status Code

String

Lead Convert Result

Field Type Description Default Value Required

Account Id

String

Contact Id

String

Errors

Array of Error

Lead Id

String

Opportunity Id

String

Success

Boolean

Lead Convert Request

Field Type Description Default Value Required

Contact Id

String

ID of the Contact into which the lead is merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact. Note: If you are converting a lead into a person account, do not specify the contactId or an error results. Specify only the accountId of the person account. If no contactID is specified, then the API creates a new contact that is implicitly associated with the Account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read/write access to the specified contact. The contact name and other existing data are not overwritten (unless overwriteLeadSource is set to true, in which case only the LeadSource field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the Account into which the lead is merged. Required only when updating an existing account, including person accounts. If no accountID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read/write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default).

false

Opportunity Name

String

Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If doNotCreateOpportunity argument is true, then no Opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an Opportunity during lead conversion (false, the default) or not (true). Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). To set this field to true, the client application must specify a contactId for the target contact.

false

Opportunity Id

String

The ID of an existing opportunity to relate to a lead during lead conversion.

Create Job Request

Field Type Description Default Value Required

External Id Field Name

String

Content Type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Deploy Metadata Request

Field Type Description Default Value Required

Stream

Binary

A stream containing the data. This parameter defaults to payload content.

x

Ignore Warnings

Boolean

Indicates whether a warning should allow a deployment to complete successfully (true) or not (false).

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file aren’t stored in the Recycle Bin. This option only works in Developer Edition or sandbox organizations; it doesn’t work in production organizations.

false

Rollback On Error

Boolean

Indicates whether any failure causes a complete rollback (true) or not (false).

true

Describe Global Result

Field Type Description Default Value Required

Encoding

String

Max Batch Size

Number

Sobjects

Array of DescribeGlobalSObjectResult

Describe Global S Object Result

Field Type Description Default Value Required

Activateable

Boolean

Createable

Boolean

Custom

Boolean

Custom Setting

Boolean

Deletable

Boolean

Deprecated And Hidden

Boolean

Feed Enabled

Boolean

Key Prefix

String

Label

String

Label Plural

String

Layoutable

Boolean

Mergeable

Boolean

Mru Enabled

Boolean

Name

String

Queryable

Boolean

Replicateable

Boolean

Retrieveable

Boolean

Searchable

Boolean

Triggerable

Boolean

Undeleteable

Boolean

Updateable

Boolean

Describe Metadata Result

Field Type Description Default Value Required

Metadata Objects

Array of DescribeMetadataObject

Organization Namespace

String

Partial Save Allowed

Boolean

Test Required

Boolean

Describe Metadata Object

Field Type Description Default Value Required

Child XML Names

Array of String

Directory Name

String

In Folder

Boolean

Meta File

Boolean

Suffix

String

XML Name

String

Describe S Object

Field Type Description Default Value Required

Action Overrides

Array of ActionOverride

Activateable

Boolean

Child Relationships

Array of ChildRelationship

Compact Layoutable

Boolean

Createable

Boolean

Custom

Boolean

Custom Setting

Boolean

Deletable

Boolean

Deprecated And Hidden

Boolean

Feed Enabled

Boolean

Fields

Array of Field

Key Prefix

String

Label

String

Label Plural

String

Layoutable

Boolean

Mergeable

Boolean

Mru Enabled

Boolean

Name

String

Named Layout Infos

Array of NamedLayoutInfo

Network Scope Field Name

String

Queryable

Boolean

Record Type Infos

Array of RecordTypeInfo

Replicateable

Boolean

Retrieveable

Boolean

Search Layoutable

Boolean

Searchable

Boolean

Triggerable

Boolean

Undeletable

Boolean

Updateable

Boolean

Url Detail

String

Url Edit

String

Url New

String

Action Override

Field Type Description Default Value Required

Available In Touch

Boolean

From Factor

String

Name

String

Page Id

String

Url

String

Child Relationship

Field Type Description Default Value Required

Cascade Delete

Boolean

Child S Object

String

Deprecated And Hidden

Boolean

Field

String

Relationship Name

String

Field

Field Type Description Default Value Required

Autonumber

Boolean

Byte Length

Number

Calculated

Boolean

Case Sensitive

Boolean

Controller Name

String

Createable

Boolean

Custom

Boolean

Default Value Formula

String

Defaulted On Create

Boolean

Dependent Pick List

Boolean

Deprecate And Hidden

Boolean

Digits

Number

Display Location In Decimal

Boolean

Encrypted

Boolean

Extra Type Info

String

Filterable

Boolean

Filtered Lookup Info

FilteredLookupInfo

Formula

String

Groupable

Boolean

High Scale Number

Boolean

Html Formatted

Boolean

Id Lookup

Boolean

Inline Help Text

String

Label

String

Length

Number

Mask

String

Mask Type

String

Name

String

Name Field

Boolean

Name Pointing

Boolean

Nullable

Boolean

Permissionable

Boolean

Picklist Values

Array of PickListEntry

Polymorphic Foreign Key

Boolean

Precision

Number

Reference Target Field

String

Reference To

Array of String

Relationship Name

String

Relationship Order

Number

Restricted Picklist

Boolean

Scale

Number

Search Filterable

Boolean

Sortable

Boolean

Type

Enumeration, one of:

  • STRING

  • BOOLEAN

  • INTEGER

  • DOUBLE

  • DATE

  • DATETIME

  • BASE64

  • ID

  • REFERENCE

  • CURRENCY

  • TEXTAREA

  • PERCENT

  • PHONE

  • URL

  • EMAIL

  • COMBOBOX

  • PICKLIST

  • MULTIPICKLIST

  • ANY_TYPE

  • DATA_CATEGORY_GROUP_REF

  • ENCRIPTED_STRING

  • ADDRESS

  • COMPLEX_VALUE

  • LOCATION

Unique

Boolean

Updateable

Boolean

Write Requires Master Read

Boolean

Filtered Lookup Info

Field Type Description Default Value Required

Controlling Fields

Array of String

Dependent

Boolean

Optional Filter

Boolean

Pick List Entry

Field Type Description Default Value Required

Active

Boolean

Default Value

Boolean

Label

String

Valid For

Binary

Value

String

Named Layout Info

Field Type Description Default Value Required

Name

String

Record Type Info

Field Type Description Default Value Required

Available

Boolean

Default Record Type Mapping

Boolean

Id

String

Master

Boolean

Name

String

Find Duplicates Result

Field Type Description Default Value Required

Duplicate Results

Array of DuplicateResult

Errors

Array of Error

Success

Boolean

Duplicate Result

Field Type Description Default Value Required

Allow Save

Boolean

Duplicate Rule

String

Duplicate Rule Entity Type

String

Error Message

String

Match Results

Array of MatchResult

Match Result

Field Type Description Default Value Required

Entity Type

String

Errors

Array of Error

Match Engine

String

Match Records

Array of MatchRecord

Rule

String

Size

Number

Success

Boolean

Match Record

Field Type Description Default Value Required

Additional Information

Array of AdditionalInformationMap

Field Diffs

Array of FieldDiff

Match Confidence

Number

Record

Object

Additional Information Map

Field Type Description Default Value Required

Name

String

Value

String

Field Diff

Field Type Description Default Value Required

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Name

String

Get Deleted Result

Field Type Description Default Value Required

Deleted Records

Array of DeletedRecord

Earliest Date Available

DateTime

Latest Date Covered

DateTime

Deleted Record

Field Type Description Default Value Required

Deleted Date

DateTime

Id

String

Get Updated Result

Field Type Description Default Value Required

Ids

Array of String

Latest Date Covered

DateTime

Request Headers

Field Type Description Default Value Required

Headers

Object

Get User Info Result

Field Type Description Default Value Required

Accessibility Mode

Boolean

Currency Symbol

String

Org Attachment File Size Limit

Number

Org Default Currency ISO Code

String

Org Default Currency Locale

String

Org Disallow Html Attachments

Boolean

Org Has Person Accounts

Boolean

Organization Id

String

Organization Multi Currency

Boolean

Organization Name

String

Profile Id

String

Role Id

String

Session Seconds Valid

Number

User Default Currency ISO Code

String

User Email

String

User Full Name

String

User Id

String

User Language

String

User Locale

String

User Name

String

User Time Zone

String

User Type

String

User Ui Skin

String

File Properties

Field Type Description Default Value Required

Created By

String

Created By Name

String

Created Date

DateTime

File Name

String

Full Name

String

Id

String

Last Modified By Id

String

Last Modified By Name

String

Last Modified Date

String

Manageable State

Enumeration, one of:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

Namespace Prefix

String

Type

String

Merge Result

Field Type Description Default Value Required

Errors

Array of Error

Id

String

Merged Record Ids

Array of String

Success

Boolean

Updated Related Ids

Array of String

Push Event Result

Field Type Description Default Value Required

Fanout Count

Number

User Online Status

Object

Generic Streaming Event

Field Type Description Default Value Required

Payload

String

User Ids

Array of String

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it’s expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

The number of instances to initially allow in memory to enable the connector to consume the stream and provide random access to its data. If the stream contains more data than can fit in this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum number of instances to keep in memory. If more are required, the connector starts buffering the disk contents.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Reset Password Result

Field Type Description Default Value Required

Password

String

Retrieve Request

Field Type Description Default Value Required

Fields

Array of String

Ids

Array of String

Search Result

Field Type Description Default Value Required

Query Id

String

Search Records

Array of SearchRecord

Search Results Metadata

SearchResultsMetadata

Search Record

Field Type Description Default Value Required

Record

Object

Search Record Metadata

SearchRecordMetadata

Snippet

SearchSnippet

Search Record Metadata

Field Type Description Default Value Required

Spell Corrected

Boolean

Search Snippet

Field Type Description Default Value Required

Text

String

Whole Fields

Array of NameValuePair

Name Value Pair

Field Type Description Default Value Required

Name

String

Value

String

Search Results Metadata

Field Type Description Default Value Required

Entity Label Metadata

Array of LabelsSearchMetadata

Entity Metadata

Array of EntitySearchMetadata

Labels Search Metadata

Field Type Description Default Value Required

Entity Field Labels

Array of NameValuePair

Entity Name

String

Entity Search Metadata

Field Type Description Default Value Required

Entity Name

String

Field Metadata

Array of FieldLevelSearchMetadata

Field Level Search Metadata

Field Type Description Default Value Required

Label

String

Name

String

Type

String

Upsert Result

Field Type Description Default Value Required

Created

Boolean

Errors

Array of Error

Id

String

Success

Boolean

In this topic: