削除されたレコードをコードで復元する (プレビュー)

SDK を使用する場合は、 FetchXml または QueryExpression を使用してデータを取得できます。

FetchXml を使用してデータを取得する場合は、レコードを取得するときに fetch 要素datasource 属性を 'bin' に設定します。

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

QueryExpression を使用してデータを取得する場合は、レコードを取得するときに QueryExpression.DataSource プロパティを 'bin' に設定します。

static EntityCollection GetDeletedAccountRecordsQueryExpression(IOrganizationService service) {

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

   return service.RetrieveMultiple(query);
}

• FetchXML を使用してデータを取得する
• QueryExpression でクエリを作成する

Web API では、FetchXml または OData 構文を使用してレコードを取得できます。

FetchXml を使用してデータを取得する場合は、レコードを取得するときに fetch 要素datasource 属性を 'bin' に設定します。

この Get-DeletedAccountRecords PowerShell 関数は、削除されたアカウント レコードを最大 3 つ返します。

この Web API の例とこの記事の他の例は、$environmentUrl の説明に従って、$baseHeaders変数と変数に依存します。

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

}

• FetchXML を使用してデータを取得する
• Dataverse Web API で PowerShell と Visual Studio Code を使用する

SDK for .NET を使用してレコードを復元する方法は、 pac modelbuilder を使用して早期バインド型を生成しているか、遅延バインド スタイルを使用しているかによって異なります。

遅延バインディングおよび早期バインドプログラミングの方法について、.NET の SDK を使用して学びます

早期バインドの例

静的RestoreAccountRecordEarlyBound メソッドは、RestoreRequest<T> を使用して生成されたAccountクラスと クラスを使用します。

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

遅延バインドの例

静的 RestoreAccountRecordLateBound メソッドは 、OrganizationRequest クラスを使用して Restore メッセージを呼び出し、 Target パラメーターを設定します。

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

.NET 用 SDK でメッセージを使用する

[復元] アクションを使用して、削除されたレコードを復元します。 この操作は、復元されたレコードの ID に プロパティが設定されている idを返します。

列の値を上書きせずに任意の種類のレコードを復元する

この Restore-AnyRecord PowerShell 関数は、レコードへの完全な URL と @odata.id 注釈を使用して、任意の型レコードを参照することで、そのレコードを復元する方法を示します。 contacts(0ad63f65-990d-ef11-9f89-6045bdece8bb)などの相対 URL を、この関数のrelativeUri パラメーターに渡します。 ただし、この方法では、レコードの値を上書きすることはできません。

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
}

レコードを復元して列の値を上書きする

この Restore-AccountRecord PowerShell 関数は、アカウント レコードを復元して値を上書きする方法を示しています。 次の 3 つの要件があります。

• エンティティ型の完全修飾名を持つを使用して@odata.typeします。 この注釈は、OData にレコードの種類を通知します。
• レコードを指定するには、主キーの値を含めます。この場合 accountid 。
• 上書きするプロパティ (この場合は 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
}

この静的 SetCleanupIntervalInDays メソッドを使用して、特定のテーブルの CleanupIntervalInDays 列の値を設定できます。

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

SDK for .NET を使用する

このSet-CleanupIntervalInDays PowerShell 関数は、recyclebinconfig パラメーターと一致する entityId を持つ$tableEntityId行を取得します。 次に、レコードの cleanupintervalindays 列プロパティを $cleanupIntervalInDays パラメーターの値に更新します。

この関数は、「Get-Records関数の作成」で説明されているUpdate-Record関数と関数に依存します。

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

• Microsoft Dataverse Web API を使用する
• PowerShell と Visual Studio Code を使用したクイック スタート Web API
• Dataverse Web API で PowerShell と Visual Studio Code を使用する

この静的 DisableRecycleBinForTable メソッドを使用して、特定のテーブルのごみ箱を無効にします。

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

SDK for .NET を使用する

この Disable-RecycleBinForTable PowerShell 関数を使用して、特定のテーブルのごみ箱を無効にします。 この関数は、「Get-Records関数の作成」で説明されているUpdate-Record関数と関数に依存します

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

• Microsoft Dataverse Web API を使用する
• Dataverse Web API で PowerShell と Visual Studio Code を使用する
• テーブル行を更新する