Trabajar con calendarios y eventos mediante Microsoft Graph API

La API de calendario de Microsoft Graph proporciona calendario, calendarGroup, evento y otros recursos que le permiten crear eventos y reuniones, buscar tiempos de reunión viables, administrar asistentes y mucho más. Con Calendar API, puede crear una variedad de experiencias con datos de calendario.

Administración de eventos y reuniones

El tipo de evento representa una repetición programada en un calendario, como una reunión, un día festivo o un bloque de tiempo. Las reuniones, como las reuniones de equipo o las reuniones uno a uno, están representadas por recursos de eventos . Puede administrar directamente el ciclo de vida de los eventos mediante la creación, cancelación y eliminación de eventos directamente, entre otras acciones. Además, puede crear borradores de mensajes de evento, enviarlos, reenviarlos y crear borradores de respuestas, etc. Al trabajar con mensajes de eventos, permite al usuario asumir un rol activo en la creación de eventos y reuniones. También les permite comunicarse con los originadores de la reunión, otros destinatarios y asistentes.

Trabajar directamente con eventos

Microsoft Graph API proporciona métodos para operaciones como crear, actualizar, eliminar y cancelar eventos. En la tabla siguiente se enumeran algunos casos comunes de uso de eventos de ciclo de vida y las API que Microsoft Graph proporciona para trabajar con ellos.

Caso de uso	Verbo	Dirección URL de ejemplo
Cree un evento.	POST	/users/{id | userPrincipalName}/events
Eliminar un evento de un calendario.	DELETE	/users/{id | userPrincipalName}/events/{id}
Cancela un evento y envía un mensaje de cancelación. Nota: Especifique el mensaje de cancelación opcional en el cuerpo de la solicitud.	POST	/users/{id | userPrincipalName}/events/{id}/cancel
Actualizar un evento. Nota: Especifique los detalles del evento que se van a actualizar en el cuerpo de la solicitud.	PATCH	/users/{id | userPrincipalName}/events/{id}
Acepte un evento.	POST	/users/{id | userPrincipalName}/events/{id}/accept
Acepte provisionalmente un evento.	POST	/users/{id | userPrincipalName}/events/{id}/tentativelyAccept
Rechazar un evento.	POST	/users/{id | userPrincipalName}/events/{id}/decline
Descartar un aviso de evento.	POST	/users/{id | userPrincipalName}/events/{id}/dismissReminder
Anótese un recordatorio de evento.	POST	/users/{id | userPrincipalName}/events/{id}/snoozeReminder

Trabajar con mensajes de evento

El recurso eventMessage es un tipo abstracto que representa las solicitudes de reunión, las cancelaciones y las respuestas. Las respuestas se generan cuando el destinatario del mensaje acepta, acepta provisionalmente o rechaza la solicitud. El control de eventMessageRequest y eventMessageResponse mueve el evento a lo largo de su ciclo de vida. Las API de mensajería de calendar API admiten contenido MIME y JSON.

En la tabla siguiente se enumeran algunos casos comunes de uso de mensajes de evento y las API para trabajar con ellos.

Caso de uso	Verbo	Dirección URL de ejemplo
Enviar un borrador existente.	POST	/users/{id | userPrincipalName}/messages/{id}/send
Cree una respuesta de borrador.	POST	/users/{id | userPrincipalName}/messages/{id}/createReply
Responder a un mensaje de evento.	POST	/users/{id | userPrincipalName}/messages/{id}/reply
Cree un borrador de mensaje de respuesta a todos.	POST	/users/{id | userPrincipalName}/messages/{id}/createReplyAll
Responder a todos en un mensaje de evento.	POST	/users/{id | userPrincipalName}/messages/{id}/replyAll
Cree un borrador hacia delante.	POST	/users/{id | userPrincipalName}/messages/{id}/createForward
Reenviar un mensaje de evento.	POST	/users/{id | userPrincipalName}/messages/{id}/forward

Adición y eliminación de datos adjuntos

El tipo de datos adjuntos abstractos actúa como base para archivos, elementos y referencias que están asociados a eventos, mensajes y publicaciones. Puede ver los datos adjuntos de un evento, por ejemplo, con el método List attachments . Puede eliminar datos adjuntos con el método Delete attachment . Los eventos de calendarios de grupo no admiten datos adjuntos.

Tipos de datos adjuntos

Los tipos fileAttachment, itemAttachment y referenceAttatchment representan los tres tipos de elementos que se pueden adjuntar a los elementos del calendario. Un objeto itemAttachment representa un contacto, evento o mensaje que se adjunta directamente a un evento, mensaje o publicación de usuario. Un fileAttachment representa un archivo que está conectado directamente. Un referenceAttachment representa un elemento, como un documento de Word o un archivo de texto, que se encuentra en una unidad en la nube profesional o educativa de OneDrive u otra ubicación de almacenamiento compatible. Para ver todos los datos adjuntos de un evento, por ejemplo, puede usar el punto de conexión GET /users/{id | userPrincipalName}/events/{id}/attachments .

