Database.com Metadata API Developer's Guide - Salesforce.com

Utility CallslistMetadata()SyntaxFileProperties[] = metadataConnection.listMetadata(ListMetadataQuery[] queries, doubleasOfVersion);UsageThis call is useful when you want to identify individual components in package.xml for a retrieve() call or if you wanta high-level view of particular metadata types in your organization. For example, you could use this call to return a list of namesof all the CustomObject components in your organization, and use this information to make a subsequent retrieve() callto return a subset of these components. For more information about working with package.xml, see Deploying and RetrievingMetadata on page 14.Note: This is a synchronous call so the results are returned in one call. This differs from asynchronous calls, such asretrieve(), where at least one subsequent call is needed to get the results.PermissionsYour client application must be logged in with the “Modify All Data” permission.Sample Code—JavaThe sample code below lists information about your custom objects. The code assumes that the SOAP binding has alreadybeen established.public void listMetadata() {try {ListMetadataQuery query = new ListMetadataQuery();query.setType("CustomObject");//query.setFolder(null);double asOfVersion = 30.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();}}ArgumentsNamequeriesasOfVersionTypeListMetadataQuery[]doubleDescriptionA list of objects that specify which components you are interested in.The API version for the metadata listing request. If you don't specify a value in thisfield, it defaults to the API version specified when you logged in. This field allowsyou to override the default and set another API version so that, for example, youcould list the metadata for a metadata type that was added in a later version than theAPI version specified when you logged in. This field is available in API version 18.0and later.57