Salesforce Metadata icon

Salesforce Metadata

Interact with Salesforce metadata APIs
Join our community

Actions5

Overview

This node interacts with Salesforce metadata APIs, specifically supporting operations like describing global objects, describing a single SObject, listing metadata components, executing Tooling API queries, and fetching org limits and API versions. It is useful for Salesforce administrators and developers who need to query and manage Salesforce metadata programmatically. For example, it can be used to retrieve a list of all SObjects in an org, describe the fields of a specific SObject, run SOQL queries against the Tooling API, or get current org limits.

Use Case Examples

  1. Retrieve all standard and custom SObjects in a Salesforce org.
  2. Describe the fields and properties of the Account SObject.
  3. List metadata components of type ApexClass or CustomObject.
  4. Execute a SOQL query using the Tooling API to fetch Apex classes matching certain criteria.

Properties

Name Meaning
Authentication Method of authentication to Salesforce, either OAuth2 or JWT Bearer.
API Version Salesforce API version to use, e.g., v59.0 or 'auto' to detect the latest version.
SOQL SOQL query string for the Tooling API. Only SELECT statements are allowed.
Max Items Maximum number of records to return from the Tooling API query.
Include Deleted Whether to include soft deleted records by using the queryAll endpoint.
Raw Response Return the raw Salesforce API response instead of cleaned output.

Output

JSON

  • json
    • name - Name of the Salesforce object or metadata component (for describeGlobal and describeSObject).
    • label - Label of the Salesforce object (for describeGlobal and describeSObject).
    • custom - Boolean indicating if the object is custom.
    • searchable - Boolean indicating if the object is searchable.
    • createable - Boolean indicating if the object can be created via API.
    • fields - Array of field descriptions for a single SObject (describeSObject operation).
    • limits - Current org limits (for limits operation).
    • apiVersions - Available API versions in the org (for limits operation).
    • _source - Indicates the source of the data, e.g., 'rest-describe' or 'tooling'.

Dependencies

  • An API key credential for Salesforce OAuth2 or JWT authentication

Troubleshooting

  • Ensure the SOQL query is a valid SELECT statement when using the Tooling Query operation.
  • If the node throws an error about missing SObject API name, provide a valid API name for the describeSObject operation.
  • Check API version compatibility if metadata or describe calls fail; use 'auto' to detect the latest version automatically.
  • If the node returns an error related to authentication, verify that the OAuth2 or JWT credentials are correctly configured and valid.

Links

Discussion