CopyDynamicListToStaticRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public ref class CopyDynamicListToStaticRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CopyDynamicListToStaticRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type CopyDynamicListToStaticRequest = class
    inherit OrganizationRequest

Public NotInheritable Class CopyDynamicListToStaticRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
CopyDynamicListToStaticRequest

Attributes: DataContractAttribute

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 instance. For the complete sample, see the link later in this topic.

/// <summary>
/// Demonstrates the CopyDynamicListToStatic message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="dynamicListId">The ID of the dynamic list.</param>
/// <returns>The ID of the static list.</returns>
static Guid CopyDynamicListToStaticExample(IOrganizationService service, Guid dynamicListId)
{
      // Copy the dynamic list to a static list.
      CopyDynamicListToStaticRequest request = new()
      {
         ListId = dynamicListId
      };
      var response =
         (CopyDynamicListToStaticResponse)service.Execute(request);
      return response.StaticListId;
}

Remarks

This message requires Dynamics 365 Sales.

For the Web API use the CopyDynamicListToStatic action.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the List table and access rights on the record specified in the ListId property.

Notes for Callers

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

Constructors

CopyDynamicListToStaticRequest()

Initializes a new instance of the CopyDynamicListToStaticRequest class.

Properties

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 the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)

Applies to

Share via