CopyDynamicListToStaticRequest Class

 

Updated: November 29, 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)

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

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

NameDescription
System_CAPS_pubmethodCopyDynamicListToStaticRequest()

Initializes a new instance of the CopyDynamicListToStaticRequest class.

NameDescription
System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyItem[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyListId

Gets or sets the ID of the dynamic list. Required.

System_CAPS_pubpropertyParameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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.");

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: