Tooling API

Introducing Tooling API
SOAP Calls
Tooling API Objects and Namespaces
SOQL Operation Limitations
SOSL Operation Limitations
Considerations for CRUD Operations in Active Orgs
Allow Metadata Save Operations to Complete with Returned Warnings
System Fields
ApiFault Element
Programming Objects
Setup Objects
Tooling Objects
Operational Objects
Tooling API Objects
SOAP Headers for Tooling API
REST Headers for Tooling API
PDF

Setup Objects

Use setup objects to interact with metadata for declarative development. For example, you can create your own version of Setup, or restrict the amount of data required to push to an app to a mobile phone.
  • AuthorizedEmailDomain: Represents an authorized domain for email verification.
  • BusinessProcess: Represents a business process.
  • CleanDataService: Represents a data service that adds and updates data in existing records in an org.
  • CleanRule: Represents a data integration rule that controls how a data service adds and updates data for existing records in an org.
  • CompactLayout: Represents the values that define a compact page layout.
  • CompactLayoutInfo: Represents the metadata for a custom or standard compact layout.
  • CompactLayoutItemInfo: Represents a field selected for a compact layout, and the order of that field in the 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.
  • DataAssessmentConfigItem: Represents a saved configuration for a specific vendor’s package for data assessment.
  • DataIntegrationRecordPurchasePermission: Represents Lightning Data purchase credits that a Salesforce admin has granted to users.
  • DuplicateJobDefinition: Setup object defining a job that identifies duplicate record items globally.
  • DuplicateJobMatchingRuleDefinition: Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition.
  • Document: Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object.
  • EmailTemplate: Represents a template for an email, mass email, list email, or HVS email.
  • 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. FieldDefinition has parity with metadata type Field.
  • FieldMapping: Represents a mapping between fields in an object in the org and fields in a data service. A data service uses two separate field maps: one controls how the data service matches records in an object, and the other controls how the data service adds or updates data for an existing record.
  • FieldMappingField: Represents a field in an object in the org that maps to a field in a data service.
  • FieldMappingRow: Represents a field in a data service record that maps to a field in an object record in the org.
  • FieldSet: Represents the metadata for a group of fields.
  • FlexiPage: Represents a Lightning page. A Lightning page is a customizable page composed of regions containing Lightning components.
  • Flow: Use the Flow object to retrieve and update specific flow versions.
  • FlowDefinition: The parent of a set of flow versions.
  • Group: Represents a set of User records. Groups can contain individual users, other groups, or the users in a particular role or territory. In addition, groups can contain all users below a particular role or territory in the hierarchy.
  • HistoryRetentionJob: Represents the body of retained data from the archive, and the status of the archived data.
  • KeywordList: Represents a list of keywords used in Experience Cloud site moderation.
  • 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.
  • MatchingRule: Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. Available in Tooling API version 42.0 and later.
  • MenuItem: Represents a menu item.
  • ModerationRule: Represents a rule used in your Experience Cloud site to moderate member-generated content.
  • PermissionSet: Represents a set of permissions that’s used to grant more access to users without changing their profile or reassigning profiles. Available in API version 28.0 and later.
  • PermissionSetAssignment: Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later.
  • PermissionSetGroup: Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. Available in Tooling API version 45.0 and later.
  • PermissionSetGroupComponent: A junction object that relates the PermissionSetGroup and PermissionSet objects via their respective IDs; enables permission set group recalculation to determine the aggregated permissions for the group. Available in Tooling API version 45.0 and later.
  • PermissionSetTabSetting: Represents a tab’s settings for a profile or permission set. Use PermissionSetTabSetting for manipulating tab visibility on profiles and permission sets. Available in Tooling API version 37.0 and later.
  • 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 button or link.
  • 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 sends information to a designated endpoint, like an external service. Outbound messages are configured from Setup. You must configure the external endpoint and 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.