Uso de datos de columna de imagen en Microsoft Dataverse

El siguiente método GetImageColumnMaxSizeInKb devuelve el valor MaxSizeInKB para una columna 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.");
   }
}

Más información:

• RetrieveAttributeRequest Clase
• ImageAttributeMetadata.MaxSizeInKB

La siguiente solicitud devuelve el valor MaxSizeInKB para una columna ImageAttributeMetadata con el nombre lógico sample_imagecolumn en la tabla account.

Solicitud:

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

Respuesta:

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

Más información:

• Consulta de definiciones de tabla mediante la API > web Recuperar atributos
• ImageAttributeMetadata TipoDeEntidad

El método estático PrintFullSizedImageColumns escribe los nombres de las columnas de tabla e imagen que pueden almacenar imágenes de tamaño 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"]}");
    }
}

Salida

account.sample_sampleimage

Esta solicitud devuelve los nombres de las columnas de tabla e imagen que pueden almacenar imágenes de tamaño completo.

Solicitud:

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

Respuesta:

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

El método estático PrintPrimaryImageColumns del ejemplo siguiente escribe los nombres de columnas de tabla e imagen para todas las columnas de imagen principal.

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

Salida

account.sample_sampleimage

Más información: Crear consultas con QueryExpression

La siguiente solicitud devuelve los nombres de las columnas de tabla e imagen de todas las columnas de la imagen principal.

Solicitud:

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

Respuesta:

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

Para obtener más información, consulte Consultar datos mediante la API web

El siguiente método estático RetrieveAndUpdateImageColumn recupera un byte[] valor de imagen de una columna, lo guarda localmente y carga una nueva imagen.

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

Más información:

• Recuperar una fila de tabla usando SDK para .NET
• Actualizar y eliminar filas de tablas usando SDK para .NET

Mediante la API Web, se trabaja con valores de propiedad como cadenas codificadas en base 64 que representan los datos de byte[].

Esta solicitud devuelve una columna de imagen denominada sample_imagecolumn con un registro de cuenta:

Solicitud:

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

Respuesta:

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

Esta solicitud actualiza la columna de imagen sample_imagecolumn con una imagen actualizada:

Solicitud:

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

Respuesta:

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

Algunas bibliotecas que se usan para serializar y deserializar JSON, como JSON.NET, convierten automáticamente estos valores de cadena codificados en byte[]. Es posible que ni siquiera observe que el protocolo de transporte usa cadenas base 64.

Para obtener más información sobre las cadenas codificadas en base 64, consulte:

• Base64 - Glosario de documentos web de MDN
• Convertidor de Base64 a imagen
• Convertidor de imagen a Base64

Más información:

• Recuperar una fila de tabla usando la API web
• Actualizar y eliminar filas de tablas usando la API web

Establezca el valor del atributo image en NULL y actualice la entidad. Para obtener más información, consulte Actualización básica.

Puede eliminar un valor de columna de imagen mediante la API web de tres maneras diferentes.

Use PATCH y establezca el valor de la columna de la imagen en nulo

Solicitud:

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
}

Respuesta:

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

Para obtener más información, consulte Actualización básica.

Use PUT y establezca el valor de la columna de la imagen en nulo

Solicitud:

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}

Respuesta:

HTTP/1.1 204 NoContent
OData-Version: 4.0

Para obtener más información, consulte Actualización de un valor de propiedad único.

Usa DELETE con la URL del recurso que hace referencia a la columna de imagen.

Solicitud:

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

Respuesta:

HTTP/1.1 204 NoContent
OData-Version: 4.0

Más información: Eliminar un solo valor de propiedad