Compartilhar via


Exemplo: Operações de arquivo usando a API Web do Dataverse

Este exemplo .NET 6.0 demonstra como executar operações com colunas de arquivo usando a API Web do Dataverse.

Este exemplo usa o código auxiliar comum na biblioteca de classes WebAPIService (C#).

Pré-requisitos

  • Microsoft Visual Studio 2022
  • Acesso ao Dataverse com privilégios de administrador do sistema ou personalizador de sistema.

Como executar o exemplo

  1. Clone ou baixe o repositório PowerApps-Samples .

  2. Abra o arquivo PowerApps-Samples\dataverse\webapi\C#-NETx\FileOperations\FileOperations.sln usando Visual Studio 2022.

  3. Edite o appsettings.json arquivo para definir os seguintes valores de propriedade:

    Propriedade Instruções
    Url A URL do seu ambiente. Substitua o valor do espaço reservado https://yourorg.api.crm.dynamics.com pelo valor correspondente ao seu ambiente. Veja Exibir recursos do desenvolvedor para encontrar isso.
    UserPrincipalName Substitua o marcador you@yourorg.onmicrosoft.com pelo valor UPN que você utiliza para acessar o ambiente.
    Password Substitua o valor do placeholder yourPassword pela senha que você utiliza.
  4. Salvar o appsettings.json arquivo

  5. Selecione quais dos projetos que você deseja executar no gerenciador de soluções. Clique com o botão direito do mouse no projeto e escolha Definir como Projeto de Inicialização.

  6. Pressione F5 para executar o exemplo.

Saída de exemplo

A saída do exemplo deve ser semelhante a esta:

Creating file column named 'sample_FileColumn' on the account table ...
Created file column named 'sample_FileColumn' in the account table.
Created account record with accountid:5fb4f993-7c55-ed11-bba3-000d3a9933c9
Uploading file Files\25mb.pdf ...
Uploaded file Files\25mb.pdf
Downloading file from accounts(5fb4f993-7c55-ed11-bba3-000d3a9933c9)/sample_filecolumn ...
Downloaded the file to E:\GitHub\PowerApps-Samples\dataverse\webapi\C#-NETx\FileOperations\FileOperationsWithActions\bin\Debug\net6.0//downloaded-25mb.pdf.
Deleted the file using FileId.
Deleted the account record.
Deleting the file column named 'sample_filecolumn' on the account table ...
Deleted the file column named 'sample_filecolumn' in the account table.

Demonstrações

Este exemplo é uma solução com três projetos. Cada projeto executa as mesmas operações de uma maneira diferente. Consulte os respectivos arquivos README para obter detalhes sobre cada projeto.

O código de cada projeto está no respectivo Program.cs arquivo.

Cada projeto usa uma classe compartilhada Utility para executar operações comuns. Essa classe está no arquivo Utility.cs .

Em um alto nível, cada projeto executa estas operações:

Criar uma coluna de arquivo

A função Utility.CreateFileColumn cria uma coluna de arquivo chamada sample_FileColumn na tabela da conta com um valor MaxSizeInKb de 10 MB.

Atualizar uma coluna de arquivo

A função Utility.UpdateFileColumnMaxSizeInKB atualiza o valor MaxSizeInKb da coluna do arquivo sample_FileColumn para 100 MB.

Dica: se você quiser criar alguns cenários de erro porque o tamanho da coluna do arquivo é muito pequeno, comente essa linha.

Recuperar o valor maxSizeInKb da coluna de arquivo

Recupera o valor de Utility.GetFileColumnMaxSizeInKb da coluna do arquivo MaxSizeInKb e armazena em uma variável chamada sample_FileColumn.

Criar um registro de conta

Antes que um arquivo possa ser carregado na coluna de arquivo, um registro deve existir.

Fazer upload de um arquivo

A função para carregar o arquivo aceita um parâmetro nomeado fileColumnMaxSizeInKb e usa esse valor para testar o tamanho do arquivo. Se o arquivo for maior que o limite configurado da coluna de arquivo, ele gerará um erro.

Baixar o arquivo

Se o upload do arquivo tiver sido bem-sucedido, a função para baixar o arquivo o salvará no diretório atual. Você pode tentar abrir o arquivo para confirmar se ele foi carregado e baixado corretamente.

Excluir o arquivo

Se o upload do arquivo tiver sido bem-sucedido, o arquivo será excluído.

Limpeza

Para deixar o sistema no estado antes da execução do exemplo, ele faz o seguinte:

  • Excluir o registro da conta
  • Excluir a coluna de arquivo

Consulte Também

Usar dados da coluna do arquivo
Sample: Operações de arquivo usando o SDK do Dataverse para .NET
Usar dados de coluna de imagem
Exemplo: Operações de imagem usando a API Web do Dataverse