Newer Version Available

This content describes an older version of this product. View Latest

describeSoqlListViews()

Retrieves the SOQL query and other information about a list view.

Syntax

1connection.describeSoqlListViews(DescribeSoqlListViewsRequest request);

Usage

Use the describeSoqlListViews() call to retrieve information about a list view, including the ID, the columns, and the SOQL query. This call is useful if you want to use the SOQL that drives an existing list view in your custom application. This call is available in API version 32.0 and later.

Sample Code—Java

1public void example() throws Exception {
2         DescribeSoqlListViewsRequest request = createDescribeSoqlListViewsRequest(listViewId, null);
3         this.getClient().describeSoqlListViews(request);      
4      }

Arguments

Name Type Description
request DescribeSoqlListViewsRequest The fully qualified name or the ID of the list view and the object with which the list view is associated.

Response

A DescribeSoqlListViewResult object that contains one or more DescribeSoqlListView objects.