ListUpsert

Updates existing list configuration data or inserts new list configuration data.

Usage

Use the ListUpsert method to insert or update list configuration data.

For insert and update operations, the user keys are as follows:

• For private lists: <RecordType> + <ListName> + <ListType> + <UserSignInID>

• For role-specific lists: <RecordType> + <ListName> + <ListType> + <RoleName>

• For public lists: <RecordType> + <ListName> + <ListType>

The following table shows the types of lists that you can insert or update when your role has the Manage Public Lists or Manage Private Lists privilege.

Note: You cannot insert or update a system list. Any attempts to do so are ignored.

Table Privileges and Access to Lists for Inserting or Updating 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	None	None
No	No	Private lists created by the currently logged-in user only	None	None

The apData:List argument contains the following elements containing list data:

• RecordType. The record type. This element is required for insert and update operations, and is read-only for update operations.

• ListName. The name of the list. This element is required for insert and update operations, and is read-only for update operations.

• ListType. The type of list. The valid values are: Public, Private, and Role Specific. This element is read-only for update operations. For insert operations, if the type is not specified, and if the <UserSignInId> element is not specified, then the list is created as a private list for the currently logged-in user.

• UserSignInId. For private lists only, the sign-in ID of the user who owns the private list.

• CreatedByAlias. The alias of the user who created the list. In insert operations, the CreatedByAlias field on the list is always set to the identifier of the currently logged-in user.

• ModifiedByAlias. The alias of the user who last modified the list. In insert and update operations, the ModifiedByAlias field on the list is always set to the alias of the currently logged-in user.

• RoleName. The role to which the list is applicable. This element is applicable for role-specific lists only.

• CreatedById. The identifier of the user who created the list. In insert operations, the CreatedByID field on the list is always set to the identifier of the currently logged-in user.

• ModifiedById. The identifier of the user who last modified the list. In insert and update operations, the ModifiedById field on the list is always set to the identifier of the currently logged-in user.

• CreatedDate. The date and time the list was created.

• ModifiedDate. The date and time the list was last modified.

• Description. A description of the list.

• SearchIn. The record set from which records are returned. This element is required for insert and update operations.

  For insert and update operations, the valid values are:

  • All records I can see

  • All records I own

  • All records where I am on the team

  • All records I or my subordinates own

  • All records where I or my subordinates are on the team

  • My Default Book

  In addition to the above values, the SearchIn element can specify the name of a book. For insert and update operations, the book must already exist.

• CaseInsensitiveFlag. Whether fields are case-sensitive in searches (false) or are not case-sensitive (true).

• LanguageCode. For system lists, the language code for the currently logged-in user in the output from read operations. For other lists, the language code in which the list was created. If you do not specify the language code for a new list, then the language code of the currently logged-in user is used. This element is ignored in update operations.

• ListOfFilterInformation. The filter information for the list, contained in child elements of the <FilterInfo> element:

  • Conjunction. The operator And or Or. If a conjunction is not specified for an insert operation, then the And conjunction is used.

  • FieldName. The system name of the field.

  • Condition. The condition for the filter. For information about which filter conditions are valid for the various field types, see Oracle CRM On Demand Online Help.

  • FilterValue. The filter value.

  • FilterValueAssocId. The association ID (row ID) for a filter value for association control fields such as Contact Full Name, Account Name, Owner Alias, and so on, where the condition is Equal to.

• ListOfSelectedFields. The fields selected for display in search results, contained in child elements of the <SelectedFieldInfo> element:

  • SelectedField. The system name of the field.

  • SortOrder. The sort order of a field used for sorting of search results: ASC for ascending or DESC for descending.

  • SortPosition. The position of a field within the list of fields used for sorting.

See Oracle Migration Tool On Demand Guide for reference tables about the following

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

• Mappings of three-letter language codes to languages.

Arguments

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

Table Arguments Taken by the ListUpsert Method

Name	Description	Required	Default	I/O
apData:List	The list to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.