Restaurer des enregistrements supprimés avec du code (aperçu)

Lorsque vous utilisez le Kit de développement logiciel (SDK), vous pouvez récupérer des données à l’aide de FetchXml ou queryExpression.

Lorsque vous récupérez des données à l’aide de FetchXml, définissez l’attribut du fetch element à 'bin' lorsque vous récupérez des enregistrements.

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);
}

Lorsque vous récupérez des données à l’aide de QueryExpression, définissez la propriété QueryExpression.DataSource sur «bin » lorsque vous récupérez des enregistrements.

static EntityCollection GetDeletedAccountRecordsQueryExpression(IOrganizationService service) {

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

   return service.RetrieveMultiple(query);
}

• Récupérer des données à l’aide de FetchXML
• Générer des requêtes avec QueryExpression

Avec l’API web, vous pouvez récupérer des enregistrements à l’aide de la syntaxe FetchXml ou OData.

Lorsque vous récupérez des données à l’aide de FetchXml, définissez l’attribut de l'élément fetchdatasource sur «bin » lorsque vous récupérez des enregistrements.

Cette Get-DeletedAccountRecords fonction PowerShell retourne jusqu’à trois enregistrements de compte supprimés.

Cet exemple d’API web et d'autres exemples de cet article dépendent des variables $environmentUrl et $baseHeaders, comme décrit dans l'API web de démarrage rapide avec PowerShell et 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

}

• Récupérer des données à l’aide de FetchXML
• Utiliser PowerShell et Visual Studio Code avec l’API Web Dataverse

La façon dont vous restaurez un enregistrement à l’aide du Kit de développement logiciel (SDK) pour .NET varie selon que vous générez des types liés précoces à l’aide de pac modelbuilder ou si vous utilisez le style de liaison tardive.

En savoir plus sur la programmation à liaison tardive et liaison anticipée à l’aide du SDK pour .NET

Exemple de liaison anticipée

La méthode RestoreAccountRecordEarlyBound statique utilise les classes RestoreRequest<T> et Account générées avec 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;
}

Exemple de liaison tardive

La méthode statique RestoreAccountRecordLateBound utilise la classe OrganizationRequest pour appeler le Restore message, en définissant le Target paramètre.

/// <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"];
}

Utiliser les messages avec le SDK pour .NET

Utilisez l’action Restaurer pour restaurer les enregistrements supprimés. Cette opération retourne un type complexe RestoreResponse qui a une propriété id définie avec l'ID de l'enregistrement restauré.

Restaurer n’importe quel type d’enregistrement sans remplacer les valeurs de colonne

Cette Restore-AnyRecord fonction PowerShell montre comment tout enregistrement de type peut être restauré en le référençant à l’aide de l’URL complète de l’enregistrement et de l’annotation @odata.id . Transmettez une URL relative comme contacts(0ad63f65-990d-ef11-9f89-6045bdece8bb) au relativeUri paramètre de cette fonction. Cependant, avec cette approche, vous ne pouvez remplacer aucune valeur de l’enregistrement.

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
}

Restaurer un enregistrement et remplacer des valeurs de colonne

Cette Restore-AccountRecord fonction PowerShell montre comment restaurer un enregistrement de compte et remplacer une valeur. Il existe trois exigences :

• Spécifiez le paramètre de type de table à l’aide @odata.type du nom complet du type d’entité. Cette annotation indique à OData quel type d’enregistrement il s’agit.
• Pour spécifier l’enregistrement, incluez la valeur de clé primaire, dans ce cas accountid .
• Spécifiez les propriétés que vous souhaitez remplacer, dans ce cas la name propriété.

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
}

Vous pouvez utiliser cette méthode statique SetCleanupIntervalInDays pour définir la CleanupIntervalInDays valeur de colonne d’une table spécifique.

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

Utiliser le Kit de développement logiciel (SDK) pour .NET

Cette Set-CleanupIntervalInDays fonction PowerShell récupère la recyclebinconfig ligne qui a l’entityId qui correspond au $tableEntityId paramètre. Ensuite, il met à jour la cleanupintervalindays propriété de colonne de l’enregistrement à la valeur du $cleanupIntervalInDays paramètre.

Cette fonction dépend des fonctions Get-Records et Update-Record décrites dans Créer des opérations de fonction de table.

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."
      }
}

• Utiliser l'API Web Microsoft Dataverse
• Démarrage rapide : API Web avec PowerShell et Visual Studio Code
• Utiliser PowerShell et Visual Studio Code avec l’API Web Dataverse

Utilisez cette méthode DisableRecycleBinForTable statique pour désactiver la corbeille pour une table spécifique.

/// <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);
    }
}

Utiliser le Kit de développement logiciel (SDK) pour .NET

Utilisez cette fonction Disable-RecycleBinForTable de PowerShell pour désactiver la corbeille pour une table spécifique. Cette fonction dépend des Get-RecordsUpdate-Record fonctions décrites dans Créer des fonctions d’opérations de table

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."
   }
}

• Utiliser l'API Web Microsoft Dataverse
• Utiliser PowerShell et Visual Studio Code avec l’API Web Dataverse
• Mettre à jour une ligne de table