Following a create
or update
operation,
the output message body contains the input message body augmented
with data from the Salesforce system. Following a retrieve
or delete
operation,
the input message body is discarded and replaced.
Note: SalesforceRequest (no discovery) is the new name for the node that was
called SalesforceRequest in previous versions of
IBM® App Connect Enterprise (up to and
including V12.0.4), and it continues to operate in the same way as in previous versions.
In IBM App Connect Enterprise 12.0.5 (and later versions), a new Salesforce Request node is provided, which you configure by
using a Connector Discovery wizard to discover and set properties for the Salesforce connector. For information about using this
feature, see Using Salesforce with IBM App Connect Enterprise and Salesforce Request node.
The data that is added varies according to the operation
performed by the
SalesforceRequest (no discovery) node
(create, retrieve, update, or delete):
- Following a
create
operation, the output message
body contains the input message body augmented with the Salesforce
ID of the newly created Salesforce record
- Following a
retrieve
operation, the output message
body contains the following data:
- If you specified a Salesforce ID, the output message body contains
a JSON object for the record
- If you did not specify a Salesforce ID, the output message body
contains a JSON array for zero or more records
- Following an
update
operation, the output message
body contains the following data:
- If you specified a Salesforce ID, the output message body contains
the input message body augmented with the Salesforce ID of the updated
Salesforce record
- If you specified an External ID and the Salesforce record already
existed, the output message body contains the input message body
- If you specified an External ID and the Salesforce record did
not previously exist, the output message body contains the input message
body augmented with the Salesforce ID of the newly created Salesforce
record
- Following a
delete
operation, the output message
body contains the Salesforce ID of the Salesforce record that was
deleted.
The following table shows example input and output message
bodies for each operation:
Table 1. SalesforceRequest
node - input and output message bodies. Example input
message bodies to the SalesforceRequest (no discovery) node and
the output message bodies following a create, retrieve, update, or
delete operation.
Operation |
input message body to SalesforceRequest (no discovery) node |
output message body from SalesforceRequest (no discovery) node |
create |
(0x01000000:Object):JSON = ( ['json' : 0x7fe8bc1b65c0]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-32' (CHARACTER)
(0x03000000:NameValue):Type = 'good' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'Romsey Road' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Winchester' (CHARACTER)
(0x03000000:NameValue):BillingState = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):BillingPostalCode = 'SO21 2JN' (CHARACTER)
(0x03000000:NameValue):BillingCountry = 'United Kingdom' (CHARACTER)
(0x03000000:NameValue):Phone = '01962815000' (CHARACTER)
(0x03000000:NameValue):Fax = '01962816666' (CHARACTER)
(0x03000000:NameValue):AccountNumber = '001122334455' (CHARACTER)
(0x03000000:NameValue):Website = 'http://www.ibm.com' (CHARACTER)
)
)
|
(0x01000000:Object):JSON = ( ['json' : 0x7fe8dc2d9a70]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-32' (CHARACTER)
(0x03000000:NameValue):Type = 'good' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'Romsey Road' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Winchester' (CHARACTER)
(0x03000000:NameValue):BillingState = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):BillingPostalCode = 'SO21 2JN' (CHARACTER)
(0x03000000:NameValue):BillingCountry = 'United Kingdom' (CHARACTER)
(0x03000000:NameValue):Phone = '01962815000' (CHARACTER)
0x03000000:NameValue):Fax = '01962816666' (CHARACTER)
0x03000000:NameValue):AccountNumber = '001122334455' (CHARACTER)
0x03000000:NameValue):Website = 'http://www.ibm.com' (CHARACTER)
0x03000000:NameValue):Id = '00158000003M6LzAAK' (CHARACTER)
)
)
|
retrieve (by Id) |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x03000000:NameValue):id = '00158000003M6LzAAK' (CHARACTER)
)
)
)
No Input data
|
(0x01000000:Object):JSON = ( ['json' : 0x7fe8dc376bd0]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Id = '00158000003M6LzAAK' (CHARACTER)
(0x01000000:Object ):attributes = (
(0x03000000:NameValue):type = 'Account' (CHARACTER)
(0x03000000:NameValue):url = '/services/data/v34.0/sobjects/Account/00158000003M6LzAAK' (CHARACTER)
)
(0x03000000:NameValue):IsDeleted = FALSE (BOOLEAN)
(0x03000000:NameValue):MasterRecordId = NULL
(0x03000000:NameValue):Name = 'Account-32' (CHARACTER)
(0x03000000:NameValue):Type = 'good' (CHARACTER)
(0x03000000:NameValue):ParentId = NULL
(0x03000000:NameValue):BillingStreet = 'Romsey Road' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Winchester' (CHARACTER)
(0x03000000:NameValue):BillingState = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):BillingPostalCode = 'SO21 2JN' (CHARACTER)
(0x03000000:NameValue):BillingCountry = 'United Kingdom' (CHARACTER)
(0x03000000:NameValue):BillingLatitude = NULL
(0x03000000:NameValue):BillingLongitude = NULL
(0x01000000:Object ):BillingAddress = (
(0x03000000:NameValue):city = 'Winchester' (CHARACTER)
(0x03000000:NameValue):country = 'United Kingdom' (CHARACTER)
(0x03000000:NameValue):countryCode = NULL
(0x03000000:NameValue):geocodeAccuracy = NULL
(0x03000000:NameValue):latitude = NULL
(0x03000000:NameValue):longitude = NULL
(0x03000000:NameValue):postalCode = 'SO21 2JN' (CHARACTER)
(0x03000000:NameValue):state = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):stateCode = NULL
(0x03000000:NameValue):street = 'Romsey Road' (CHARACTER)
)
(0x03000000:NameValue):ShippingStreet = NULL
(0x03000000:NameValue):ShippingCity = NULL
(0x03000000:NameValue):ShippingState = NULL
(0x03000000:NameValue):ShippingPostalCode = NULL
(0x03000000:NameValue):ShippingCountry = NULL
(0x03000000:NameValue):ShippingLatitude = NULL
(0x03000000:NameValue):ShippingLongitude = NULL
(0x03000000:NameValue):ShippingAddress = NULL
(0x03000000:NameValue):Phone = '01962815000' (CHARACTER)
(0x03000000:NameValue):Fax = '01962816666' (CHARACTER)
(0x03000000:NameValue):AccountNumber = '001122334455' (CHARACTER)
(0x03000000:NameValue):Website = 'http://www.ibm.com' (CHARACTER)
(0x03000000:NameValue):PhotoUrl = '/services/images/photo/00158000003M6LzAAK' (CHARACTER)
(0x03000000:NameValue):Sic = NULL
(0x03000000:NameValue):Industry = NULL
(0x03000000:NameValue):AnnualRevenue = NULL
(0x03000000:NameValue):NumberOfEmployees = NULL
(0x03000000:NameValue):Ownership = NULL
(0x03000000:NameValue):TickerSymbol = NULL
(0x03000000:NameValue):Description = NULL
(0x03000000:NameValue):Rating = NULL
(0x03000000:NameValue):Site = NULL
(0x03000000:NameValue):OwnerId = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):CreatedDate = '2016-02-17T13:39:30.000+0000' (CHARACTER)
(0x03000000:NameValue):CreatedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):LastModifiedDate = '2016-02-17T13:39:30.000+0000' (CHARACTER)
(0x03000000:NameValue):LastModifiedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):SystemModstamp = '2016-02-17T13:39:30.000+0000' (CHARACTER)
(0x03000000:NameValue):LastActivityDate = NULL
(0x03000000:NameValue):LastViewedDate = '2016-02-17T13:39:30.000+0000' (CHARACTER)
(0x03000000:NameValue):LastReferencedDate = '2016-02-17T13:39:30.000+0000' (CHARACTER)
(0x03000000:NameValue):Jigsaw = NULL
(0x03000000:NameValue):JigsawCompanyId = NULL
(0x03000000:NameValue):CleanStatus = 'Pending' (CHARACTER)
(0x03000000:NameValue):AccountSource = NULL
(0x03000000:NameValue):DunsNumber = NULL
(0x03000000:NameValue):Tradestyle = NULL
(0x03000000:NameValue):NaicsCode = NULL
(0x03000000:NameValue):NaicsDesc = NULL
(0x03000000:NameValue):YearStarted = NULL
(0x03000000:NameValue):SicDesc = NULL
(0x03000000:NameValue):DandbCompanyId = NULL
(0x03000000:NameValue):CustomerPriority__c = NULL
(0x03000000:NameValue):SLA__c = NULL
(0x03000000:NameValue):Active__c = NULL
(0x03000000:NameValue):NumberofLocations__c = NULL
(0x03000000:NameValue):UpsellOpportunity__c = NULL
(0x03000000:NameValue):SLASerialNumber__c = NULL
(0x03000000:NameValue):SLAExpirationDate__c = NULL
(0x03000000:NameValue):MyExternalId__c = NULL
)
)
|
retrieve using a filter (filter.limit
=2) |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x01000000:Name):filter = (
(0x03000000:NameValue):limit = 2 (INTEGER)
)
)
)
)
|
(0x01000000:Object):JSON = ( ['json' : 0x7f80d02f0710]
(0x01001000:Array):Data = (
(0x01000000:Object):Item = (
(0x03000000:NameValue):Id = '00158000002dQ2eAAE' (CHARACTER)
(0x01000000:Object ):attributes = (
(0x03000000:NameValue):type = 'Account' (CHARACTER)
(0x03000000:NameValue):url = '/services/data/v34.0/sobjects/Account/00158000002dQ2eAAE' (CHARACTER)
)
(0x03000000:NameValue):IsDeleted = FALSE (BOOLEAN)
(0x03000000:NameValue):MasterRecordId = NULL
(0x03000000:NameValue):Name = 'One' (CHARACTER)
(0x03000000:NameValue):Type = NULL
(0x03000000:NameValue):ParentId = NULL
(0x03000000:NameValue):BillingStreet = 'Sanjay Billing Street' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Southampton' (CHARACTER)
(0x03000000:NameValue):BillingState = NULL
(0x03000000:NameValue):BillingPostalCode = NULL
(0x03000000:NameValue):BillingCountry = NULL
(0x03000000:NameValue):BillingLatitude = NULL
(0x03000000:NameValue):BillingLongitude = NULL
(0x01000000:Object ):BillingAddress = (
(0x03000000:NameValue):city = 'Southampton' (CHARACTER)
(0x03000000:NameValue):country = NULL
(0x03000000:NameValue):countryCode = NULL
(0x03000000:NameValue):geocodeAccuracy = NULL
(0x03000000:NameValue):latitude = NULL
(0x03000000:NameValue):longitude = NULL
(0x03000000:NameValue):postalCode = NULL
(0x03000000:NameValue):state = NULL
(0x03000000:NameValue):stateCode = NULL
(0x03000000:NameValue):street = 'Sanjay Billing Street' (CHARACTER)
)
(0x03000000:NameValue):ShippingStreet = 'Sanjay Shipping Street' (CHARACTER)
(0x03000000:NameValue):ShippingCity = 'Southampton' (CHARACTER)
(0x03000000:NameValue):ShippingState = NULL
(0x03000000:NameValue):ShippingPostalCode = NULL
(0x03000000:NameValue):ShippingCountry = NULL
(0x03000000:NameValue):ShippingLatitude = NULL
(0x03000000:NameValue):ShippingLongitude = NULL
(0x01000000:Object ):ShippingAddress = (
(0x03000000:NameValue):city = 'Southampton' (CHARACTER)
(0x03000000:NameValue):country = NULL
(0x03000000:NameValue):countryCode = NULL
(0x03000000:NameValue):geocodeAccuracy = NULL
(0x03000000:NameValue):latitude = NULL
(0x03000000:NameValue):longitude = NULL
(0x03000000:NameValue):postalCode = NULL
(0x03000000:NameValue):state = NULL
(0x03000000:NameValue):stateCode = NULL
(0x03000000:NameValue):street = 'Sanjay Shipping Street' (CHARACTER)
)
(0x03000000:NameValue):Phone = NULL
(0x03000000:NameValue):Fax = NULL
(0x03000000:NameValue):AccountNumber = '12341234' (CHARACTER)
(0x03000000:NameValue):Website = NULL
(0x03000000:NameValue):PhotoUrl = '/services/images/photo/00158000002dQ2eAAE' (CHARACTER)
(0x03000000:NameValue):Sic = NULL
(0x03000000:NameValue):Industry = NULL
(0x03000000:NameValue):AnnualRevenue = NULL
(0x03000000:NameValue):NumberOfEmployees = NULL
(0x03000000:NameValue):Ownership = NULL
(0x03000000:NameValue):TickerSymbol = NULL
(0x03000000:NameValue):Description = NULL
(0x03000000:NameValue):Rating = NULL
(0x03000000:NameValue):Site = NULL
(0x03000000:NameValue):OwnerId = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):CreatedDate = '2016-01-13T22:26:03.000+0000' (CHARACTER)
(0x03000000:NameValue):CreatedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):LastModifiedDate = '2016-01-19T12:35:55.000+0000' (CHARACTER)
(0x03000000:NameValue):LastModifiedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):SystemModstamp = '2016-01-19T12:35:55.000+0000' (CHARACTER)
(0x03000000:NameValue):LastActivityDate = NULL
(0x03000000:NameValue):LastViewedDate = '2016-01-19T12:35:55.000+0000' (CHARACTER)
(0x03000000:NameValue):LastReferencedDate = '2016-01-19T12:35:55.000+0000' (CHARACTER)
(0x03000000:NameValue):Jigsaw = NULL
(0x03000000:NameValue):JigsawCompanyId = NULL
(0x03000000:NameValue):CleanStatus = 'Pending' (CHARACTER)
(0x03000000:NameValue):AccountSource = NULL
(0x03000000:NameValue):DunsNumber = NULL
(0x03000000:NameValue):Tradestyle = NULL
(0x03000000:NameValue):NaicsCode = NULL
(0x03000000:NameValue):NaicsDesc = NULL
(0x03000000:NameValue):YearStarted = NULL
(0x03000000:NameValue):SicDesc = NULL
(0x03000000:NameValue):DandbCompanyId = NULL
(0x03000000:NameValue):CustomerPriority__c = NULL
(0x03000000:NameValue):SLA__c = NULL
(0x03000000:NameValue):Active__c = NULL
(0x03000000:NameValue):NumberofLocations__c = NULL
(0x03000000:NameValue):UpsellOpportunity__c = NULL
(0x03000000:NameValue):SLASerialNumber__c = NULL
(0x03000000:NameValue):SLAExpirationDate__c = NULL
(0x03000000:NameValue):MyExternalId__c = NULL
)
(0x01000000:Object):Item = (
(0x03000000:NameValue):Id = '001580000031ir8AAA' (CHARACTER)
(0x01000000:Object ):attributes = (
(0x03000000:NameValue):type = 'Account' (CHARACTER)
(0x03000000:NameValue):url = '/services/data/v34.0/sobjects/Account/001580000031ir8AAA' (CHARACTER)
)
(0x03000000:NameValue):IsDeleted = FALSE (BOOLEAN)
(0x03000000:NameValue):MasterRecordId = NULL
(0x03000000:NameValue):Name = 'Account-42' (CHARACTER)
(0x03000000:NameValue):Type = 'My Special Type' (CHARACTER)
(0x03000000:NameValue):ParentId = NULL
(0x03000000:NameValue):BillingStreet = NULL
(0x03000000:NameValue):BillingCity = NULL
(0x03000000:NameValue):BillingState = NULL
(0x03000000:NameValue):BillingPostalCode = NULL
(0x03000000:NameValue):BillingCountry = NULL
(0x03000000:NameValue):BillingLatitude = NULL
(0x03000000:NameValue):BillingLongitude = NULL
(0x03000000:NameValue):BillingAddress = NULL
(0x03000000:NameValue):ShippingStreet = NULL
(0x03000000:NameValue):ShippingCity = NULL
(0x03000000:NameValue):ShippingState = NULL
(0x03000000:NameValue):ShippingPostalCode = NULL
(0x03000000:NameValue):ShippingCountry = NULL
(0x03000000:NameValue):ShippingLatitude = NULL
(0x03000000:NameValue):ShippingLongitude = NULL
(0x03000000:NameValue):ShippingAddress = NULL
(0x03000000:NameValue):Phone = NULL
(0x03000000:NameValue):Fax = NULL
(0x03000000:NameValue):AccountNumber = NULL
(0x03000000:NameValue):Website = NULL
(0x03000000:NameValue):PhotoUrl = '/services/images/photo/001580000031ir8AAA' (CHARACTER)
(0x03000000:NameValue):Sic = NULL
(0x03000000:NameValue):Industry = NULL
(0x03000000:NameValue):AnnualRevenue = NULL
(0x03000000:NameValue):NumberOfEmployees = NULL
(0x03000000:NameValue):Ownership = NULL
(0x03000000:NameValue):TickerSymbol = NULL
(0x03000000:NameValue):Description = NULL
(0x03000000:NameValue):Rating = NULL
(0x03000000:NameValue):Site = NULL
(0x03000000:NameValue):OwnerId = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):CreatedDate = '2016-02-01T22:58:06.000+0000' (CHARACTER)
(0x03000000:NameValue):CreatedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):LastModifiedDate = '2016-02-01T22:58:06.000+0000' (CHARACTER)
(0x03000000:NameValue):LastModifiedById = '00558000000a0qdAAA' (CHARACTER)
(0x03000000:NameValue):SystemModstamp = '2016-02-01T22:58:06.000+0000' (CHARACTER)
(0x03000000:NameValue):LastActivityDate = NULL
(0x03000000:NameValue):LastViewedDate = '2016-02-01T22:58:06.000+0000' (CHARACTER)
(0x03000000:NameValue):LastReferencedDate = '2016-02-01T22:58:06.000+0000' (CHARACTER)
(0x03000000:NameValue):Jigsaw = NULL
(0x03000000:NameValue):JigsawCompanyId = NULL
(0x03000000:NameValue):CleanStatus = 'Pending' (CHARACTER)
(0x03000000:NameValue):AccountSource = NULL
(0x03000000:NameValue):DunsNumber = NULL
(0x03000000:NameValue):Tradestyle = NULL
(0x03000000:NameValue):NaicsCode = NULL
(0x03000000:NameValue):NaicsDesc = NULL
(0x03000000:NameValue):YearStarted = NULL
(0x03000000:NameValue):SicDesc = NULL
(0x03000000:NameValue):DandbCompanyId = NULL
(0x03000000:NameValue):CustomerPriority__c = NULL
(0x03000000:NameValue):SLA__c = NULL
(0x03000000:NameValue):Active__c = NULL
(0x03000000:NameValue):NumberofLocations__c = NULL
(0x03000000:NameValue):UpsellOpportunity__c = NULL
(0x03000000:NameValue):SLASerialNumber__c = NULL
(0x03000000:NameValue):SLAExpirationDate__c = NULL
(0x03000000:NameValue):MyExternalId__c = NULL
)
)
)
|
update (using Id) |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x03000000:NameValue):Id = '00158000003M6LzAAK' (CHARACTER)
)
)
)
(0x01000000:Object):JSON = ( ['json' : 0x7fe88c359150]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-32' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'Test Road' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Hedge End' (CHARACTER)
0x03000000:NameValue):BillingState = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):BillingPostalCode = 'SO30' (CHARACTER)
(0x03000000:NameValue):BillingCountry = 'United Kingdom' (CHARACTER)
)
)
|
(0x01000000:Object):JSON = ( ['json' : 0x7fe8dc43c460]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-32' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'Test Road' (CHARACTER)
(0x03000000:NameValue):BillingCity = 'Hedge End' (CHARACTER)
(0x03000000:NameValue):BillingState = 'Hampshire' (CHARACTER)
(0x03000000:NameValue):BillingPostalCode = 'SO30' (CHARACTER)
(0x03000000:NameValue):BillingCountry = 'United Kingdom' (CHARACTER)
(0x03000000:NameValue):Id = '00158000003M6LzAAK' (CHARACTER)
)
)
|
update (using external Id
and the Salesforce record did not already exist) |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x03000000:NameValue):externalIdName = 'MyExternalId__c' (CHARACTER)
(0x03000000:NameValue):externalId = 'special4' (CHARACTER)
)
)
)
(0x01000000:Object):JSON = ( ['json' : 0x7f80f817c0a0]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-82' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'New Road' (CHARACTER)
)
)
|
(0x01000000:Object):JSON = ( ['json' : 0x7f80d0188760]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-82' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'New Road' (CHARACTER)
(0x03000000:NameValue):Id = '00158000003MBiuAAG' (CHARACTER)
)
)
|
update (using external Id
and the Salesforce record already existed) |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x03000000:NameValue):externalIdName = 'MyExternalId__c' (CHARACTER)
(0x03000000:NameValue):externalId = 'special4' (CHARACTER)
)
)
)
(0x01000000:Object):JSON = ( ['json' : 0x7f80f817c0a0]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-82' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'New Road' (CHARACTER)
)
)
|
(0x01000000:Object):JSON = ( ['json' : 0x7f80d0188760]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Name = 'Account-82' (CHARACTER)
(0x03000000:NameValue):BillingStreet = 'New Road' (CHARACTER)
)
)
|
delete |
LocalEnvironment:
(0x01000000:Name):Destination = (
(0x01000000:Name):Salesforce = (
(0x01000000:Name):Request = (
(0x03000000:NameValue):id = '00158000003M82WAAS' (CHARACTER)
)
)
)
No Input data
|
(0x01000000:Object):JSON = ( ['json' : 0x7fe128478650]
(0x01000000:Object):Data = (
(0x03000000:NameValue):Id = '00158000003M82WAAS' (CHARACTER)
)
)
|