DeleteRecordChangeHistoryRequest 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 delete all audit change history records for a particular record.

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

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

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

Public NotInheritable Class DeleteRecordChangeHistoryRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
DeleteRecordChangeHistoryRequest

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.

/// <summary>
/// Deletes record change history for a specific record and shows
/// how many records were deleted.
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="target">The specified record.</param>
static void ShowDeleteRecordChangeHistory(
IOrganizationService service, 
EntityReference target) 
{
      var request = new DeleteRecordChangeHistoryRequest { 
         Target = target
      };

      var resp = (DeleteRecordChangeHistoryResponse)
      service.Execute(request);

      Console.WriteLine($"Audit records deleted:{resp.DeletedEntriesCount}");
}

Remarks

Learn to delete the change history for a record

For the Web API use the DeleteRecordChangeHistory action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of DeleteRecordChangeHistoryResponse.

Privileges and Access Rights

To perform this action, the caller must have the security role with the prvDeleteRecordChangeHistory privilege or the System Administrator security role, and access rights on the record specified in the Target property.

Constructors

DeleteRecordChangeHistoryRequest()

Initializes a new instance of the DeleteRecordChangeHistoryRequest 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)
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)
Target	Gets or sets the target record to delete the audit history for. Required.

Applies to

Делите путем