listMetadata()

Syntax

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

Usage

This call is useful when you want to identify individual components in package.xml for a retrieve() call or if you want a high-level view of particular metadata types in your organization. For example, you can use this call to return a list of names of all the CustomObject or Layout components in your organization. You can use this information to make a subsequent retrieve() call to return a subset of these components. For more information about working with package.xml, see Deploying and Retrieving Metadata.

This call is synchronous, so the results are returned in one call. This call differs from asynchronous calls, such as retrieve(), where at least one subsequent call is required to get the results.

Permissions

Your client application must be logged in with the Modify Metadata Through Metadata API Functions or Modify All Data permission.

Sample Code—Java

This sample code lists information about your custom objects. The code assumes that the SOAP binding has already been established.

public void listMetadata() {
  try {
    ListMetadataQuery query = new ListMetadataQuery();
    query.setType("CustomObject");
    //query.setFolder(null);
    double asOfVersion = 63.0;
    // Assuming that the SOAP binding has already been established.
    FileProperties[] lmr = metadataConnection.listMetadata(
        new ListMetadataQuery[] {query}, asOfVersion);
    if (lmr != null) {
      for (FileProperties n : lmr) {
        System.out.println("Component fullName: " + n.getFullName());
        System.out.println("Component type: " + n.getType());
      }
    }            
  } catch (ConnectionException ce) {
    ce.printStackTrace();
  }
}

Arguments

Response

FileProperties