Salesforce Connector API Reference

name

String

The name of this configuration. With this name can be later referenced.

username

String

Username used to initialize the session

password

String

Password used to authenticate the user

securityToken

String

User's security token. It can be omitted if your IP has been whitelisted on Salesforce

url

String

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

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

sessionId

String

This value may be used to specify and identify an active Salesforce session

serviceEndpoint

String

Specifies the service endpoint. This value will only be used if the sessionId configuration property is used.

disableSessionInvalidation

boolean

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

false

useKeepAlive

boolean

If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

false

initialDelay

long

Specify the time in seconds the connector will wait before executing the first keep-alive request

0

keepAliveRequestFrequency

long

Specifies the time in seconds the connector will wait between two successive requests

320

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce-connected app

consumerSecret

String

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

username

String

Username used to initialize the session.

password

String

Password used to authenticate the user.

securityToken

String

User's security token. It can be omitted if your IP has been whitelisted on Salesforce.

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from more applications and get the same session from Salesforce. Default value is false.

false

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce connected app

keyStore

String

Path to key store used to sign data during authentication

storePassword

String

Password of key store

principal

String

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

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from * more applications and get the same session from Salesforce. Default value is false.

false

useKeepAlive

boolean

If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

false

initialDelay

long

Specify the time in seconds the connector will wait before executing the first keep-alive request

0

keepAliveRequestFrequency

long

Specifies the time in seconds the connector will wait between two successive requests

320

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce-connected app

consumerSecret

String

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

username

String

Username used to initialize the session.

password

String

Password used to authenticate the user.

securityToken

String

User's security token. It can be omitted if your IP has been whitelisted on Salesforce.

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from more applications and get the same session from Salesforce. Default value is false.

false

useKeepAlive

boolean

If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

false

initialDelay

long

Specify the time in seconds the connector will wait before executing the first keep-alive request

0

keepAliveRequestFrequency

long

Specifies the time in seconds the connector will wait between two successive requests

320

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

username

String

Username used to initialize the session

password

String

Password used to authenticate the user

securityToken

String

User's security token. It can be omitted if your IP has been whitelisted on Salesforce

url

String

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

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

sessionId

String

This value may be used to specify and identify an active Salesforce session

serviceEndpoint

String

Specifies the service endpoint. This value will only be used if the sessionId configuration property is used.

disableSessionInvalidation

boolean

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

false

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce connected app

keyStore

String

Path to key store used to sign data during authentication

storePassword

String

Password of key store

principal

String

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

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from * more applications and get the same session from Salesforce. Default value is false.

false

useKeepAlive

boolean

If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

false

initialDelay

long

Specify the time in seconds the connector will wait before executing the first keep-alive request

0

keepAliveRequestFrequency

long

Specifies the time in seconds the connector will wait between two successive requests

320

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce connected app

keyStore

String

Path to key store used to sign data during authentication

storePassword

String

Password of key store

principal

String

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

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from * more applications and get the same session from Salesforce. Default value is false.

false

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Consumer key for Salesforce connected app

keyStore

String

Path to key store used to sign data during authentication

storePassword

String

Password of key store

principal

String

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

tokenEndpoint

String

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

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

disableSessionInvalidation

boolean

If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from * more applications and get the same session from Salesforce. Default value is false.

false

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

name

String

The name of this configuration. With this name can be later referenced.

consumerKey

String

Your application's client identifier (consumer key in Remote Access Detail).

consumerSecret

String

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

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

48.0

clientId

String

Client ID for partners

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

useDefaultRule

Boolean

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

false

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

fetchAllApexSoapMetadata

boolean

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

false

fetchAllApexRestMetadata

boolean

If checked then Datasense will be performed for all Apex classes in the organization else Datasense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during Datasense. Default value is false.

false

apexClassNames

List<String>

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

clearNullFields

boolean

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

false

readTimeout

Integer

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

0

connectionTimeout

Integer

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

0

proxyHost

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

proxyPort

String

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

proxyUsername

String

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

proxyPassword

String

Password used to authenticate against the proxy.

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

batchSobjectMaxDepth

Integer

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

5

config-ref

String

Specify which config to use

type

String

Type of object to create

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List

An array of SaveResult if async is false

config-ref

String

Specify which config to use

operation

OperationEnum

The com.sforce.async.OperationEnum that will be executed by the job.

type

String

The type of Salesforce object that the job will process.

externalIdFieldName

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects (only required for Upsert Operations).

contentType

ContentType

The Content Type for this Job results. When specifying a content type different from XML for a query type use queryResultStream(BatchInfo) method to retrieve results.

