この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

readMetadata()

組織から 1 つ以上のメタデータコンポーネントを同期して返します。

構文

readMetadata() コールは、メタデータを拡張するすべてのコンポーネントの取得に使用します。同一コール内のすべてのコンポーネントは、同じ種類である必要があります。詳細は、「Metadata コンポーネントおよびメタデータ型」を参照してください。

このコールは同期して実行されます。つまり、コールは、操作が完了したときにのみ戻ります。

API バージョン 30.0 以降で利用できます。

クライアントアプリケーションは、「すべてのデータの編集」権限または「メタデータ API 関数を使用したメタデータを変更」権限でログインしている必要があります。

ユーザにメタデータへのアクセス権が必要でデータへのアクセス権は不要な場合、「メタデータ API 関数を使用したメタデータを変更」権限を有効にして、組織データへのアクセス権を付与せずにユーザが必要としているアクセス件を付与することができます。

メモ

メタデータコンポーネントを読み込むには、次のプロセスを使用します。

読み込むコンポーネントのメタデータ型と、読み込む各コンポーネントの fullName を判別します。fullName 項目についての詳細は、「Metadata」を参照してください。1 つのコールで読み込めるのは同じ型のコンポーネントのみです。
readMetadata() コールを呼び出します。最初の引数で、メタデータ型の名前を渡します。メタデータ型は、describeMetadata() コールで返された値のいずれかと一致する必要があります。2 つ目の引数で、取得するコンポーネントに対応する完全名の配列を渡します。完全名は、listMetadata() コールで返された完全名の 1 つ以上と一致する必要があります。
Metadata コンポーネントの配列が含まれる ReadResult が返されます。返された各 Metadata オブジェクトを、コールで指定したメタデータ型にキャストしてコンポーネントのプロパティを取得します。

名前	型	説明
metadataType	string	読み込むコンポーネントのメタデータ型。
fullNames	string[]	読み込むコンポーネントの完全名の配列。上限: 10。(CustomMetadata および CustomApplication の場合のみ、上限は 200)。 1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。

名前

型

説明

metadataType

string

読み込むコンポーネントのメタデータ型。

fullNames

string[]

読み込むコンポーネントの完全名の配列。

上限: 10。(CustomMetadata および CustomApplication の場合のみ、上限は 200)。

1 つの種類のコンポーネントの配列を送信する必要があります。たとえば、10 個のカスタムオブジェクトの配列または 10 個のプロファイルの配列を送信できますが、両方の種類を混ぜて送信することはできません。