ListRead

Extracts list configuration data.

Usage

Use the ListRead method to read list configuration data.

You can use the following elements of apQuery:List to query lists:

• <RecordType>

• <ListName>

• <ListType>

• <CreatedByAlias>

• <ModifiedByAlias>

You can read the following types of list:

• Public lists. No privileges are required to read public lists.

• Private lists. To read private lists defined by all users in the company, the Manage Private Lists privilege is required. No privilege is required to read private lists created by the currently logged-in user.

• Role-specific lists. To read all role-specific lists defined for the company, the Manage Public Lists privilege is required.

• System lists. To return system lists you can specify System for <ListType>. Otherwise, if the <IncludeAll> child element of apQuery:List specifies true, the ListRead method returns all lists including system lists. If <IncludeAll> specifies false, or is not included in the request, the method returns all configuration data except system list data.

Note: If the ListRead method is invoked with any search fields other than <RecordType>, or <ListType> with a value other than System, then even if <IncludeAll> is true, the system lists are not returned.

The following table shows which lists you can read when your role has the Manage Public Lists or Manage Private Lists privilege:

Table Privileges and Access to Lists

Manage Public Lists	Manage Private Lists	Private Lists	Role-specific Lists	Public Lists
Yes	Yes	All	All	All
Yes	No	Private lists created by the currently logged-in user only	All	All
No	Yes	All	Lists for the currently logged-in user’s role only	All
No	No	Private lists created by the currently logged-in user only	Lists for the currently logged-in user’s role only	All

Note: Lists for the current user's role can include lists not created by the current user.

The lists returned can include private lists with the same name, but created by different users, and role-specific lists with the same name, but for different roles.

See ListUpsert for information about the list data returned in apData:List.

For more information about working with lists, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the ListRead method.

Table Arguments Taken by the List Read Method

Name	Description	Required	Default	I/O
apQuery:List	The list query criteria.	Yes	Not applicable	Input
apData:ListOfLists	The extracted list configuration data.	Not applicable	Not applicable	Output

Return Value of the Call

The list data is returned.