Restauración de registros eliminados con código (versión preliminar)

Al usar el SDK, puede recuperar datos mediante FetchXml o QueryExpression.

Al recuperar datos mediante FetchXml, establezca el atributo del elemento fetchdatasource en "bin" al recuperar registros.

static EntityCollection GetDeletedAccountRecordsFetchXml(IOrganizationService service) {

   string queryString = @"<fetch top='3' datasource='bin'>
                     <entity name='account'>
                        <attribute name='name' />
                     </entity>
                     </fetch>";
   
   FetchExpression query = new(queryString);

   return service.RetrieveMultiple(query);
}

Al recuperar datos mediante QueryExpression, establezca la propiedad QueryExpression.DataSource en "bin" al recuperar registros.

static EntityCollection GetDeletedAccountRecordsQueryExpression(IOrganizationService service) {

   QueryExpression query = new("account") { 
         ColumnSet = new ColumnSet("name"),
         DataSource = "bin",
         TopCount = 3
   };

   return service.RetrieveMultiple(query);
}

• Usar FetchXml para recuperar datos
• Crear consultas con QueryExpression

Con la API web, puede recuperar registros mediante la sintaxis de FetchXml o OData.

Al recuperar datos mediante FetchXml, establezca el atributo del elemento fetchdatasource en "bin" al recuperar registros.

Esta Get-DeletedAccountRecords función de PowerShell devuelve hasta tres registros de cuenta eliminados.

Este ejemplo de API web y otros de este artículo dependen de las $environmentUrl variables y $baseHeaders , como se describe en Quick Start Web API con PowerShell y Visual Studio Code.

function Get-DeletedAccountRecords{

   $query = @()
   $query += "<fetch top='3' datasource='bin'>"
   $query += "<entity name='account'>"
   $query += "<attribute name='name' />"
   $query += "</entity>"
   $query += "</fetch>"

   $uri = $environmentUrl
   $uri += 'accounts'
   $uri += '?fetchXml=' + [uri]::EscapeUriString($query -join '')

   $RetrieveMultipleRequest = @{
      Uri     = $uri
      Method  = 'Get'
      Headers = $baseHeaders
   }
   Invoke-RestMethod @RetrieveMultipleRequest

}

• Usar FetchXml para recuperar datos
• Usar PowerShell y Visual Studio Code con la API web de Dataverse

La forma de restaurar un registro mediante el SDK para .NET depende de si generas tipos de enlace temprano utilizando el pac modelbuilder, o si usas el estilo de enlace tardío.

Obtenga información sobre la programación con enlace tardío y enlace temprano mediante el SDK para .NET.

Ejemplo de enlace adelantado

El método estático RestoreAccountRecordEarlyBound usa las clases RestoreRequest<T> y Account, generadas mediante el pac modelbuilder.

/// <summary>
/// Restores an account record
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="accountId">The ID of the deleted account record.</param>
/// <param name="originalName">The original name value for the account record.</param>
/// <returns>The ID of the restored account</returns>
static Guid RestoreAccountRecordEarlyBound(
    IOrganizationService service, 
    Guid accountId,
    string originalName)
{
    Account accountToRestore = new()
    {
        Id = accountId,
        // Appending '(Restored)' to the original name
        // to demonstrate overwriting a value.
        Name = originalName + " (Restored)"
    };

    RestoreRequest<Account> request = new()
    {
        Target = accountToRestore
    };

    var response = (RestoreResponse)service.Execute(request);
    return response.id;
}

Ejemplo de enlace tardío

El método estático RestoreAccountRecordLateBound usa la clase OrganizationRequest para invocar el Restore mensaje, estableciendo el Target parámetro .

/// <summary>
/// Restores an account record
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="accountId">The ID of the deleted account record.</param>
/// <param name="originalName">The original name value for the account record.</param>
/// <returns>The ID of the restored account</returns>
static Guid RestoreAccountRecordLateBound(
   IOrganizationService service,
   Guid accountId,
   string originalName)
{
   Entity accountToRestore = new("account", accountId)
   {
         Attributes = {
            // Appending '(Restored)' to the original name
            // to demonstrate overwriting a value.
            {"name", originalName + " (Restored)"}
         }
   };

   OrganizationRequest request = new("Restore")
   {
         Parameters = {
            { "Target", accountToRestore }
         }
   };

   OrganizationResponse response = service.Execute(request);

   return (Guid)response.Results["id"];
}

