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

listMetadata()

このコールは組織のメタデータコンポーネントに関するプロパティ情報を取得します。queries パラメータで指定されている条件に一致したコンポーネントのデータが返されます。queries 配列には各コールに対する最大 3 つの ListMetadataQuery クエリを含めることができます。このコールは、CustomObject や ApexClass などの最上位の型、および CustomField や RecordType などの子の型の両方のすべてのメタデータ型をサポートします。

構文

1FileProperties[] = metadataConnection.listMetadata(ListMetadataQuery[] queries, double asOfVersion);

使用方法

このコールは、retrieve() コールの package.xml の個々のコンポーネントを識別する場合、または組織の特定のメタデータ型の概要が必要な場合に役立ちます。たとえば、このコールを使用して、組織のすべての CustomObject コンポーネントまたは Layout コンポーネントの名前のリストを返すことができます。さらに、この情報を使用して後続の retrieve() コールを実行し、これらのコンポーネントのサブセットを返すことができます。package.xml の使用についての詳細は、「メタデータのリリースと取得」を参照してください。

こ��は同期コールのため、結果が 1 つのコールで返されます。このコールは、結果を取得するために少なくとも 1 つの後続のコールが必要な retrieve() などの非同期コールとは異なります。

メモ

権限

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

メタデータへのアクセス権がユーザに必要で、データへのアクセス権は必要でない場合、「メタデータ API 関数を使用したメタデータの変更」権限を有効にします。それ以外の場合は、「すべてのデータの編集」権限を有効にします。

メモ

サンプルコード — Java

以下のサンプルコードでは、カスタムオブジェクトの情報を表示します。このコードは、SOAP バインドがすでに確立されていることを前提としています。

1public void listMetadata() {
2  try {
3    ListMetadataQuery query = new ListMetadataQuery();
4    query.setType("CustomObject");
5    //query.setFolder(null);
6    double asOfVersion = 55.0;
7    // Assuming that the SOAP binding has already been established.
8    FileProperties[] lmr = metadataConnection.listMetadata(
9        new ListMetadataQuery[] {query}, asOfVersion);
10    if (lmr != null) {
11      for (FileProperties n : lmr) {
12        System.out.println("Component fullName: " + n.getFullName());
13        System.out.println("Component type: " + n.getType());
14      }
15    }            
16  } catch (ConnectionException ce) {
17    ce.printStackTrace();
18  }
19}

引数

名前	型	説明
queries	`ListMetadataQuery`[]	目的のコンポーネントを指定するオブジェクトのリスト。
asOfVersion	double	要求のリストを表示するメタデータの API バージョン。この項目に値を指定しない場合、ログイン時に指定したデフォルトの API バージョンになります。この項目を使用してデフォルトを上書きし、他の API バージョンを設定できます。たとえば、ログイン時に指定した API バージョンより後のバージョンで追加されたメタデータ型のメタデータのリストを表示できます。この項目は API バージョン 18.0 以降で使用できます。

応答

FileProperties

メタデータ API 開発者ガイド

listMetadata()

構文

使用方法

権限

サンプルコード — Java

引数

応答