Usar dados de coluna de imagem

O método estático GetImageColumnMaxSizeInKb a seguir retorna o valor MaxSizeInKB para a coluna ImageAttributeMetadata.

/// <summary>
/// Retrieves the MaxSizeInKb property of an image column.
/// </summary>
/// <param name="service">IOrganizationService</param>
/// <param name="entityLogicalName">The logical name of the table that has the column</param>
/// <param name="imageColumnLogicalName">The logical name of the image column.</param>
/// <returns></returns>
/// <exception cref="Exception"></exception>
public static int GetImageColumnMaxSizeInKb(
   IOrganizationService service, 
   string entityLogicalName, 
   string imageColumnLogicalName) 
{

   RetrieveAttributeRequest retrieveAttributeRequest = new() { 
         EntityLogicalName = entityLogicalName,
         LogicalName = imageColumnLogicalName
   };

   RetrieveAttributeResponse retrieveAttributeResponse;
   try
   {
         retrieveAttributeResponse = (RetrieveAttributeResponse)service.Execute(retrieveAttributeRequest);
   }
   catch (Exception)
   {
         throw;
   }

   if (retrieveAttributeResponse.AttributeMetadata is ImageAttributeMetadata imageColumn)
   {
         return imageColumn.MaxSizeInKB.Value;
   }
   else
   {
         throw new Exception($"{entityLogicalName}.{imageColumnLogicalName} is not a image column.");
   }
}

Mais informações:

• RetrieveAttributeRequest Classe
• ImageAttributeMetadata.MaxSizeInKB

A solicitação a seguir retorna o valor MaxSizeInKB de uma coluna ImageAttributeMetadata com o nome lógico sample_imagecolumn na tabela account.

Solicitação:

GET [Organization Uri]/api/data/v9.2/EntityDefinitions(LogicalName='account')/Attributes(LogicalName='sample_imagecolumn')/Microsoft.Dynamics.CRM.ImageAttributeMetadata?$select=MaxSizeInKB HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

Resposta:

HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=minimal
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#EntityDefinitions('account')/Attributes/Microsoft.Dynamics.CRM.ImageAttributeMetadata(MaxSizeInKB)/$entity",
  "MaxSizeInKB": 102400,
  "MetadataId": "f315e7f1-6355-ed11-bba3-000d3a9933c9"
}

Mais informações:

• Consultar definições de tabela através da API Web > Recuperar atributos
• ImageAttributeMetadata EntityType

O método estático PrintFullSizedImageColumns gravará os nomes das colunas de tabela e imagem que podem armazenar imagens de tamanho completo.

static void PrintFullSizedImageColumns(IOrganizationService service)
{
    QueryExpression query = new QueryExpression("attributeimageconfig")
    {
        ColumnSet = new ColumnSet("parententitylogicalname", "attributelogicalname"),
        Criteria = new FilterExpression(LogicalOperator.And)
        {
            Conditions =
            {
                new ConditionExpression(
                    attributeName: "canstorefullimage",
                    conditionOperator: ConditionOperator.Equal,
                    value: true)
            }
        }
    };

    EntityCollection response = service.RetrieveMultiple(query);
    foreach (Entity record in response.Entities)
    {
        Console.WriteLine($"{record["parententitylogicalname"]}.{record["attributelogicalname"]}");
    }
}

Output

account.sample_sampleimage

Essa solicitação retornará os nomes das colunas de tabela e imagem que podem armazenar imagens de tamanho completo.

Solicitação:

GET [Organization URI]/api/data/v9.2/attributeimageconfigs?$select=parententitylogicalname,attributelogicalname&$filter=canstorefullimage eq true HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

Resposta:

HTTP/1.1 200 OK
Cache-Control: no-cache
Allow: OPTIONS,GET,HEAD,POST
Content-Type: application/json; odata.metadata=minimal; odata.streaming=true
OData-Version: 4.0

{
  "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#attributeimageconfigs(parententitylogicalname,attributelogicalname)",
  "value": [
    {
      "@odata.etag": "W/\"76501240\"",
      "parententitylogicalname": "account",
      "attributelogicalname": "sample_sampleimage",
      "attributeimageconfigid": "b8c1750f-c24f-ea11-a813-000d3a5391c8"
    }
  ]
}

O método estático PrintPrimaryImageColumns abaixo escreverá os nomes das colunas de tabela e imagem de todas as colunas primárias de imagem.

static void PrintPrimaryImageColumns(IOrganizationService service)
{
    QueryExpression query = new QueryExpression("entityimageconfig")
    {
        ColumnSet = new ColumnSet("parententitylogicalname", "primaryimageattribute"),
    };

    EntityCollection response = service.RetrieveMultiple(query);
    foreach (Entity record in response.Entities)
    {
        Console.WriteLine($"{record["parententitylogicalname"]}.{record["primaryimageattribute"]}");
    }
}

Output

account.sample_sampleimage

Mais informações: Criar consultas com QueryExpression

A solicitação abaixo retornará os nomes das colunas, tanto de tabela quanto de imagem, de todas as colunas de imagem primária.

Solicitação:

GET [Organization URI]/api/data/v9.2/entityimageconfigs?$select=parententitylogicalname,primaryimageattribute HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