Usar mensajes con el SDK para .NET

Use la acción Restaurar para restaurar los registros eliminados. Esta operación devuelve un tipo complejo RestoreResponse que tiene una id propiedad establecida en el identificador del registro restaurado.

Restaurar cualquier tipo de registro sin sobrescribir valores de columna

Esta Restore-AnyRecord función de PowerShell muestra cómo se puede restaurar cualquier registro de tipo haciendo referencia a él mediante la dirección URL completa al registro y la @odata.id anotación. Pase una dirección URL relativa como contacts(0ad63f65-990d-ef11-9f89-6045bdece8bb) al relativeUri parámetro de esta función. Sin embargo, con este enfoque no puede sobrescribir ningún valor del registro.

function Restore-AnyRecord{
   param(
      [Parameter(Mandatory)]
      [uri]$relativeUri
   )

   $uri = $environmentUrl + 'api/data/v9.2/'
   $uri += 'Restore'
   
   $body = @{
      'Target' = @{
         '@odata.id' = $environmentUrl + 'api/data/v9.2/' + $relativeUri
      }
   }

   $postHeaders = $baseHeaders.Clone()
   $postHeaders.Add('Content-Type', 'application/json')

   $RestoreRequest = @{
      Uri     = $uri
      Method  = 'Post'
      Headers = $postHeaders
      Body    = (ConvertTo-Json $body) 
   }
  
  $id = Invoke-RestMethod @RestoreRequest | Select-Object -ExpandProperty id

  return $id
}

Restaurar un registro y sobrescribir valores de columna

Esta Restore-AccountRecord función de PowerShell muestra cómo restaurar un registro de cuenta y sobrescribir un valor. Hay tres requisitos:

• Especifique el parámetro de tipo de tabla mediante @odata.type con el nombre completo del tipo de entidad. Esta anotación indica a OData qué tipo de registro es.
• Para especificar el registro, incluya el valor de clave principal, en este caso accountid .
• Especifique cualquier propiedad que quiera sobrescribir, en este caso la propiedad name.

function Restore-AccountRecord {
   param(
      [Parameter(Mandatory)]
      [guid]$recordId,
      [Parameter(Mandatory)]
      [string]$originalName
   )
   
   $uri = $environmentUrl
   $uri += 'Restore'
   
   $body = @{
      'Target' = @{
         '@odata.type' = 'Microsoft.Dynamics.CRM.account'
         # Appending '(Restored)' to the original name
         # to demonstrate overwriting a value.
         'name'       = ($originalName + ' (Restored)')
         'accountid'  = $recordId.Guid
      }
   }

   $postHeaders = $baseHeaders.Clone()
   $postHeaders.Add('Content-Type', 'application/json')

   $RestoreRequest = @{
      Uri     = $uri
      Method  = 'Post'
      Headers = $postHeaders
      Body    = (ConvertTo-Json $body) 
   }
  
  $id = Invoke-RestMethod @RestoreRequest | Select-Object -ExpandProperty id

  return $id
}

Puede usar este método estático SetCleanupIntervalInDays para establecer el valor de CleanupIntervalInDays columna de una tabla específica.

/// <summary>
/// Updates the CleanupIntervalInDays value for a specified table
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="entityId">The entityId of the table</param>
/// <param name="cleanupIntervalInDays">The new CleanupIntervalInDays value</param>
static void SetCleanupIntervalInDays(
    IOrganizationService service,
    Guid entityId,
    int cleanupIntervalInDays)
{

    QueryExpression query = new("recyclebinconfig")
    {
        ColumnSet = new ColumnSet("recyclebinconfigid"),
        Criteria = new FilterExpression(LogicalOperator.And)
        {
            Conditions = {
              {
                  new ConditionExpression(
                      attributeName: "extensionofrecordid",
                      conditionOperator: ConditionOperator.Equal,
                      value: entityId)
              }
          }
        }
    };

    EntityCollection records = service.RetrieveMultiple(query);

    if (records.Entities.Count.Equals(1))
    {
        Guid id = records.Entities[0].Id;

        Entity record = new(entityName: "recyclebinconfig", id: id)
        {
            Attributes = {
                { "cleanupintervalindays", cleanupIntervalInDays }
            }
        };

        service.Update(record);

    }
    else
    {
        throw new Exception($"Recycle bin configuration for table '{tableLogicalName}' not found.");
    }
}

Usar el SDK para .NET

Esta Set-CleanupIntervalInDays función de PowerShell recupera la recyclebinconfig fila que tiene el entityId que coincide con el $tableEntityId parámetro . A continuación, actualiza la cleanupintervalindays propiedad de columna del registro al valor del $cleanupIntervalInDays parámetro .

Esta función depende de las Get-Records funciones y Update-Record descritas en Creación de funciones de operaciones de tabla.

function Set-CleanupIntervalInDays{
      param(
         [Parameter(Mandatory)]
         [guid]$tableEntityId,
         [Parameter(Mandatory)]
         [int]$cleanupIntervalInDays
      )
      $records = (Get-Records `
         -setName 'recyclebinconfigs' `
         -query "?`$filter=_extensionofrecordid_value eq $($tableEntityId)").value
   
      if ($records.Count -eq 1) {
         $recyclebinconfigId = $records[0].recyclebinconfigid
   
         Update-Record `
               -setName 'recyclebinconfigs' `
               -id $recyclebinconfigId `
               -body @{
               'cleanupintervalindays' = $cleanupIntervalInDays
         }
      }
      else {
         Write-Host "Recycle bin configuration for table $tableEntityId not found."
      }
}

• Utilizar la API web de Microsoft Dataverse
• Inicio rápido de la API web con PowerShell y Visual Studio Code
• Usar PowerShell y Visual Studio Code con la API web de Dataverse

Usa este método estático DisableRecycleBinForTable para desactivar la papelera de reciclaje para una tabla específica.

/// <summary>
/// Disable the Recycle bin for a specified table
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="tableEntityId">The entityId of the table</param>
static void DisableRecycleBinForTable(
    IOrganizationService service,
    Guid tableEntityId)
{

    QueryExpression query = new("recyclebinconfig")
    {
        ColumnSet = new ColumnSet("recyclebinconfigid")
    };

    LinkEntity entityLink = query.AddLink(
      "entity", 
      "extensionofrecordid", 
      "entityid");

    entityLink.LinkCriteria.AddCondition(
      "extensionofrecordid", 
      ConditionOperator.Equal, 
      tableEntityId);

    EntityCollection recyclebinconfigs = service.RetrieveMultiple(query);

    if (recyclebinconfigs.Entities.Count.Equals(1))
    {

        var id = recyclebinconfigs.Entities[0].GetAttributeValue<Guid>("recyclebinconfigid");

        Entity recyclebinconfig = new("recyclebinconfig", id)
        {
            Attributes = {
                { "statecode", new OptionSetValue(1) },
                { "statuscode", new OptionSetValue(2) }
            }
        };

        service.Update(recyclebinconfig);
    }
    else
    {
        string message = $"Recycle bin configuration for table '{extensionofrecordid}' not found.";
        throw new Exception(message);
    }
}

Usar el SDK para .NET

Usa esta función Disable-RecycleBinForTable de PowerShell para desactivar la papelera de reciclaje para una tabla específica. Esta función depende de las Get-Records funciones y Update-Record descritas en Creación de funciones de operaciones de tabla

function Disable-RecycleBinForTable {
   param(
      [Parameter(Mandatory)]
      [guid]$tableId
   )

   $query = "?`$filter=_extensionofrecordid_value eq "
   $query += $tableId
   $query += "&`$select=recyclebinconfigid"

   $recyclebinconfigs = (Get-Records `
         -setName 'recyclebinconfigs' `
         -query $query).value

   if ($recyclebinconfigs.Count -eq 1) {
      $recyclebinconfigId = $recyclebinconfigs[0].recyclebinconfigid

      Update-Record `
         -setName 'recyclebinconfigs' `
         -id $recyclebinconfigId `
         -body @{
         'statecode'  = 1
         'statuscode' = 2
      } | Out-Null
   }
   else {
      Write-Host "Recycle bin configuration for table $tableId not found."
   }
}

• Utilizar la API web de Microsoft Dataverse
• Usar PowerShell y Visual Studio Code con la API web de Dataverse
• Actualización de una fila de tabla