String
Salesforce Connector 10.22 Reference - Mule 4
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. |
Anypoint Connector for Salesforce (Salesforce Connector) enables you to accelerate your Salesforce integrations across Sales Cloud, Service Cloud, Salesforce Platform, and Force.com. This connector gives you access to all Salesforce entities to enable automation of your business processes to help maximize your investments in services and solutions, such as enabling your sales teams, increasing revenue, and serving your customers better.
Configuration
Default Configuration for Salesforce Connector.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
Name for this configuration. Connectors reference the configuration with this name. |
x |
||
Connection |
Connection types for this configuration. |
x |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
|
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
|||
Fetch All Apex SOAP Metadata |
Boolean |
If |
|
|
Fetch All Apex REST Metadata |
Boolean |
If |
|
|
Apex Class Names |
Array of String |
List of Apex class names involved in metadata retrieval via DataSense. |
||
Include null values |
Boolean |
Includes null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only. |
|
Basic Authentication Connection Type
Uses a username and a password for authentication.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Connection Timeout parameter. |
|
|
Login Request Timeout |
Number |
How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to |
||
Login Request Time unit |
Enumeration, one of:
|
Time unit for the Login Request Timeout field. |
||
Proxy configuration |
Configures a proxy for outbound connections. |
|||
Object TTL |
Number |
How long an object in the connection pool lives if the object is not used. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Object TTL field. |
|
|
Max Entries |
Number |
Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released. |
|
|
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 is allowlisted on Salesforce. |
||
Authorization URL |
String |
Web service URL responsible for user authentication. This is the URL for the endpoint configured to handle SOAP authentication requests. It defaults to the URL that contains the latest API version supported by the connector, for example, |
||
Session Id |
String |
Value that identifies an active Salesforce session. |
||
Service Endpoint |
String |
Specifies the service endpoint. This value is used only if the Session Id configuration property is used. |
||
TLS configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
OAuth v2.0 Connection Type
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Connection Timeout parameter. |
|
|
Login Request Timeout |
Number |
How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to |
||
Login Request Time unit |
Enumeration, one of:
|
Time unit for the Login Request Timeout field. |
||
Proxy configuration |
Configures a proxy for outbound connections. |
|||
Object TTL |
Number |
How long an object in the connection pool lives if the object is not used. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Object TTL field. |
|
|
Max Entries |
Number |
Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released. |
|
|
Api Version |
Number |
API version used. Defaults to the latest API version supported by the connector. |
||
TLS configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
|||
Consumer Key |
String |
OAuth consumer key, as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret, as registered with the service provider. |
x |
|
Authorization Url |
String |
URL of the service provider’s authorization endpoint. |
|
|
Access Token Url |
String |
URL of the service provider’s access token endpoint. |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. |
||
Resource Owner Id |
String |
Resource owner ID to use with the authorization code grant type. |
||
Before |
String |
Name of the flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of the flow to execute immediately after receiving an access token. |
||
Listener Config |
String |
Configuration for the HTTP listener that listens for requests on the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. |
||
Object Store |
String |
Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
OAuth JWT Connection Type
Uses OAuth 2.0 with a JSON Web token (JWT) request for user authentication.
Salesforce Connector supports providing a signed certificate only if you use the SHA256withRSA algorithm for the OAuth JWT connection type.
|
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Connection Timeout parameter. |
|
|
Login Request Timeout |
Number |
How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to |
||
Login Request Time unit |
Enumeration, one of:
|
Time unit for the Login Request Timeout field. |
||
Proxy configuration |
Configures a proxy for outbound connections. |
|||
Object TTL |
Number |
How long an object in the connection pool lives if the object is not used. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Object TTL field. |
|
|
Max Entries |
Number |
Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released. |
|
|
Api Version |
Number |
API version used. Defaults to the latest API version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the Salesforce-connected app. |
x |
|
Key Store |
String |
Path to the keystore used to sign data during authentication. |
x |
|
Store Password |
String |
Password of the keystore. |
x |
|
Certificate Alias |
String |
Alias of the certificate. |
||
Principal |
String |
Username of the desired Salesforce user to take action on behalf of. |
x |
|
Token Endpoint |
String |
URL pointing to the server that provides the authentication token. According to Salesforce, the token endpoint is |
|
|
Audience Url |
String |
URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token. Use the authorization server’s URL for the audience value if implementing for a community: |
||
TLS configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
OAuth Username Password Connection Type
Uses OAuth 2.0 with a user and password for authentication.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Connection Timeout parameter. |
|
|
Login Request Timeout |
Number |
How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to |
||
Login Request Time unit |
Enumeration, one of:
|
Time unit for the Login Request Timeout field. |
||
Proxy configuration |
Configures a proxy for outbound connections. |
|||
Object TTL |
Number |
How long an object in the connection pool lives if the object is not used. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Object TTL field. |
|
|
Max Entries |
Number |
Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released. |
|
|
Api Version |
Number |
API version used. Defaults to the latest API version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the 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 is allowlisted on Salesforce. |
||
Token Endpoint |
String |
URL pointing to the server that provides the authentication token. According to Salesforce, the token endpoint is |
|
|
TLS configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
OAuth SAML Connection Type
OAuth SAML currently uses only Salesforce as an identity provider. Refer to Salesforce as a SAML Identity Provider to enable Salesforce as an identity provider. |
Uses OAuth 2.0 with a signed SAML 2.0 assertion to request an access token.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. Values less than one millisecond are converted to |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Connection Timeout parameter. |
|
|
Login Request Timeout |
Number |
How long the consumer waits to receive the login request before the request times out. Values less than one millisecond are converted to |
||
Login Request Time unit |
Enumeration, one of:
|
Time unit for the Login Request Timeout field. |
||
Proxy configuration |
Configures a proxy for outbound connections. |
|||
Object TTL |
Number |
How long an object in the connection pool lives if the object is not used. |
|
|
Time unit |
Enumeration, one of:
|
Time unit for the Object TTL field. |
|
|
Max Entries |
Number |
Specifies the amount of objects that live in the connection pool at a specific moment. When this number is reached and a new object is needed, no new object is created and the application waits until a connection is released. |
|
|
Api Version |
Number |
API version used. Defaults to the latest API version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the Salesforce-connected app. |
x |
|
Key Store |
String |
Path to the keystore used to sign data during authentication. |
x |
|
Store Password |
String |
Password of the keystore. |
x |
|
Certificate Alias |
String |
Alias of the certificate. |
||
Principal |
String |
Username of the desired Salesforce user to take action on behalf of. |
x |
|
Token Endpoint |
String |
URL pointing to the server that provides the authentication token. According to Salesforce, the token endpoint is |
|
|
TLS configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
Sources
The On Deleted Object, On Modified Object, and On New Object sources in Salesforce Connector use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs. For more information, see The Different Types of Object Stores Explained. |
On Deleted Object
<salesforce:deleted-object-listener>
Source that adds one or more whereConditions
in the query calling the method.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Object type. |
x |
|
Triggers Query |
String |
Query used to filter the trigger results, for example, |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling. |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On Modified Object
<salesforce:modified-object-listener>
Source for modified objects.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Object type. |
x |
|
Triggers Query |
String |
Query used to filter the trigger results, for example, |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling. |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New Object
<salesforce:new-object-listener>
Source for new objects.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Object type. |
x |
|
Triggers Query |
String |
Query used to filter the trigger results, for example, |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling. |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Replay Channel Listener
<salesforce:replay-channel-listener>
Source that subscribes to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Streaming Channel |
String |
Name of the streaming channel to subscribe to. |
x |
|
Cache Events In Memory |
Boolean |
When the processing flow is slow, cache events in memory to reduce quota consumption. |
|
|
Replay Option |
Enumeration, one of:
|
|
x |
|
Replay Id |
String |
Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to |
||
Replay Failed Events If Any or Resume from Last Replay Id |
Boolean |
If |
|
|
The size (in bytes) of the event queue (DEPRECATED) |
Number |
If the messages are not consumed fast enough and the buffer fills up, the source returns an |
|
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
|
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
Attributes. |
|
Replay Topic Listener
<salesforce:replay-topic-listener>
Salesforce stores events for 24 hours and enables you to retrieve stored and new events. Source in which subscribers choose which events to receive by using replay options.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Topic |
String |
Name of the topic to subscribe to. |
x |
|
Cache Events In Memory |
Boolean |
When the processing flow is slow, cache events in memory to reduce quota consumption. |
|
|
Replay Option |
Enumeration, one of:
|
|
x |
|
Replay Id |
String |
Subscriber receives all events after the event specified by this replay ID value. The value is ignored if the replay option is set to |
||
Replay Failed Events If Any or Resume from Last Replay Id |
Boolean |
If |
|
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
|
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
Attributes. |
|
Subscribe Channel Listener
<salesforce:subscribe-channel-listener>
Source that subscribes to a streaming channel. First, the streaming channel must be published and after that, a subscription to that streaming channel must be created. Salesforce allows you to subscribe to a nonexistent streaming channel but won’t send you notifications after the topic is created.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Streaming Channel |
String |
Name of the streaming channel to subscribe to. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
|
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
Attributes. |
|
Subscribe Topic Listener
<salesforce:subscribe-topic-listener>
Source that subscribes to a topic. First, the topic must be published and after that, a subscription to that topic must be created. Salesforce allows you to subscribe to a nonexistent topic but won’t send you notifications after the topic is created.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Topic |
String |
Name of the topic. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
|
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
Attributes. |
|
Operations
Abort Job
<salesforce:abort-job>
Aborts an open job given its ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Job ID that identifies the job to abort. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Abort Job Bulk Api V2
<salesforce:abort-job-bulk-api-v2>
Aborts an ongoing Bulk API v2 Job. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Abort Query Job Bulk Api V2
<salesforce:abort-query-job-bulk-api-v2>
Abort the indicated query job. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Id |
String |
ID of the query job to abort. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Batch Info
<salesforce:batch-info>
Accesses the latest BatchInfo of a submitted BatchInfo. Enables you to track the execution status.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch info |
BatchInfo that is monitored. |
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Batch Info List
<salesforce:batch-info-list>
Gets information about all batches in a job.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job Id |
String |
ID of the job to retrieve batch information for. |
x |
|
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Batch Info |
Batch Result
<salesforce:batch-result>
Accesses com.sforce.async.BatchResult
of a submitted BatchInfo.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch To Retrieve |
|
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Batch Result Stream
<salesforce:batch-result-stream>
Accesses com.sforce.async.BatchResult
of a submitted BatchInfo.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch To Retrieve |
|
|
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Output Encoding |
String |
Encoding of the payload that this operation outputs. |
||
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Change Own Password
<salesforce:change-own-password>
Changes the password of the user linked to the connector’s configuration.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Old Password |
String |
Old password to change. |
x |
|
New Password |
String |
New password to change. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Close Job
<salesforce:close-job>
Closes an open job given its ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Job ID identifying the job to close. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Convert Lead
<salesforce:convert-lead>
Converts a lead into an account, contact, or (optionally) an opportunity.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Lead Convert Request |
Information for lead conversion. |
|
||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
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, the objects must match the expected type of the object at Salesforce. For example, if you set the CloseDate field of an opportunity to a string of value 2011-12-13 , it is sent to Salesforce as a string. The operation is rejected because the CloseDate is not of the expected type. The correct way to map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")] .
|
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Type of record to add. |
x |
|
Records |
Array of Object |
Records to add to your organization. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
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. This operation is performed asynchronously.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job info |
|
x |
||
SObjects |
Array of Object |
List of one or more SObject objects. |
|
|
SObject Max Depth |
Number |
Asynchronous SObject recursive MAX_DEPTH check. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Create Batch For Query
<salesforce:create-batch-for-query>
Creates a batch using the given query. This call uses the Bulk API. This operation is performed asynchronously.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job info |
JobInfo in which the batch is created. |
x |
||
Query |
String |
Query to execute. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
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 and is performed asynchronously.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job info |
JobInfo in which the batch is created. |
|
x |
|
Stream |
Binary |
Stream containing the data. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Create Job
<salesforce:create-job>
Creates a job to perform one or more batches through Bulk API operations.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Operation |
Enumeration, one of:
|
OperationEnum that is executed by the job. |
x |
|
Type |
String |
Type of Salesforce object that the job processes. |
x |
|
Create Job Request |
Creates the job request. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Create Job Bulk Api V2
<salesforce:create-job-bulk-api-v2>
Creates a Bulk API v2 job containing the data to insert, update, delete, or upsert. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Type of object to work with. |
x |
|
sObjects |
Binary |
Array of one or more SObject objects. |
|
|
Operation |
Enumeration, one of:
|
Operation to execute. |
x |
|
Line Ending |
String |
Line ending of CSV data. |
|
|
Column Delimiter |
String |
Column delimiter of CSV data. |
|
|
Assignment Rule Id |
String |
ID of an assignment rule to run for a case or a lead. The assignment rule can be active or inactive. |
||
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 ID lookup field property for standard objects. |
||
Headers |
Object |
Salesforce headers. For information, see Create a Job in the Salesforce documentation. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Create Metadata
<salesforce:create-metadata>
Adds one or more new metadata components to your organization.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type to create. |
x |
|
Metadata Objects |
Array of Object |
List of Map<String,Object> representing the metadata to create. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
Create Query Job Bulk Api V2
<salesforce:create-query-job-bulk-api-v2>
Creates a query job. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Query |
String |
Query used to create the job. |
x |
|
Operation |
Enumeration, one of:
|
Operation used. |
|
|
Column Delimiter |
String |
Type of delimiter used. |
|
|
Line Ending |
String |
Line ending used. |
|
|
Headers |
Object |
Salesforce headers. For information, see Create a Query Job in the Salesforce documentation. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Delete
<salesforce:delete>
Deletes one or more records from your organization’s data.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Delete Job Bulk Api V2
<salesforce:delete-job-bulk-api-v2>
Deletes a Bulk API v2 Job. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Delete Metadata
<salesforce:delete-metadata>
Deletes one or more metadata components from your organization, given the API name of the objects.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type of the components to delete. |
x |
|
Full Names |
Array of String |
Full names of the components to delete. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
Delete Query Job Bulk Api V2
<salesforce:delete-query-job-bulk-api-v2>
Deletes a query job based on its ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Id |
String |
ID of the query job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Deploy Metadata
<salesforce:deploy-metadata>
A file-based call to deploy XML components. Use this operation to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Deploy Metadata Request |
Data needed by this operation. |
x |
||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Describe Global
<salesforce:describe-global>
Retrieves a list of available objects for your organization’s data.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Describe Metadata
<salesforce:describe-metadata>
Retrieves the metadata that 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.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Describe Sobject
<salesforce:describe-sobject>
Describes metadata (field list and object properties) for the specified object.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
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. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each SObject.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Type of SObjects to find duplicates for. |
x |
|
Criteria |
Array of Object |
List of SObjects used as a criterion when searching for duplicates. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Find Duplicates Result |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
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. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Ids List |
Array of String |
List of IDs to find duplicates. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Find Duplicates Result |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Get All Jobs Bulk Api V2
<salesforce:get-all-jobs-bulk-api-v2>
Retrieves all Bulk jobs. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Concurrency Mode |
Enumeration, one of:
|
Desired concurrency mode. |
|
|
Pk Chunking |
Boolean |
Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Bulk Job V2 Result |
Get All Query Jobs Bulk Api V2
<salesforce:get-all-query-jobs-bulk-api-v2>
Retrieves all Bulk query jobs.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Pk Chunking |
Boolean |
Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job. |
|
|
Job Type |
Enumeration, one of:
|
Job type. |
||
Concurrency Mode |
Enumeration, one of:
|
Desired concurrency mode. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Query Jobs Info Result |
Get Deleted
<salesforce:get-deleted>
Retrieves the list of records deleted from a particular time in the past (specified in minutes).
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Object type. The specified value must be a valid object for your organization. |
x |
|
Start Date |
DateTime |
Starting date or time, in Coordinated Universal Time (UTC), 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). |
x |
|
End Date |
DateTime |
Ending date or time, in Coordinated Universal Time (UTC), 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). |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Get Job State Bulk Api V2
<salesforce:get-job-state-bulk-api-v2>
Gets the state of a v2 Bulk job. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Get Query Job Info Bulk Api V2
<salesforce:get-query-job-info-bulk-api-v2>
Returns the details of a query job based on its ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Id |
String |
ID of the query job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Get Query Job Results Bulk Api V2
<salesforce:get-query-job-results-bulk-api-v2>
Returns the results of a query job based on its ID.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Id |
String |
ID of the query job. |
x |
|
Max Records Per Page |
Number |
Number of records that are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Get Server Timestamp
<salesforce:get-server-timestamp>
Retrieves the current system timestamp, in Coordinated Universal Time (UTC), from the API.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Get updated objects
<salesforce:get-updated>
Retrieves the list of individual records that are created or updated between the specified start and end date.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Object Type |
String |
Object type. The specified value must be a valid object for your organization. |
x |
|
Start Date |
DateTime |
Starting date or time, in Coordinated Universal Time (UTC), 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). |
x |
|
End Date |
DateTime |
Ending date or time, in Coordinated Universal Time (UTC), 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 a value is not provided, the current server time is used. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Get User Info
<salesforce:get-user-info>
Retrieves personal information for the user associated with the current session.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Invoke Apex Rest Method
<salesforce:invoke-apex-rest-method>
Invokes any operation from an Apex class that is exposed as a REST web service.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Request |
Object |
Object containing request information, some of which can include object
|
|
|
Apex Class Name |
String |
Apex class name. |
x |
|
Apex Class Method Name |
String |
Apex class method name. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Invoke Apex Soap Method
<salesforce:invoke-apex-soap-method>
Invokes any operation from an Apex class that is exposed as a SOAP web service.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Input |
Binary |
InputStream with XML that contains information about the method to invoke and its parameters. The XML must adhere to the WSDL standards. |
|
|
Apex Headers |
Object |
Parameters specifying the SOAP Headers to send to the API. For more information about the supported headers, see SOAP API and SOAP Headers for Apex. |
||
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Apex Class Name |
String |
Apex class name. |
x |
|
Apex Class Method Name |
String |
Apex class method name. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Job Info
<salesforce:job-info>
Accesses the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the execution status.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Job ID of the job that is monitored. |
x |
|
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
List Metadata
<salesforce:list-metadata>
Retrieves property information about metadata components in your organization.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type used as a criterion when querying for information. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of File Properties |
Merge
<salesforce:merge>
Merges up to three records into one record.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Records To Merge Ids |
Array of String |
List of IDs of the objects to merge. |
|
|
Type |
String |
Type of record to merge. |
x |
|
Master Record |
Object |
Must provide the ID of the object that other records are merged into. Optionally, provide the fields to update and their values. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Merge Multiple
<salesforce:merge-multiple>
Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine.
Limitations
-
The only supported object types are:
-
Lead
-
Contact
-
Account
-
Person Account
-
Individual
-
Only objects of the same type can be merged. For example, merge leads only with leads.
-
The Merge Multiple operation enables you to specify a list of a maximum of 200 merge requests.
-
A merge request can contain a maximum of three IDs:
-
The master record ID
-
Up to two IDs for the records to merge into the primary record
-
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
List of Merge Records |
Array of Merge Record |
List of merge records. Each merge record contains the primary record, the record to merge IDs into, and an optional additional information map. |
|
|
Headers |
Map<String, Object> |
Declares the request headers to use with this operation. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Merge Result |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Publish Platform Event Message
<salesforce:publish-platform-event-message>
Adds one new platform event to your organization’s data.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Platform Event name |
String |
Name of the platform event to create. |
x |
|
Platform Event Message |
Array of Object |
List<PlatformEventMessage> to create. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Result |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Publish Streaming Channel
<salesforce:publish-streaming-channel>
Creates a streaming channel in which generic, custom messages are pushed.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Channel name |
String |
Descriptive name of the streaming channel. Limit of 80 characters, and must start with |
x |
|
Owner Id |
String |
Identifier for the channel owner. |
||
Description |
String |
Description of what kinds of records are returned by the query. Limit of 255 characters. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Publish Topic
<salesforce:publish-topic>
Creates a topic representing a query that is used to notify listeners when changes are made to records in an organization.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Topic Name |
String |
Topic name. |
x |
|
Query |
String |
Query name. |
x |
|
Description |
String |
Description. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Push Generic Event
<salesforce:push-generic-event>
Pushes generic streaming custom events to the specified streaming channel.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Events |
Array of Generic Streaming Event |
Event list. |
|
|
Channel Id |
String |
Streaming channel name. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Push Event Result |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Query (Deprecated)
<salesforce:query>
Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are strings and, if necessary, you can convert them to the appropriate type, for example, by using DataWeave and Transform Message.
The Query operation is now deprecated. Use the Query Xml Stream operation instead.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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 in Salesforce Query. |
||
Escape characters for parameters value |
Boolean |
Escapes special characters for the Parameters value. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Query All
<salesforce:query-all>
Retrieves data from specified objects, whether or not they have been deleted.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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 in Salesforce Query. |
||
Escape characters for parameters value |
Boolean |
Escapes special characters for the Parameters value. |
|
|
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Query Result List
<salesforce:query-result-list>
Returns a list of result IDs for a specific batch. If the batch requires retries, there is more than one <result> element in the output. Use this operation with Query Result Stream By Id to obtain the results of the query.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch info |
BatchInfo to retrieve the results for. |
|
x |
|
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Output Mime Type |
String |
MIME type of the payload output of this operation. |
||
Output Encoding |
String |
Encoding of the payload output of this operation. |
||
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of a variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Query Result Stream (Deprecated)
<salesforce:query-result-stream>
Returns an InputStream with the query results of a submitted BatchInfo. Internally, the InputStreams contained in the sequence are requested on-demand (lazy-loading). Use them only with query jobs.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch info |
BatchInfo to monitor. |
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. |
|
|
Output Mime Type |
String |
MIME type of the payload output of this operation. |
||
Output Encoding |
String |
Encoding of the payload output of this operation. |
||
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of a variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Query Result Stream By Id
<salesforce:query-result-stream-by-id>
Returns an InputStream with the query results for a specific result ID of a submitted BatchInfo. Obtain the result IDs first by using the Query Result List operation.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch info |
BatchInfo that returns the result ID. |
|
x |
|
Result ID |
String |
Result ID obtained with Query Result List. |
x |
|
Output Mime Type |
String |
MIME type of the payload output of this operation. |
||
Output Encoding |
String |
Encoding of the payload output of this operation. |
||
Streaming Strategy |
Configure how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of a variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Query Xml Stream
<salesforce:query-xml-stream>
Executes a query against the specified object and returns data that matches the specified criteria. This operation returns paginated results. Each result is an InputStream of XML records.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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 in Salesforce Query. |
||
Escape characters for parameters value |
Boolean |
Escapes special characters for the Parameters value. |
|
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Headers |
Object |
Headers to include in the request. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Read Metadata
<salesforce:read-metadata>
Returns one or more metadata components from your organization, given the objects' API names.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type of the components to read. |
x |
|
Full Names |
Array of String |
List of full names of the components to read. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Rename Metadata
<salesforce:rename-metadata>
Renames a metadata component in your organization, given its old API name and the new name.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type of the component to rename. |
x |
|
Old Full Name |
String |
Current component full name. |
x |
|
New Full Name |
String |
New component full name. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Reset Password
<salesforce:reset-password>
Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the user ID field is null.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
User Id |
String |
User to reset the password for. If unspecified, the current user is used. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Retrieve
<salesforce:retrieve>
Retrieves one or more records based on the specified IDs.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Type of record to retrieve. |
x |
|
Retrieve Request |
Must provide the IDs and specify the fields for the records to retrieve. |
|
||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Retrieve Job Failed Results Bulk V2
<salesforce:retrieve-job-failed-results-bulk-v2>
Gets the status of the failed processed SObjects. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Job Failed Record Results |
Retrieve Job Successful Results Bulk V2
<salesforce:retrieve-job-successful-results-bulk-v2>
Gets the status of the successfully processed SObjects. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Job Successful Record Result |
Retrieve Job Unprocessed Results Bulk V2
<salesforce:retrieve-job-unprocessed-results-bulk-v2>
Gets the status of the unprocessed sObjects. This call uses the Bulk API v2.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
ID of the job. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Job Unprocessed Record Result |
Attributes Type |
Object |
Retrieve Metadata
<salesforce:retrieve-metadata>
Retrieves XML file representations of components in an organization.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Package Names |
Array of String |
List of package names to retrieve. 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 |
List of file names to retrieve. If a value is specified for this property, Package Names must be set to null. |
||
Unpackaged |
Binary |
Stream containing a list of components to retrieve that are not in a package. |
||
Streaming Strategy |
Configures how Mule processes streams. Repeatable streams are the default behavior. |
|||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Search
<salesforce:search>
Searches for objects using Salesforce Object Search Language (SOSL). Mimics using the search box inside the Salesforce UI.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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 in Search String. |
||
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Set Password
<salesforce:set-password>
Changes the password of a user or a self service user to a value that you specify.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
User Id |
String |
User to set the password for. |
x |
|
New Password |
String |
New password for the user. |
x |
|
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Unauthorize
<salesforce:unauthorize>
Deletes all of the access token information of a given resource owner ID so that it is impossible to execute an operation for that user without performing the OAuth dance.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Resource Owner Id |
String |
ID of the resource owner for whom to invalidate access. |
Update
<salesforce:update>
Updates one or more existing records in your organization’s data.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
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. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Update Metadata
<salesforce:update-metadata>
Updates one or more metadata components in your organization.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type of the components to update. |
x |
|
Metadata Objects |
Array of Object |
List of Map<String, Object> representing the metadata to update. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
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, use #upsert(String, String, List, Map)
over #create(String, List, Map)
to avoid creating unwanted, duplicate records.
Although you cannot change the Content Type value for a bulk upsert, you can use the Create Job operation to set the content type to CSV (or zipped CSV if you reach the character limit) and then follow up with the Create Batch operation. |
Name | Type | Description | Default Value | Required | ||
---|---|---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|||
Object Type |
String |
Type of record to upsert. |
x |
|||
External Id Field Name |
String |
Either of the following:
|
x |
|||
Records |
Array of Object |
Records to add to your organization. |
|
|||
Headers |
Object |
Map of HTTP headers in the message. |
||||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SALESFORCE:LIMIT_EXCEEDED
-
SALESFORCE:CONNECTIVITY
-
SALESFORCE:INVALID_RESPONSE
-
SALESFORCE:RETRY_EXHAUSTED
-
SALESFORCE:TIMEOUT
-
SALESFORCE:MUTUAL_AUTHENTICATION_FAILED
-
SALESFORCE:INSUFFICIENT_PERMISSIONS
-
SALESFORCE:COMMUNICATION
-
SALESFORCE:UNAVAILABLE
-
SALESFORCE:NOT_FOUND
-
SALESFORCE:INVALID_INPUT
-
SALESFORCE:OPERATION_NOT_SUPPORTED
Upsert Metadata
<salesforce:upsert-metadata>
Creates or updates one or more metadata components in your organization.
For a picklist field in an object, the Upsert Metadata operation updates only the picklist mapping for that specific object. To update the actual picklist values, such as adding or removing values in the picklist, use the Deploy Metadata operation. You must perform a metadata deploy for Custom Field or Global Picklist based on whether the picklist is tied to a custom field or is a global picklist.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Type |
String |
Metadata type of the components to create or update. |
x |
|
Metadata Objects |
Array of Object |
List of Map<String, Object> representing the metadata to upsert. |
|
|
Headers |
Object |
Map of HTTP headers in the message. |
||
Read Timeout |
Number |
How long the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit for the Read Timeout field. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
|
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Output
Type |
Array of Upsert Metadata Result |
Object Types
Action Override
Action override.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Available In Touch |
Boolean |
Indicates whether available in touch or not. |
||
From Factor |
String |
From factor. |
||
Name |
String |
Name. |
||
Page Id |
String |
Page ID. |
||
Url |
String |
URL. |
Additional Information Map
Additional information map.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name of the map. |
||
Value |
String |
Value of the map. |
Batch Info
Batch information.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Apex Processing Time |
Number |
Apex processing time. |
||
Api Active Processing Time |
Number |
API active processing time. |
||
Created Date |
DateTime |
Date created. |
||
Id |
String |
ID name. |
||
Job Id |
String |
Job ID. |
||
Number Records Failed |
Number |
Number of records that failed. |
||
Number Records Processed |
Number |
Number of records that are processed. |
||
State |
Enumeration, one of:
|
State. |
||
State Message |
String |
State message. |
||
System Modstamp |
DateTime |
System modstamp. |
||
Total Processing Time |
Number |
Total processing time. |
Bulk Item
Bulk item.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Exception |
Any |
Exception. |
||
Id |
Any |
ID. |
||
Message |
String |
Message. |
||
Payload |
Payload. |
|||
Status Code |
String |
Status code. |
||
Successful |
Boolean |
Determines if successful or not. |
Bulk Job State
Bulk job state.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Apex Processing Time |
Number |
Apex processing time. |
||
Api Active Processing Time |
Number |
API active processing time. |
||
Api Version |
Number |
API version. |
||
Column Delimiter |
String |
Column delimiter. |
||
Concurrency Mode |
String |
Concurrency mode. |
||
Content Type |
String |
Content type. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
String |
Date created. |
||
Error Message |
String |
Error message. |
||
External Id Field Name |
String |
External ID field name. |
||
Id |
String |
ID name. |
||
Job Type |
String |
Job type. |
||
Line Ending |
String |
Line ending. |
||
Number Records Failed |
Number |
Number of records that failed. |
||
Number Records Processed |
Number |
Number of records that are processed. |
||
Object |
String |
Object. |
||
Operation |
String |
Operation name. |
||
Retries |
Number |
Number of retries. |
||
State |
String |
State. |
||
System Modstamp |
String |
System modstamp. |
||
Total Processing Time |
Number |
Total processing time. |
Bulk Job V2 Result
Bulk job v2 result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Api Version |
String |
API version. |
||
Column Delimiter |
String |
Column delimiter. |
||
Concurrency Mode |
String |
Concurrency mode. |
||
Content Type |
String |
Content type. |
||
Content Url |
String |
Content URL. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
String |
Date created. |
||
External Id Field Name |
String |
External ID field name. |
||
Id |
String |
ID name. |
||
Job Type |
String |
Job type. |
||
Line Ending |
String |
Line ending. |
||
Object |
String |
Object. |
||
Operation |
String |
Operation name. |
||
State |
String |
State. |
||
System Modstamp |
String |
System modstamp. |
Bulk Operation Result
Bulk operation result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Id |
Any |
ID. |
||
Items |
Array of Bulk Item |
Array of the Bulk Item type. |
||
Successful |
Boolean |
Determines if successful or not. |
Child Relationship
Child relationship.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Cascade Delete |
Boolean |
Cascade delete. |
||
Child S Object |
String |
Child SObject. |
||
Deprecated And Hidden |
Boolean |
Indicates whether deprecated and hidden or not. |
||
Field |
String |
Field. |
||
Junction Id List Names |
Array of String |
Junction ID list names. |
||
Junction Reference To |
Array of String |
Junction reference to. |
||
Relationship Name |
String |
Relationship name. |
Create Job Request
Create job request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
External Id Field Name |
String |
Name of the field on this object. Use this attribute for custom objects or the ID lookup field property for standard objects (only required for upsert operations). |
||
Content Type |
Enumeration, one of:
|
Content type for the job results. When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results. |
||
Concurrency Mode |
Enumeration, one of:
|
Concurrency mode of the job. |
CRL File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the CRL file. |
Cron
CRON.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Expression |
String |
Cron expression. |
x |
|
Time zone |
String |
ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID. |
Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
Deleted Record
Deleted record.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Deleted Date |
DateTime |
Deleted date. |
||
Id |
String |
ID name. |
Deploy Metadata Request
Deploy metadata request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Stream |
Binary |
Stream containing the data. This parameter defaults to the payload content. |
x |
|
Ignore Warnings |
Boolean |
If |
|
|
Purge On Delete |
Boolean |
If |
|
|
Rollback On Error |
Boolean |
If |
|
Describe Global Result
Describe global result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Encoding |
String |
Encoding. |
||
Max Batch Size |
Number |
Maximum batch size. |
||
Sobjects |
Array of Describe Global S Object Result |
SObject results. |
Describe Global S Object Result
Describe global SObject results.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Activateable |
Boolean |
Indicates whether activateable or not. |
||
Createable |
Boolean |
Indicates whether createable or not. |
||
Custom |
Boolean |
Indicates whether customizable or not. |
||
Custom Setting |
Boolean |
Indicates whether there is a custom setting or not. |
||
Deletable |
Boolean |
Indicates whether deletable or not. |
||
Deprecated And Hidden |
Boolean |
Indicates whether deprecated and hidden or not. |
||
Feed Enabled |
Boolean |
Indicates whether the feed is enabled. |
||
Key Prefix |
String |
Key prefix. |
||
Label |
String |
Label. |
||
Label Plural |
String |
Label plural. |
||
Layoutable |
Boolean |
Indicates whether layoutable or not. |
||
Mergeable |
Boolean |
Indicates whether mergeable or not. |
||
Mru Enabled |
Boolean |
Indicates whether MRU is enabled or not. |
||
Name |
String |
Name. |
||
Queryable |
Boolean |
Indicates whether queryable or not. |
||
Replicateable |
Boolean |
Indicates whether replicateable or not. |
||
Retrieveable |
Boolean |
Indicates whether retrieveable or not. |
||
Searchable |
Boolean |
Indicates whether searchable or not. |
||
Triggerable |
Boolean |
Indicates whether triggerable or not. |
||
Undeleteable |
Boolean |
Indicates whether undeleteable or not. |
||
Updateable |
Boolean |
Indicates whether updateable or not. |
Describe Metadata Object
Describe metadata object.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Child Xml Names |
Array of String |
Child XML names. |
||
Directory Name |
String |
Directory name. |
||
In Folder |
Boolean |
Indicates whether the metadata object is in the folder. |
||
Meta File |
Boolean |
Indicates whether the metadata object is a meta file. |
||
Suffix |
String |
Suffix. |
||
Xml Name |
String |
XML name. |
Describe Metadata Result
Describe metadata result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Metadata Objects |
Array of Describe Metadata Object |
Metadata objects. |
||
Organization Namespace |
String |
Organization namespace. |
||
Partial Save Allowed |
Boolean |
Indicates whether partial save is allowed. |
||
Test Required |
Boolean |
Indicates whether a test is required. |
Describe S Object Result
Describe SObject result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Action Overrides |
Array of Action Override |
Action overrides. |
||
Activateble |
Boolean |
Indicates whether activateable or not. |
||
Child Relationships |
Array of Child Relationship |
Child relationships. |
||
Compact Layoutable |
Boolean |
Compact layoutable. |
||
Createable |
Boolean |
Indicates whether createable or not. |
||
Custom |
Boolean |
Indicates whether customizable or not. |
||
Custom Setting |
Boolean |
Indicates whether there is a custom setting or not. |
||
Deletable |
Boolean |
Indicates whether deletable or not. |
||
Deprecated And Hidden |
Boolean |
Indicates whether deprecated and hidden or not. |
||
Feed Enabled |
Boolean |
Indicates whether the feed is enabled. |
||
Fields |
Array of Field |
Fields. |
||
Key Prefix |
String |
Key prefix. |
||
Label |
String |
Label. |
||
Label Plural |
String |
Label plural. |
||
Layoutable |
Boolean |
Indicates whether layoutable or not. |
||
Mergeable |
Boolean |
Indicates whether mergeable or not. |
||
Mru Enabled |
Boolean |
Indicates whether MRU is enabled or not. |
||
Name |
String |
Name. |
||
Named Layout Infos |
Array of Named Layout Info |
Named layout information. |
||
Network Scope Field Name |
String |
Network scope field name. |
||
Queryable |
Boolean |
Indicates whether queryable or not. |
||
Record Type Infos |
Array of Record Type Info |
Record type information. |
||
Replicateable |
Boolean |
Indicates whether replicateable or not. |
||
Retrieveable |
Boolean |
Indicates whether retrieveable or not. |
||
Search Layoutable |
Boolean |
Indicates whether the search is layoutable or not. |
||
Searchable |
Boolean |
Indicates whether searchable or not. |
||
Triggerable |
Boolean |
Indicates whether triggerable or not. |
||
Undeleteable |
Boolean |
Indicates whether undeleteable or not. |
||
Updateable |
Boolean |
Indicates whether updateable or not. |
||
Url Detail |
String |
URL detail. |
||
Url Edit |
String |
URL edit. |
||
Url New |
String |
URL new. |
Duplicate Result
Duplicate result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Allow Save |
Boolean |
Determines whether to allow saving or not. |
||
Duplicate Rule |
String |
Duplicate rule. |
||
Duplicate Rule Entity Type |
String |
Duplicate rule entity type. |
||
Error Message |
String |
Error message. |
||
Match Results |
Array of Match Result |
Match results. |
Entity Search Metadata
Entity search metadata.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Name |
String |
Entity name. |
||
Field Metadata |
Array of Field Level Search Metadata |
Field metadata. |
Error
Error.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Duplicate Result |
Duplicate result. |
|||
Fields |
Array of String |
Fields. |
||
Message |
String |
Message. |
||
Status Code |
String |
Status code. |
Expiration Policy
Configures an expiration policy strategy.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
Field
Field.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Autonumber |
Boolean |
Indicates autonumber. |
||
Byte Length |
Number |
Byte length. |
||
Calculated |
Boolean |
Indicates whether calculated or not. |
||
Case Sensitive |
Boolean |
Indicates whether case sensitive or not. |
||
Controller Name |
String |
Controller name. |
||
Createable |
Boolean |
Indicates whether createable or not. |
||
Custom |
Boolean |
Indicates whether customizable or not. |
||
Default Value |
Any |
Default value. |
||
Default Value Formula |
String |
Default value formula. |
||
Defaulted On Create |
Boolean |
Indicates whether defaulted on create. |
||
Dependent Pick List |
Boolean |
Indicates whether dependent pick list or not. |
||
Deprecate And Hidden |
Boolean |
Indicates whether deprecated and hidden or not. |
||
Digits |
Number |
Digits. |
||
Display Location In Decimal |
Boolean |
Indicates whether the display location is in decimal. |
||
Encrypted |
Boolean |
Indicates whether encrypted or not. |
||
Extra Type Info |
String |
Extra type information. |
||
Filterable |
Boolean |
Indicates whether filterable or not. |
||
Filtered Lookup Info |
Filtered lookup information. |
|||
Formula |
String |
Formula. |
||
Groupable |
Boolean |
Indicates whether groupable or not. |
||
High Scale Number |
Boolean |
Indicates whether high scale number or not. |
||
Html Formatted |
Boolean |
Indicates whether HTML formatted or not. |
||
Id Lookup |
Boolean |
Indicates ID lookup. |
||
Inline Help Text |
String |
Inline help text. |
||
Label |
String |
Label. |
||
Length |
Number |
Length. |
||
Mask |
String |
Mask. |
||
Mask Type |
String |
Mask type. |
||
Name |
String |
Name. |
||
Name Field |
Boolean |
Indicates name field. |
||
Name Pointing |
Boolean |
Indicates name pointing. |
||
Nullable |
Boolean |
Indicates whether nullable or not. |
||
Permissinable |
Boolean |
Indicates whether permissionable or not. |
||
Picklist Values |
Array of Pick List Entry |
Picklist values. |
||
Polymorphic Foreign Key |
Boolean |
Indicates polymorphic foreign key. |
||
Precision |
Number |
Precision. |
||
Reference Target Field |
String |
Reference target field. |
||
Reference To |
Array of String |
Reference to. |
||
Relationship Name |
String |
Relationship name. |
||
Relationship Order |
Number |
Relationship order. |
||
Required |
Boolean |
Indicates whether required or not. |
||
Restricted Picklist |
Boolean |
Indicates whether restricted picklist or not. |
||
Scale |
Number |
Scale. |
||
Search Filterable |
Boolean |
Indicates whether search filterable or not. |
||
Sortable |
Boolean |
Indicates whether sortable or not. |
||
Type |
Enumeration, one of:
|
Type. |
||
Unique |
Boolean |
Indicates whether unique or not. |
||
Updateable |
Boolean |
Indicates whether updateable or not. |
||
Write Requires Master Read |
Boolean |
Indicates whether write requires master read or not. |
Field Diff
Field difference.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Difference |
Enumeration, one of:
|
Field differences. |
||
Name |
String |
Name of the field. |
Field Level Search Metadata
Field level search metadata.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Label |
String |
Label. |
||
Name |
String |
Name. |
||
Type |
String |
Type. |
File Properties
File properties.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created By |
String |
Created by. |
||
Created By Name |
String |
Created by name. |
||
Created Date |
DateTime |
Date created. |
||
File Name |
String |
File name. |
||
Full Name |
String |
Full name. |
||
Id |
String |
ID name. |
||
Last Modified By Id |
String |
Last modified by ID. |
||
Last Modified By Name |
String |
Last modified by name. |
||
Last Modified Date |
String |
Last modified date. |
||
Manageable State |
Enumeration, one of:
|
Manageable state. |
||
Namespace Prefix |
String |
Namespace prefix. |
||
Type |
String |
Type. |
Filtered Lookup Info
Filtered lookup information.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Controlling Fields |
Array of String |
Controlling fields. |
||
Dependent |
Boolean |
Indicates dependent or not. |
||
Optional Filter |
Boolean |
Indicates optional filter or not. |
Find Duplicates Result
Find duplicates result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Duplicate Results |
Array of Duplicate Result |
Duplicate results. |
||
Errors |
Array of Error |
Errors. |
||
Success |
Boolean |
Determines if successful or not. |
Fixed Frequency
Fixed frequency.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
Frequency at which the scheduler initiates the flow, based on the time unit specified in the Time Unit field. |
|
x |
Start delay |
Number |
Amount of time that the scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Frequency and Start delay fields. |
|
Generic Streaming Event
Generic streaming event.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Payload |
String |
Payload. |
||
User Ids |
Array of String |
User IDs. |
Get Deleted Result
Get deleted result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Deleted Records |
Array of Deleted Record |
Deleted records. |
||
Earliest Date Available |
DateTime |
Earliest date available. |
||
Latest Date Covered |
DateTime |
Latest date covered. |
Get Updated Result
Get updated result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Ids |
Array of String |
IDs. |
||
Latest Date Covered |
DateTime |
Latest date covered. |
Get User Info Result
Get user information result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Accessibility Mode |
Boolean |
Indicates accessibility mode. |
||
Currency Symbol |
String |
Currency symbol. |
||
Org Attachment File Size Limit |
Number |
Organization attachment file size limit. |
||
Org Default Currency Iso Code |
String |
Organization default currency ISO code. |
||
Org Default Currency Locale |
String |
Organization default currency locale. |
||
Org Disallow Html Attachments |
Boolean |
Indicates whether the organization disallows HTML attachments. |
||
Org Has Person Accounts |
Boolean |
Indicates whether the organization contains person accounts. |
||
Organization Id |
String |
Organization ID. |
||
Organization Multi Currency |
Boolean |
Organization multicurrency. |
||
Organization Name |
String |
Organization name. |
||
Profile Id |
String |
Profile ID. |
||
Role Id |
String |
Role ID. |
||
Session Seconds Valid |
Number |
Session seconds valid. |
||
User Default Currency Iso Code |
String |
User default currency ISO code. |
||
User Email |
String |
User email. |
||
User Full Name |
String |
User full name. |
||
User Id |
String |
User ID. |
||
User Language |
String |
User language. |
||
User Locale |
String |
User locale. |
||
User Name |
String |
User name. |
||
User Time Zone |
String |
User time zone. |
||
User Type |
String |
User type. |
||
User Ui Skin |
String |
User UI skin. |
Job Failed Record Results
Job failed record results.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Error Message |
String |
Error message. |
||
Id |
String |
ID name. |
||
Original Fields |
Object |
Original fields. |
Job Info
Job info.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Apex Processing Time |
Number |
Apex processing time. |
||
Api Active Processing Time |
Number |
API active processing time. |
||
Api Version |
Number |
API version. |
||
Assignment Rule Id |
String |
ID of an assignment rule for a case or lead. The assignment rule can be active or inactive. |
||
Concurrency Mode |
Enumeration, one of:
|
Concurrency mode. |
||
Content Type |
Enumeration, one of:
|
Content type. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
DateTime |
Date created. |
||
External Id Field Name |
String |
External ID field name. |
||
Fast Path Enabled |
Boolean |
Determines whether fast path is enabled. |
||
Id |
String |
ID name. |
||
Number Batches Completed |
Number |
Number of batches that are completed. |
||
Number Batches Failed |
Number |
Number of batches that failed. |
||
Number Batches In Progress |
Number |
Number of batches in progress. |
||
Number Batches Queued |
Number |
Number of batches that are queued. |
||
Number Batches Total |
Number |
Number of batches in total. |
||
Number Records Failed |
Number |
Number of records that failed. |
||
Number Records Processed |
Number |
Number of records that are processed. |
||
Number Retries |
Number |
Number of retries. |
||
Object |
String |
Object. |
||
Operation |
Enumeration, one of:
|
Operation name. |
||
State |
Enumeration, one of:
|
State. |
||
System Modstamp |
DateTime |
System modstamp. |
||
Total Processing Time |
Number |
Total processing time. |
Job Successful Record Result
Job successful record result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created |
Boolean |
Indicates whether the job is created or not. |
||
Id |
String |
ID name. |
||
Original Fields |
Object |
Original fields. |
Job Unprocessed Record Result
Job unprocessed record result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Original Fields |
Object |
Original fields. |
Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system. |
||
Type |
String |
Type of keystore. |
||
Alias |
String |
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Encryption algorithm that the keystore uses. |
Labels Search Metadata
Labels search metadata.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Field Labels |
Array of Name Value Pair |
Entity field labels. |
||
Entity Name |
String |
Entity name. |
Lead Convert Result
Lead convert result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Account Id |
String |
Account ID. |
||
Contact Id |
String |
Contact ID. |
||
Errors |
Array of Error |
Errors. |
||
Lead Id |
String |
Lead ID. |
||
Opportunity Id |
String |
Opportunity ID. |
||
Success |
Boolean |
Determines if successful or not. |
Lead Convert Request
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 account ID, and an account ID must be specified). Required only when updating an existing contact.
|
||||
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 account ID 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 or 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 |
If |
|
|||
Opportunity Name |
String |
Name of the opportunity to create. If unspecified, this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If
Do Not Create Opportunity is |
||||
Do Not Create Opportunity |
Boolean |
Specifies whether to create an opportunity during lead conversion. Set this flag to |
|
|||
Over Write Lead Source |
Boolean |
Specifies whether to overwrite the lead source field on the target contact object with the contents of the lead source field in the source lead object. To set this field to |
|
|||
Opportunity Id |
String |
ID of an existing opportunity to relate to a lead during lead conversion. |
||||
Owner Id |
String |
Name associated with the owner ID that owns this lead. |
||||
Related Person Account Id |
String |
When converting a lead to a business account and an existing person account, this value specifies the ID of the person account. |
||||
Related Person Account Record |
Object |
When converting a lead to a business account and a new person account, this value specifies the entity record of the new person account. |
Match Record
Match record.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Additional Information |
Array of Additional Information Map |
Additional information. |
||
Field Diffs |
Array of Field Diff |
Field differences. |
||
Match Confidence |
Number |
Match confidence. |
||
Record |
Object |
Record. |
Match Result
Match result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Type |
String |
Entity type. |
||
Errors |
Array of Simple Error |
Errors. |
||
Match Engine |
String |
Match engine name. |
||
Match Records |
Array of Match Record |
Match records. |
||
Rule |
String |
Rule name. |
||
Size |
Number |
Size. |
||
Success |
Boolean |
Determines if successful or not. |
Merge Record
Merge record.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Master Record |
Object |
Master record that contains at least the ID and the type of the object that other records merge into. Optionally, provide the fields and their values to update. |
x |
|
Record To Merge Ids |
Array of String |
Additional records to merge into the primary record. Minimum of one record and maximum of two records. |
x |
|
Additional Information Map |
Object |
Field-value map. When a portal user ID is merged, it must contain two entries: |
Merge Result
Merge result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Errors |
Array of Error |
Errors. |
||
Id |
String |
ID name. |
||
Merged Record Ids |
Array of String |
Merged record IDs. |
||
Success |
Boolean |
Determines if successful or not. |
||
Updated Related Ids |
Array of String |
Updated related IDs. |
Metadata Result
Metadata result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Errors |
Array of Error |
Errors. |
||
Full Name |
String |
Full name. |
||
Id |
String |
ID name. |
||
Success |
Boolean |
Determines if successful or not. |
Name Value Pair
Name value pair.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name. |
||
Value |
String |
Value. |
Named Layout Info
Named layout information.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name. |
Non-Repeatable Stream
Configures the non-repeatable streaming strategy, in which Mule disables repeatable streams. Use this strategy if your use case requires reading the content only once.
In some cases, you might want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost.
Pick List Entry
Pick list entry.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Active |
Boolean |
Indicates active or not. |
||
Default Value |
Boolean |
Indicates default value. |
||
Label |
String |
Label. |
||
Valid For |
Binary |
Indicates when valid for. |
||
Value |
String |
Value. |
Proxy
Configures a proxy for outbound connections.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Hostname or IP address of the proxy server. |
x |
|
Port |
Number |
Port of the proxy server. |
x |
|
Username |
String |
Username to authenticate against the proxy server. |
||
Password |
String |
Password to authenticate against the proxy server. |
Push Event Result
Push event result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fanout Count |
Number |
Fanout count. |
||
User Online Status |
Object |
User online status. |
Query Job Info
Query job information.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Api Version |
String |
API version. |
||
Column Delimiter |
String |
Column delimiter. |
||
Concurrency Mode |
String |
Concurrency mode. |
||
Content Type |
String |
Content type. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
String |
Date created. |
||
Id |
String |
ID name. |
||
Job Type |
String |
Job type. |
||
Line Ending |
String |
Line ending. |
||
Number Records Processed |
Number |
Number of records that are processed. |
||
Object |
String |
Object. |
||
Operation |
String |
Operation name. |
||
Pk Chunking Supported |
Boolean |
Whether or not PK chunking is supported. |
||
Retries |
Number |
Number of retries. |
||
State |
String |
State. |
||
System Modstamp |
String |
System modstamp. |
||
Total Processing Time |
Number |
Total processing time. |
Query Job State
Query job state.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Api Version |
String |
API version. |
||
Column Delimiter |
String |
Column delimiter. |
||
Concurrency Mode |
String |
Concurrency mode. |
||
Content Type |
String |
Content type. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
String |
Date created. |
||
Id |
String |
ID name. |
||
Line Ending |
String |
Line ending. |
||
Object |
String |
Object. |
||
Operation |
String |
Operation name. |
||
State |
String |
State. |
||
System Modstamp |
String |
System modstamp. |
Query Jobs Info Result
Query jobs information result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Api Version |
String |
API version. |
||
Column Delimiter |
String |
Column delimiter. |
||
Concurrency Mode |
String |
Concurrency mode. |
||
Content Type |
String |
Content type. |
||
Created By Id |
String |
Created by ID. |
||
Created Date |
String |
Date created. |
||
Id |
String |
ID name. |
||
Job Type |
String |
Job type. |
||
Line Ending |
String |
Line ending. |
||
Object |
String |
Object. |
||
Operation |
String |
Operation name. |
||
State |
String |
State. |
||
System Modstamp |
String |
System modstamp. |
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts the Mule app can make. |
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
|
||
Reconnection Strategy |
Reconnection strategy to use. |
Record Type Info
Record type information.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Available |
Boolean |
Indicates whether available or not. |
||
Default Record Type Mapping |
Boolean |
Indicates default record type mapping. |
||
Id |
String |
ID name. |
||
Master |
Boolean |
Indicates master. |
||
Name |
String |
Name. |
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. |
||
Use Secure Hash |
Boolean |
If |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if the Use Secure Hash field is |
||
Id Expression |
String |
One or more expressions that determine when a message is redelivered. You can set this property only if the Use Secure Hash field is |
||
Object Store |
ObjectStore |
Configures the object store that stores the redelivery counter for each message. |
Repeatable File Store Iterable
Repeatable file store iterable.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Repeatable In Memory Iterable
Repeatable in memory iterable.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Amount of instances to initially keep 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 the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum amount of memory to use. If more than that is used, a |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum amount of memory to use. If more than that is used, a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Reset Password Result
Reset password result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Password |
String |
Password to authenticate against the proxy server. |
Result
Result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Errors |
Array of Error |
Array of the Error type. |
||
Id |
String |
ID name. |
||
Success |
Boolean |
Determines if successful or not. |
Retrieve Request
Retrieve request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fields |
Array of String |
Fields. |
||
Ids |
Array of String |
IDs. |
Search Record
Search record.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Record |
Object |
Record. |
||
Search Record Metadata |
Search record metadata. |
|||
Snippet |
Snippet. |
Search Record Metadata
Search record metadata.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Spell Corrected |
Boolean |
Indicates whether the search is spelled correctly. |
Search Result
Search result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Query Id |
String |
Query ID. |
||
Search Records |
Array of Search Record |
Search records. |
||
Search Results Metadata |
Search results metadata. |
Search Results Metadata
Search results metadata.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Label Metadata |
Array of Labels Search Metadata |
Entity label metadata. |
||
Entity Metadata |
Array of Entity Search Metadata |
Entity metadata. |
Search Snippet
Search snippet.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Text |
String |
Text. |
||
Whole Fields |
Array of Name Value Pair |
Whole fields. |
Simple Error
Simple error.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fields |
Array of String |
Fields. |
||
Message |
String |
Message. |
||
Status Code |
String |
Status code. |
Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Which elements to verify in the certificate chain:
|
||
Prefer Crls |
Boolean |
How to check certificate validity:
|
||
No Fallback |
Boolean |
Whether to use the secondary method to check certificate validity:
|
||
Soft Fail |
Boolean |
What to do if the revocation server can’t be reached or is busy:
|
TLS
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
Comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
Comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Configures the TLS truststore. |
|||
Key Store |
Configures the TLS keystore. |
|||
Revocation Check |
Configures a revocation checking mechanism. |
Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore. |
||
Algorithm |
String |
Encryption algorithm that the truststore uses. |
||
Insecure |
Boolean |
If |
Upsert Metadata Result
Upsert metadata result.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created |
Boolean |
Indicates whether created or not. |
||
Errors |
Array of Error |
Errors. |
||
Full Name |
String |
Full name. |
||
Id |
String |
ID name. |
||
Success |
Boolean |
Determines if successful or not. |