Overview
The following operations allow you to work with sObjects. Click an operation name to see details on how to use it.
| Operation | Description |
|---|---|
| Retrieves the objects that are available in the system. | |
| describeSObject | Retrieves metadata (such as name, label, and fields, including the field properties) for a specific object type. |
| describeSObjects | Retrieves metadata (such as name, label, and fields, including the field properties) for multiple object types. |
An sObject refers to any object that can be stored in the Force.com platform database and includes all the standard and custom objects in your organization. With the Salesforce connector operations, you can define an sObject structure in the message payload, which you can send directly from the caller or generate using the PayloadFactory mediator in ESB as follows:
<payloadFactory>
<format>
<sfdc:sObjects xmlns:sfdc="sfdc" type="Account">
<sfdc:sObject>
<sfdc:Name>value01</sfdc:Name>
</sfdc:sObject>
<sfdc:sObject>
<sfdc:Name>value02</sfdc:Name>
</sfdc:sObject>
</sfdc:sObjects>
</format>
<args/>
</payloadFactory>
Operation Details
This section provides further details on the operations related to sObjects.
Retrieving a list of available objects
To retrieve a list of objects that are available in the system, use salesforce.describeGlobal.
<salesforce.describeGlobal configKey="MySFConfig"/>
Retrieving metadata for a specific object type
To retrieve metadata (such as name, label, and fields, including the field properties) for a specific object type, use salesforce.describeSobject and specify the following properties.
<salesforce.describeSobject configKey="MySFConfig">
<sobject>Account</sobject>
</salesforce.describeSobject>
Properties
sobject: The object type of where you want to retrieve the metadata.
Related Salesforce Documentation
http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobject.htm
Retrieving metadata for multiple object types
To retrieve metadata (such as name, label, and fields, including the field properties) for multiple object types returned as an array, use salesforce.describeSobjects and specify the following properties.
<salesforce.describeSobjects configKey="MySFConfig">
<sobjects xmlns:sfdc="sfdc">{//sfdc:sObjects}</sobjects>
</salesforce.describeSobjects>
Properties
sobjects: An XML representation of the object types of where you want to retrieve the metadata.
Sample
<payloadFactory>
<format>
<sfdc:sObjects xmlns:sfdc="sfdc">
<sfdc:sObjectType>Account</sfdc:sObjectType>
<sfdc:sObjectType>Contact</sfdc:sObjectType>
</sfdc:sObjects>
</format>
<args/>
</payloadFactory>
<salesforce.describeSobjects configKey="MySFConfig">
<sobjects xmlns:sfdc="sfdc">{//sfdc:sObjects}</sobjects>
</salesforce.describeSobjects>
Related Salesforce Documentation
http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobjects.htm