メタデータ API 開発者ガイド
jREST リソース
XML ファイルのデータは、英語 (米国) ロケールで書式設定されます。このアプローチによって、異なる言語を使用する組織間でデータを移行するときに、ロケールに依存する日付項目などの項目が一貫して解釈されます。組織は、ユーザーに表示するための複数の言語をサポートできます。
メタデータリリースは、主に、次の開発状況で使用されます。
- Sandbox 組織でのカスタムアプリケーション (またはカスタマイズ) の開発。開発およびテストが完了すると、アプリケーションまたはカスタマイズはメタデータ API を使用して本番組織にリリースされます。
- Developer Edition 組織でのアプリケーションのチーム開発。開発とテストが完了すると、Lightning Platform AppExchange 経由でアプリケーションを配布できます。
Zip ファイルの使用
deployRequest リソースは、.zip ファイルをリリースするために使用されます。.zip ファイル内には、取得またはリリースする項目の一覧を示すプロジェクトマニフェスト (package.xml) やフォルダーに整理された 1 つ以上の XML コンポーネントが含まれます。
.zip ファイルでリリースするファイルには、組織内にあるパッケージ化されていないコンポーネント (標準オブジェクトなど) を使用できます。また、名前付きパッケージ内に存在するパッケージコンポーネントのファイルを使用することもできます。
各 .zip ファイルには、プロジェクトマニフェスト、package.xml という名前のファイル、およびコンポーネントを含むディレクトリのセットが含まれます。マニフェストファイルは、取得またはリリースしようとしているコンポーネント、およびリリースまたは取得で使用される API バージョンを定義します。
package.xml ファイルのサンプルを次に示します。
次の要素は、package.xml に定義されている場合があります。
- <fullName> には、サーバー側パッケージの名前が含まれます。<fullName> が存在しない場合、これは、クライアント側の unpackaged パッケージです。
- <types> には、リリースされるメタデータ型の名前 (CustomObject など) および指定メンバー (myCustomObject__c など) が含まれます。マニフェストファイルには複数の <types> 要素を追加できます。
- <members> には、MyCustomObject__c など、コンポーネントの fullName が含まれます。多くのメタデータ型の場合、各メンバーを個別に書き出す代わりに、members の値をワイルドカード文字 * (アスタリスク) に置き換えることができます。ワイルドカード文字を使用できるメタデータ型のリストについては、メタデータ型の「ワイルドカード (*) を使用できるか」の列を参照してください。
- <name> には、CustomObject または Profile などのメタデータ型が含まれます。ディレクトリの各メタデータ型には 1 つの名前が定義されています。Metadata を拡張するすべてのメタデータ型は有効な値です。入力される名前は、メタデータ API WSDL に定義されているメタデータ型に一致する必要があります。リストについては、「メタデータ型」を参照してください。
- <version> は、.zip ファイルをリリースまたは取得するときに使用する API のバージョン番号です。現在のところ、有効な値は 60.0 です。
異なるメタデータのサブセットを使用する方法を説明した package.xml マニフェストファイルのその他のサンプルは、「package.xml マニフェストファイルのサンプル」を参照してください。
コンポーネントを削除する場合は、「組織からのコンポーネントの削除���を参照してください。