Newer Version Available

This content describes an older version of this product. View Latest

Setup Objects

These objects are primarily used for interacting with metadata for declarative development.

Object Description
BusinessProcess Represents a business process.
CompactLayout Represents the values that define a compact page layout.
CustomField Represents a custom field on a custom object that stores data unique to your organization.
CustomFieldMember Represents the working copy of a field for editing or saving in a MetadataContainer.
CustomObject Represents a custom object that stores data unique to your organization. Includes access to the associated CustomObject object and related fields in Salesforce Metadata API.
CustomTab Represents a custom tab.
EmailTemplate Represents an email template.
EntityDefinition Provides row based access to metadata about standard and custom objects.
FieldDefinition Provides row based access to metadata about standard and custom fields of standard and coustom objects.
FieldSet Represents the metadata for a group of fields.
FlexiPage Represents a Lightning Page. A Lightning Page is the home page for an app that appears as a menu item in the Salesforce1 navigation menu. Includes access to the associated FlexiPage object in the Salesforce Metadata API.
Layout Represents a page layout. For more information, see “Managing Page Layouts” in the Salesforce online help.
MenuItem Represents a menu item.
Profile Represents a user profile. A profile defines a user's permission to perform different functions within Salesforce.
ProfileLayout Represents a profile layout.
QuickActionDefinition Represents the definition of a quick action.
QuickActionList Represents a list of quick actions.
QuickActionListItem Represents an item in a quick action list.
RecentlyViewed Represents metadata entities typically found in Setup such as page layout definitions, workflow rule definitions, and email templates that the current user has recently viewed.
RecordType Represents a custom record type.
User Represents a user.
ValidationRule Represents a formula that is used for specifying when a criteria is met. This includes both validation rules and workflow rules. Includes access to the associated ValidationRule object in the Salesforce Metadata API.
WorkflowAlert Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients.
WorkflowFieldUpdate Represents a workflow field update.
WorkflowOutboundMessage Represents an outbound message. An outbound message is a workflow, approval, or milestone action that sends the information you specify to an endpoint you designate, such as an external service. Outbound messaging is configured in the Salesforce setup menu. Then you must configure the external endpoint. You can create a listener for the messages using the SOAP API.
WorkflowRule Represents a workflow rule that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.
WorkflowTask Represents a workflow task that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.