List Entity Capabilities
.gif "banner art") |
[Applies to: Microsoft Dynamics CRM 4.0]
Find the latest SDK documentation: CRM 2015 SDK
A list for a sales or marketing campaign contains instances of one specified entity type such as contacts, leads, or accounts. A list member is a contact, lead, or account that is added to a list.
The class for this entity is list. For lists, you can use the messages listed in the following table with the Execute method.
| Message | Description |
| AddMemberList | Use this message to add a member to a list. |
| Assign | Use this message to assign a list to another user.
The information that is needed to assign the entity instance is specified in the TargetOwnedList class. |
| CopyMembersList | Use this message to copy the members from the source list to the target list without creating duplicates. |
| Create | Use this message to create a list.
The information that is needed to create the entity instance is specified in the TargetCreateList class. You can also call the Create method. |
| CreateActivitiesList | Use this message to create the activities for a list. |
| Delete | Use this message to delete a list.
The entity instance to delete is specified in the TargetDeleteList class. You can also call the Delete method. |
| GrantAccess | Use this message to share a list with another security principal (user or team).
The information that is needed to grant access to the entity instance is specified in the TargetOwnedList class. |
| ModifyAccess | Use this message to change the access rights for a list previously shared with another security principal (user or team).
The information that is needed to modify access to the entity instance is specified in the TargetOwnedList class. |
| QualifyMemberList | Use this message to qualify the specified member list and either override the list members or remove them. |
| RemoveMemberList | Use this message to remove a member from a list. |
| Retrieve | Use this message to retrieve a list.
The entity instance to retrieve is specified in the TargetRetrieveList class. You can also call the Retrieve method. |
| RetrieveMultiple | Use this message to retrieve a collection of lists.
The query expression that describes the entity instances to retrieve is specified in the Query property of this request. You can also call the RetrieveMultiple method. |
| RetrievePrincipalAccess | Use this message to retrieve the access that the specified security principal (user or team) has to a list.
The entity instance to retrieve is specified in the TargetOwnedList class. |
| RetrieveSharedPrincipalsAndAccess | Use this message to retrieve all the security principals (users or teams) that have access to a list, together with their access rights to the list.
The entity instance to retrieve is specified in the TargetOwnedList class. |
| RevokeAccess | Use this message to remove all access to a list for the specified security principal (user or team).
The information that is needed to revoke access to the entity instance is specified in the TargetOwnedList class. |
| SetStateDynamicEntity | Use this message to set the state of a list using a DynamicEntity instance.
The possible states are defined in the ListState enumeration. |
| SetStateList | Use this message to set the state of a list.
The possible states are defined in the ListState enumeration. |
| Update | Use this message to update a list.
The entity instance to update is specified in the TargetUpdateList class. You can also use the Update method. |
See Also
Concepts
Other Resources