Carga de datos adjuntos

Puede cargar directamente datos adjuntos de menos de 3 MB en un evento para un usuario con el método Add attachment . Sin embargo, para los datos adjuntos de más de 3 MB, debe usar el método attachment: createUploadSession para obtener una dirección URL de carga que se usa para cargar los datos adjuntos de forma iterativa.

Trabajar con calendarios, grupos de calendarios y categorías de Outlook

Con calendar API, puede crear, leer, actualizar y eliminar calendarios, crear y ver eventos de calendario, obtener información de disponibilidad para los usuarios y buscar las horas de reunión sugeridas.

Calendar API proporciona métodos para operar en calendarios y grupos de calendarios. En la tabla siguiente se muestran algunos casos de uso con direcciones URL seleccionadas.

Nota: Muchos de los métodos que se muestran en la tabla siguiente tienen otras direcciones URL para casos de uso relacionados. Por ejemplo, para actualizar el calendario de un usuario en un grupo de calendario específico, envíe una operación PATCH con la dirección URL /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}.

Caso de uso	Verbo	Dirección URL de ejemplo
Enumera los calendarios de un usuario.	GET	/users/{id | userPrincipalName}/calendars
Enumere los calendarios de un usuario en un grupo.	GET	/users/{id | userPrincipalName}/calendarGroups/{calendarGroupId}/calendars
Cree un calendario.	POST	/users/{id | userPrincipalName}/calendars
Obtener un calendario.	GET	/users/{id | userPrincipalName}/calendars/{id}
Actualizar un calendario.	PATCH	/users/{id | userPrincipalName}/calendars/{id}
Eliminar un calendario.	DELETE	/users/{id | userPrincipalName}/calendars/{id}
Cree un grupo de calendarios.	POST	/users/{id | userPrincipalName}/calendarGroups
Obtener un grupo de calendarios.	GET	/users/{id | userPrincipalName}/calendarGroups/{id}
Actualizar un grupo de calendarios.	PATCH	/users/{id | userPrincipalName}/calendarGroups/{id}
Eliminar un grupo de calendarios.	DELETE	/users/{id | userPrincipalName}/calendarGroups/{id}

Datos de disponibilidad y horas de reunión

Dos de las funciones principales del calendario son encontrar información de disponibilidad y buscar horas de reunión para programar reuniones. Calendar API proporciona el método de programación Get free/busy que devuelve una colección de objetos scheduleInformation durante un período de tiempo y una colección de usuarios, recursos o listas de distribución. Puede presentar esta información al usuario para que pueda elegir manualmente una hora adecuada en la que programar una reunión. Use el método user: findMeetingTimes para obtener un valor meetingTimeSuggestionResult que contiene una colección de objetos meetingTimeSuggestion que representan información detallada sobre las horas de reunión propuestas para los participantes y las restricciones que envió.

Categorías de Outlook

Una categoría de calendario es una combinación de una descripción y una categoríaColor que juntos definen una categoría para un elemento de Outlook y controlan cómo Outlook muestra el elemento. Los usuarios de Outlook pueden agrupar mensajes y eventos, por ejemplo, por categoría. Para obtener más información, vea outlookCategory.

Permisos de calendario

Cuando los usuarios comparten calendarios con otros usuarios desde clientes de Outlook, pueden controlar los elementos de calendario que los destinatarios pueden ver o editar. La relación calendarPermissions contiene permisos para cada usuario con el que un usuario ha compartido su calendario. Esta relación le permite, por ejemplo, ver qué usuarios pueden ver la información de disponibilidad del propietario, ver toda la información del calendario o editar eventos en el calendario.

Trabajar con extensiones abiertas y propiedades extendidas

Las extensiones abiertas, anteriormente conocidas como extensiones de datos Office 365, representan la forma preferida de almacenar y acceder a datos personalizados para los recursos del buzón de un usuario. Si una propiedad MAPI de Outlook no está disponible en los metadatos de Microsoft Graph API, puede volver a las propiedades extendidas de Outlook. Para obtener más información, vea Información general sobre las propiedades extendidas de Outlook.

Pasos siguientes

Calendar API en Microsoft Graph permite crear una serie de experiencias con datos de calendario. Para obtener más información:

• Explore en profundidad los métodos y las propiedades de los recursos más útiles para su escenario.
• Pruebe la API en el Probador de Graph.