Get started with Metadata API by retrieving a small set of metadata components from your org on the Salesforce CLI.
If you’re a beginner developer and haven’t used Salesforce CLI before, learn how to set up your environment and practice with a sample application. These Trailheads guide you through setup with SFDX and introduce you to Metadata API.
App Development with Salesforce DX
Walk through setting up your environment and developing with Salesforce CLI using the Dreamhouse sample app. After you add a feature to your Dreamhouse app, you deploy metadata to your Dev Hub org with Salesforce CLI.
Package.xml Metadata Management
Learn more about metadata and package.xml files. Build a package.xml file to deploy changes from a scratch org to your Trailhead Playground.
If you have some experience in Salesforce development but want to get started with Metadata API, use this quick start. The quick start walks you through a retrieval of metadata components, which is the first step of the development process.
Metadata Development Prerequisites
Complete these prerequisites before you start developing with Metadata API.
Step 1: (Optional) Add Metadata Components to an Org Using the UI
If you’re starting with a new practice org that doesn’t have customizations, you only have standard metadata that can’t be retrieved. To use the Metadata API retrieve call, add a component on the Salesforce UI to your practice org. If you’re working on an existing project, you already have components to retrieve and can skip this step.
Step 2: Build a Package.xml Manifest
The package.xml manifest file lists the components to retrieve from your org.
Step 3: Retrieve Components with Metadata API
With Salesforce CLI, retrieve a file representation of the specified components in your package.xml manifest.
See Also
j