concurrencyMode

ConcurrencyMode

The concurrency mode of the job, either Parallel or Serial.

headers

Map<String,String>

These headers are sent as HTTP headers with the request to Bulk API

JobInfo

A JobInfo that identifies the created Job.

config-ref

String

Specify which config to use

jobId

String

The Job ID identifying the Job to be closed.

JobInfo

A JobInfo that identifies the closed Job.

config-ref

String

Specify which config to use

jobId

String

The Job ID identifying the Job to be aborted.

JobInfo

A that identifies the aborted Job.

config-ref

String

Specify which config to use

jobId

String

the Job ID of the Job being monitored

contentType

ContentType

specifies the content type of the message

JobInfo

Latest JobInfo representing the status of the job result.

config-ref

String

Specify which config to use

jobInfo

JobInfo

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

objects

List<Map<String,Object>>

A list of one or more sObject objects. This parameter defaults to payload content.

#[payload]

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

jobInfo

JobInfo

The com.sforce.async.JobInfo in which the batch will be created. This parameter defaults to payload content.

#[payload]

stream

InputStream

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

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

jobInfo

JobInfo

The com.sforce.async.JobInfo in which the batch will be created.

#[payload]

query

String

The query to be executed.

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

type

String

Type of object to create

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

type

String

Type of object to create

object

Map<String,Object>

SObject to create

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

SaveResult

An array of { SaveResult}

config-ref

String

Specify which config to use

type

String

Type of object to update

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List

An array of { SaveResult}

config-ref

String

Specify which config to use

type

String

Type of object to update

object

Map<String,Object>

The object to be updated.

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

SaveResult

A { SaveResult}

config-ref

String

Specify which config to use

type

String

Type of object to update

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

type

String

Type of object to merge

object

Map<String,Object>

The Master object used for the merge

#[payload]

ids

List<String>

A list of ids of the objects to be merged

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

MergeResult

instance of {see MergeResult} containing the result of the Merge

config-ref

String

Specify which config to use

externalIdFieldName

String

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

type

String

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

objects

List<Map<String,Object>>

The objects to upsert.

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List

a list of UpsertResult, one for each

config-ref

String

Specify which config to use

type

String

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

externalIdFieldName

String

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

objects

List<Map<String,Object>>

The objects to upsert

#[payload]

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

contentType

ContentType

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

BatchInfo

Latest BatchInfo representing status of the batch job result.

config-ref

String

Specify which config to use

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

BatchResult

BatchResult representing result of the batch job result.

config-ref

String

Specify which config to use

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

headers

Map<String,String>

Optional parameter specifying the headers for the operation

InputStream

InputStream representing result of the batch job result.

config-ref

String

Specify which config to use

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

headers

Map<String,String>

Optional parameter specifying the headers for the operation

InputStream

InputStream with the results of the Batch.

config-ref

String

Specify which config to use

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

DescribeGlobalResult

A DescribeGlobalResult

config-ref

String

Specify which config to use

type

String

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

ids

List<String>

The ids of the objects to retrieve

#[payload]

fields

List<String>

The fields to return for the matching objects

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List<Map<String,Object>>

An array of SObjects

config-ref

String

Specify which config to use

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).

pagingConfiguration

PagingConfiguration

the paging configuration

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

ProviderAwarePagingDelegate<Map<String,Object>,SalesforceConnector>

An array of SObjects query()

config-ref

String

Specify which config to use

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).

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List<Map<String,Object>>

An array of SObjects

config-ref

String

Specify which config to use

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).

pagingConfiguration

PagingConfiguration

the paging configuration

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

ProviderAwarePagingDelegate<Map<String,Object>,SalesforceConnector>

An array of { SObject}s query()

config-ref

String

Specify which config to use

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 Search Language (SOSL).

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List<Map<String,Object>>

An array of SObjects

config-ref

String

Specify which config to use

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).

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

Map<String,Object>

A single SObject

config-ref

String

Specify which config to use

leadId

String

ID of the Lead to convert. Required. For information on IDs, see ID Field Type.

contactId

String

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

accountId

String

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

opportunityId

String

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

overWriteLeadSource

Boolean

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

false

doNotCreateOpportunity

Boolean

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

false

opportunityName

String

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

convertedStatus

String

Valid LeadStatus value for a converted lead. Required. To obtain the list of possible values, the client application queries the LeadStatus object, as in: Select Id, MasterLabel from LeadStatus where IsConverted=true

sendEmailToOwner

Boolean

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

false

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

LeadConvertResult

