Tipo de recurso openTypeExtension (extensiones abiertas)

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Precaución

Las aplicaciones existentes que usan esta característica con baseTask o baseTaskList deben actualizarse, ya que el conjunto de API de tareas pendientes basado en estos recursos está en desuso a partir del 31 de mayo de 2022. Ese conjunto de API dejará de devolver datos el 31 de agosto de 2022. Use el conjunto de API basado en todoTask.

Representa extensiones abiertas (también conocidas como extensiones de tipo abierto y anteriormente conocidas como extensiones de datos Office 365), una opción de extensibilidad que proporciona una manera sencilla de agregar directamente propiedades sin tipo a un recurso de Microsoft Graph.

Cualquier extensión abierta agregada a un recurso se muestra en la propiedad de navegación extensiones. Cada extensión tiene una propiedad extensionName , que es la única propiedad predefinida que se puede escribir para todas las extensiones, junto con los datos personalizados. Una forma de asegurarse de que los nombres de extensión son únicos es usar un método inverso del formato de nombres de dominio (DNS) que dependa de su propio dominio, por ejemplo, com.contoso.ContactInfo. No use el dominio de Microsoft (com.microsoft o com.onmicrosoft) en un nombre de extensión.

Deriva del tipo abstracto de extensión.

El siguiente recurso admite extensiones abiertas:

Nota: * Debido a una limitación de servicio existente, los delegados no pueden crear eventos abiertos anexados a extensiones en calendarios de buzones compartidos. Los intentos de hacerlo producirán una ErrorAccessDenied respuesta.

Para obtener más información sobre la extensibilidad de Microsoft Graph, incluidos los límites de las extensiones abiertas, consulte Agregar propiedades personalizadas a los recursos mediante extensiones y Agregar datos personalizados a los usuarios mediante extensiones abiertas.

Consideraciones específicas de Outlook

Cada extensión abierta en un recurso de Outlook (evento, mensaje o contacto personal) se almacena en una propiedad con nombre MAPI. Cuando crea extensiones abiertas para Outlook, tenga en cuenta que las propiedades con nombre MAPI son un recurso limitado en un buzón de usuario. Cuando se agota la cuota de propiedades con nombre de un usuario, ya no se pueden crear propiedades con nombre para ese usuario. Esto puede provocar un comportamiento inesperado de los clientes que dependan de propiedades con nombre para funcionar.

Siga las siguientes instrucciones al crear extensiones abiertas en recursos de Outlook:

  • Cree el número mínimo de extensiones necesarias. La mayoría de las aplicaciones no deberían requerir más de una extensión. Las extensiones no tienen propiedades ni estructura definidas, por lo que puede almacenar varios valores en una sola extensión.
  • Evite nombrar las extensiones de manera variable (por ejemplo basándose en las entradas del usuario, etcétera). Cada vez que se crea una extensión abierta con un nuevo nombre que no se ha usado antes en el buzón de un usuario, se crea una nueva propiedad con nombre MAPI. Al quitar la extensión no se quita la propiedad con nombre.

Usar extensiones abiertas (para recursos de Outlook) o propiedades extendidas

Las extensiones abiertas son la solución recomendada en la mayoría de los escenarios relacionados con el almacenamiento y el acceso a datos personalizados. Sin embargo, si necesita tener acceso a datos personalizados para las propiedades MAPI de Outlook que aún no están expuestas a través de los metadatos de Microsoft Graph API, puede usar propiedades extendidas y su API REST. Puede comprobar las propiedades que exponen los metadatos en: https://graph.microsoft.com/v1.0/$metadata.

Métodos

Método Tipo de valor devuelto Descripción
Crear openTypeExtension(en una instancia de recurso existente) o un nuevo objeto baseTask, baseTaskListcontact, event, message, post, todoTask o todoTaskList que contiene un objeto openTypeExtension. Cree un objeto openTypeExtension en una instancia de recursos nueva o existente.
Get openTypeExtension Lea las propiedades y las relaciones del objeto openTypeExtension.
Actualizar openTypeExtension Actualice el objeto openTypeExtension.
Eliminar Ninguno Elimine el objeto openTypeExtension.

Propiedades

Propiedad Tipo Descripción
extensionName String Un identificador de texto único para una extensión de datos de tipo abierto. Necesario.
id String Un identificador completo que concatena el tipo de extensión con el extensionName. Solo lectura.

El identificador debe definirse durante la operación Create mediante una de las siguientes maneras:
  • Defina explícitamente la propiedad id en el cuerpo de la solicitud.
  • Defina una propiedad extensionName en el cuerpo de la solicitud y Microsoft Graph asigna automáticamente el mismo valor a la propiedad id .
    • En las actualizaciones posteriores, puede cambiar el valor de la propiedad extensionName a uno diferente del valor del identificador .
    • En las actualizaciones posteriores, al especificar solo la propiedad id en el cuerpo de la solicitud, se elimina automáticamente la propiedad extensionName de la extensión abierta.

Relaciones

Ninguno

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "extensionName": "string",
  "id": "String (identifier)"
}

Contenido relacionado