CopyDynamicListToStaticRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to create a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.

For the Web API use the CopyDynamicListToStatic Action.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.CopyDynamicListToStaticRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CopyDynamicListToStaticRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class CopyDynamicListToStaticRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	CopyDynamicListToStaticRequest()	Initializes a new instance of the CopyDynamicListToStaticRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	ListId	Gets or sets the ID of the dynamic list. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which will return an instance of CopyDynamicListToStaticResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the List entity and access rights on the record specified in the ListId property. For a complete list of the required privileges, see CopyDynamicListToStatic message privileges.

Notes for Callers

The newly created static list is locked. To unlock the list, set the value of the List.Lockstatus attribute to false.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.



// Copy the dynamic list to a static list.
CopyDynamicListToStaticRequest copyRequest = 
    new CopyDynamicListToStaticRequest()
    {
        ListId = _dynamicListId
    };
CopyDynamicListToStaticResponse copyResponse =
    (CopyDynamicListToStaticResponse)_serviceProxy.Execute(copyRequest);
_staticListId = copyResponse.StaticListId;

Console.WriteLine("Copied dynamic list to a static list.");



' Copy the dynamic list to a static list.
Dim copyRequest As New CopyDynamicListToStaticRequest() With
    {
        .ListId = _dynamicListId
    }
Dim copyResponse As CopyDynamicListToStaticResponse =
    CType(_serviceProxy.Execute(copyRequest), 
        CopyDynamicListToStaticResponse)
_staticListId = copyResponse.StaticListId

Console.WriteLine("Copied dynamic list to a static list.")

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.