Resposta:

HTTP/1.1 200 OK
Cache-Control: no-cache
Allow: OPTIONS,GET,HEAD,POST
Content-Type: application/json; odata.metadata=minimal; odata.streaming=true
OData-Version: 4.0

{
  "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#entityimageconfigs(parententitylogicalname,primaryimageattribute)",
  "value": [
    {
      "@odata.etag": "W/\"76501240\"",
      "parententitylogicalname": "account",
      "primaryimageattribute": "sample_sampleimage",
      "entityimageconfigid": "b8c1750f-c24f-ea11-a813-000d3a5391c8"
    }
  ]
}

Mais informações: consultar dados usando a API Web

O seguinte método estático RetrieveAndUpdateImageColumn recupera o valor de imagem byte[] da coluna, salva-o localmente e carrega uma nova imagem.

static void RetrieveAndUpdateImageColumn(
    IOrganizationService service,
    Guid accountid,
    string imageColumnLogicalName) 
{

    // Retrieve account with image
    Entity account = service.Retrieve(
        entityName: "account",
        id: accountid, 
        columnSet: new ColumnSet(imageColumnLogicalName));

    // Save the image retrieved
    File.WriteAllBytes(
        path: "original_image.png",
        bytes: account.GetAttributeValue<byte[]>(imageColumnLogicalName));


    // Instantiate a new entity for update with new image
    Entity accountForUpdate = new("account") { 
        Attributes = {
            { "accountid", accountid },
            { imageColumnLogicalName , File.ReadAllBytes("new_image.png")}
        }
    };

    // Update the account
    service.Update(accountForUpdate);               
}

Mais informações:

• Recuperar uma linha de tabela usando o SDK para .NET
• Atualizar e excluir linhas de tabela usando o SDK para .NET

Com a API Web, os valores da propriedade são valores de cadeia de caracteres codificados em base 64 que representam os byte[] dados.

Essa solicitação retorna uma coluna de imagem nomeada sample_imagecolumn com um registro de conta:

Solicitação:

GET [Organization Uri]/api/data/v9.2/accounts(<accountid>)?$select=sample_imagecolumn HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

Resposta:

HTTP/1.1 200 OK
ETag: W/"76796548"
OData-Version: 4.0

{
  "@odata.context": "[Organization Uri]/api/data/v9.2/$metadata#accounts(sample_imagecolumn)/$entity",
  "@odata.etag": "W/\"76796548\"",
  "sample_imagecolumn": "<base 64 encoded string truncated for brevity>",
  "accountid": "<accountid>"
}

Essa solicitação atualiza a coluna de sample_imagecolumn imagem com uma imagem atualizada:

Solicitação:

PATCH [Organization Uri]/api/data/v9.2/accounts(<accountid>) HTTP/1.1
If-Match: *
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json
Content-Type: application/json; charset=utf-8
Content-Length: 5220

{
  "sample_imagecolumn": "<base 64 encoded string truncated for brevity>"
}

Resposta:

HTTP/1.1 204 NoContent
OData-Version: 4.0
OData-EntityId: [Organization Uri]/api/data/v9.2/accounts(<accountid>)

Algumas bibliotecas que você pode usar para serializar e desserializar JSON, como JSON.NET, converterão automaticamente esses valores de cadeia de caracteres codificados para byte[] que você nem perceba que o protocolo de transporte está usando cadeias de caracteres base 64.

Para obter mais informações, consulte sobre cadeias de caracteres codificadas em base 64:

• Base64 – Glossário do MDN Web Docs
• Conversor de Base64 para Imagem
• Conversor de imagem para Base64

Mais informações:

• Recuperar uma linha de tabela usando a API Web
• Atualizar e excluir linhas de tabela usando a API Web

Basta definir o valor do atributo de imagem como nulo e atualizar a entidade. Mais informações: Atualização básica

Há três maneiras diferentes de excluir um valor de coluna de imagem usando a API Web.

Usar PATCH e definir o valor da coluna de imagem como nulo

Solicitação:

PATCH [Organization Uri]/api/data/v9.2/accounts(<accountid>) HTTP/1.1
If-Match: *
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json
Content-Type: application/json; charset=utf-8
Content-Length: 90

{
  "accountid": "<accountid>",
  "sample_imagecolumn": null
}

Resposta:

HTTP/1.1 204 NoContent
OData-Version: 4.0
OData-EntityId: [Organization Uri]/api/data/v9.2/accounts(<accountid>)

Mais informações: Atualização básica

Usar PUT e definir o valor da coluna de imagem como nulo

Solicitação:

PUT [Organization Uri]/api/data/v9.2/accounts(<accountid>)/sample_imagecolumn HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json
Content-Type: application/json; charset=utf-8
Content-Length: 15

{"value": null}

Resposta:

HTTP/1.1 204 NoContent
OData-Version: 4.0

Mais informações: atualizar um único valor de propriedade

Usar DELETE com a URL do recurso que faz referência à coluna de imagem

Solicitação:

DELETE [Organization Uri]/api/data/v9.2/accounts(<accountid>)/sample_imagecolumn HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

Resposta:

HTTP/1.1 204 NoContent
OData-Version: 4.0

Mais informações: Excluir um único valor de propriedade