ステップ 3: メタデータ API を使用してコンポーネントを取得する

メタデータ API を取得するための 2 つのオプション

2 つのコマンドのいずれかを使用してメタデータコンポーネントを取得できます。

1. package.xml マニフェストで指定されたコンポーネントを取得するには、Salesforce CLI の source コマンドを使用して retrieve コールを発行します。コマンドラインで、適切なファイルパスを使用して次のコールを実行します。

   sfdx force:source:retrieve -x path/to/package.xml

   メタデータの retrieve() は非同期のファイルベースのコマンドです。リソースが使用可能なときに単独で動作する複数の取得要求またはリリース要求を発行できます。

   このコマンドでは、package.xml マニフェストで指定されているすべてのカスタムオブジェクトを取得する要求を送信します。要求は、システムが retrieve コールを処理できる状態になるまでキューに登録されます。要求がキューから取り出されると、retrieve コールが実行されます。クライアントで retrieve の状況が確認され、コールが完了すると通知されます。このコールでは、選択されたコンポーネントのファイル表現が返されます。Salesforce CLI を使用して retrieve コールを発行すると、このすべてのプロセスが自動化されます。

   ここでは mdapi コマンドではなく source コマンドを使用します。source コマンドではソース追跡が可能なため、開発者は一般に source コマンドを使用します。ソース追跡には作業の対象であるリビジョンや最終変更日時に関する情報が含まれるため、source コマンドはより開発者に適したコマンドになります。source コマンドを実行するには、ソース追跡が組織で有効になっていることを確認します。

2. または、ターミナルで次のコマンドを実行します。

   sfdx force:mdapi:retrieve -k path/to/package.xml

   この mdapi コマンドは source コマンドと同じプロセスに従います。mdapi コマンドにはソース追跡が含まれないため、実際にはシステム管理者は mdapi コマンドをより頻繁に使用します。

トラブルシューティング