A LeadConvertResult object

config-ref

String

Specify which config to use

ids

List<String>

Array of one or more IDs associated with the records to delete from the recycle bin. Maximum number of records is 200.

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List

A list of { com.sforce.soap.partner.EmptyRecycleBinResult}

config-ref

String

Specify which config to use

Calendar

Calendar with the current timestamp

config-ref

String

Specify which config to use

ids

List<String>

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

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List

An array of DeleteResult

config-ref

String

Specify which config to use

type

String

Type of object to update

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

BatchInfo

A BatchInfo that identifies the batch job.

config-ref

String

Specify which config to use

type

String

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

startTime

Calendar

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

endTime

Calendar

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

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

GetUpdatedResult

GetUpdatedResult

config-ref

String

Specify which config to use

type

String

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

startTime

Calendar

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

endTime

Calendar

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame to retrieve the data from. 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 the time is not specified, the current server time will be used.

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

GetDeletedResult

A GetDeletedResult

config-ref

String

Specify which config to use

type

String

Standard Object. The specified value must be a valid object for your organization. For a complete list of objects

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

DescribeSObjectResult

DescribeSObjectResult

config-ref

String

Specify which config to use

type

String

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

duration

int

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

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

GetDeletedResult

A GetDeletedResult

config-ref

String

Specify which config to use

type

String

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

duration

int

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

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

GetUpdatedResult

GetUpdatedResult object containing an

config-ref

String

Specify which config to use

type

String

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

initialTimeWindow

int

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

fields

List<String>

The fields to retrieve for the updated objects

#[payload]

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

List<Map<String,Object>>

List with the updated objects in the calculated time range

config-ref

String

Specify which config to use

type

String

The object type for which the timestamp should be reset.

config-ref

String

Specify which config to use

userId

String

The user to set the password for.

newPassword

String

The new password for the user.

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

config-ref

String

Specify which config to use

topicName

String

Descriptive name of the push topic, such as MyNewCases or TeamUpdatedContacts. The maximum length is 25 characters. This value identifies the channel.

query

String

The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters

description

String

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

List

config-ref

String

Specify which config to use

channelName

String

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

ownerId

String

Identifier fir the channel owner.

description

String

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

List

A POJO list containing data about the outcome of the request.

config-ref

String

Specify which config to use

GetUserInfoResult

A GetUserInfoResult

config-ref

String

Specify which config to use

type

String

The Metadata Type to be created

objects

List<Map<String,Object>>

a List of Map<String, Object> representing the metadatas to be created

#[payload]

List

An array of SaveResult: contains

config-ref

String

Specify which config to use

type

String

The metadata type of the components updated

objects

List<Map<String,Object>>

a List of Map<String, Object> representing the metadata to be updated

#[payload]

List

An array of SaveResult: containing

config-ref

String

Specify which config to use

type

String

The metadata type of the components to create/update

objects

List<Map<String,Object>>

A List of Map<String, Object> representing the metadatas to be upserted

#[payload]

List

An array of UpsertResult: Each returned

config-ref

String

Specify which config to use

type

String

The metadata type of the components to delete

fullNames

List<String>

Full names of the components to delete

#[payload]

List

An array of DeleteResult: Each DeleteResult contains

config-ref

String

Specify which config to use

type

String

The metadata type of the components to rename

oldFullName

String

The current component full name

#[payload]

newFullName

String

The new component full name

SaveResult

SaveResult: A SaveResult object is returned

config-ref

String

Specify which config to use

type

String

The metadata type of the components to read

fullNames

List<String>

List of full names of the components to read

#[payload]

List<Map<String,Object>>

ReadResult containing an array of metadata components is

config-ref

String

Specify which config to use

type

String

The metadata type used as criteria when querying for information

List

An array of FileProperties

config-ref

String

Specify which config to use

DescribeMetadataResult

DescribeMetadataResult Contains information about

config-ref

String

Specify which config to use

stream

InputStream

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

#[payload]

ignoreWarnings

boolean

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

false

purgeOnDelete

boolean

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

false

rollbackOnError

boolean

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

true

config-ref

String

Specify which config to use

packageNames

List<String>

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

specificFiles

List<String>

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

unpackaged

InputStream

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

InputStream

InputStream representing result of the retrieve job.

config-ref

String

Specify which config to use

validateSession

boolean

The session will be validated; if the session is invalid, reconnection will be triggered (if the strategy is enabled), and the new session id will be returned

false

String

the Salesforce current session Id

config-ref

String

Specify which config to use

String

the Salesforce Server Url

config-ref