GetLists

Gets the set of lists that the current user has access to for a specified object.

Usage

You use the GetLists method to query the details of the lists for an object.

The ObjectName argument specifies the object to be queried. The names of system lists and public and private lists are returned. The set of list names is equivalent to the set of list names visible to the user in the Manage Lists page UI.

ListQueryPage is supported for all objects that support list management.

The list names returned can be used in a QueryPage operation to retrieve the set of records matching the list filter criteria.

Arguments

The following table describes the arguments taken by the GetLists method:

Table Arguments Taken by the Get Lists Method

Name	Description	Required	Default	I/O
ObjectName	The name of the object.	Yes	Not applicable	Input
ListOfLists	The list of lists returned for the object.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned for each list:

• Name. The name of the list.

• ListType. Whether the list is a system list, public list, or a private list created by the current user.

Sample SOAP Request - GetLists

The following SOAP request retrieves the set of lists visible to the authenticated user for the account record type as specified in the <ObjectName> argument:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ListsWS_GetLists_Input xmlns="urn:crmondemand/ws/lists/">
         <ObjectName>Account</ObjectName>
      </ListsWS_GetLists_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the lists for the account object:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ListsWS_GetLists_Output xmlns:ns="urn:crmondemand/ws/lists/">
         <ListofLists xmlns="urn:/crmondemand/xml/lists">
            <List>
               <Name>All Account Competitor Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Account Partner Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Customer Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Prospect Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Referenceable Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Top Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Recently Created Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Recently Modified Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>Recently Created Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>Recently Modified Accounts</Name>
               <ListType>System</ListType>
            </List>
         </ListofLists>
      </ns:ListsWS_GetLists_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>