Force.com Tooling API
jNewer Version Available
Setup Objects
Use setup objects to interact with metadata for declarative development. For example,
you may wish to create your own version of Setup, or restrict the amount of data you need to
push to an app on a mobile phone.
- BusinessProcess
- Represents a business process.
- CompactLayout
- Represents the values that define a compact page layout.
- CompactLayoutItemInfo
- Represents a field selected for a compact layout, and the order of that field in the compact layout.
- CompactLayoutInfo
- Represents the metadata for a custom or standard compact 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.
- EntityLimit
- Represents the limits for an object as displayed in the Setup UI.
- FieldDefinition
- Represents a standard or custom field, providing row-based access to field metadata. Contrast FieldDefinition with EntityParticle, which represents each element of a field that can be presented in a user interface.
- 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.
- Flow
- Use the Flow object to retrieve and update specific flow versions.
- FlowDefinition
- The parent of a set of flow versions.
- HistoryRetentionJob
- Represents the body of retained data from the archive, and the status of the archived data.
- Layout
- Represents a page layout.
- LookupFilter
- Represents a lookup filter, which restricts the valid values and lookup dialog results for lookup, master-detail, and hierarchical relationship fields.
- 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.
- SearchLayout
- Represents a search layout defined for an object.
- Scontrol
- Represents a custom s-control, which is custom content that our system hosts, but client applications execute. An s-control can contain any type of content that you can display or run in a Web browser.
- User
- Represents a user. You can retrieve standard fields on User with the Tooling API, but custom fields can’t be retrieved.
- WebLink
- Represents a custom link to a URL or S-control.
- ValidationRule
- Represents a validation rule or workflow rule which specifies the formula for when a condition is met.
- 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.