Actualizar evento

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.

Actualiza las propiedades del objeto event.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Notas para actualizar propiedades específicas

Tenga en cuenta los siguientes comportamientos o recomendaciones al actualizar las propiedades correspondientes:

  • actualizaciones de la propiedad asistentes y reuniones

    • Una actualización del evento que incluye sólo la propiedad asistentes en el cuerpo de la solicitud envía una actualización de la reunión sólo a los asistentes que han cambiado.
    • Una actualización del evento que elimina a un asistente especificado como miembro de una lista de distribución envía una actualización de la reunión a todos los asistentes.
  • propiedad cuerpo y reuniones en línea

    Antes de actualizar el cuerpo de un evento que se ha configurado como una reunión en línea, asegúrese de obtener primero la propiedad del cuerpo, aplique los cambios apropiados al contenido y conserve el blob de la reunión para la reunión en línea. La eliminación involuntaria de un blob de la reunión del cuerpo deshabilitaría la reunión en línea.

  • propiedades de inicio y fin y sus zonas horarias

    Al actualizar la zona horaria de la hora de inicio o finalización de un evento, en primer lugar busque las zonas horarias compatibles para asegurarse de que solo se establezcan zonas horarias configuradas para el servidor de buzones del usuario.

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) Calendars.ReadWrite
Delegado (cuenta personal de Microsoft) Calendars.ReadWrite
Aplicación Calendars.ReadWrite

Solicitud HTTP

PATCH /me/events/{id}
PATCH /users/{id | userPrincipalName}/events/{id}
PATCH /groups/{id}/events/{id}

PATCH /me/calendar/events/{id}
PATCH /users/{id | userPrincipalName}/calendar/events/{id}
PATCH /groups/{id}/calendar/events/{id}

PATCH /me/calendars/{id}/events/{id}
PATCH /users/{id | userPrincipalName}/calendars/{id}/events/{id}

PATCH /me/calendarGroups/{id}/calendars/{id}/events/{id}
PATCH /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}

Encabezados de solicitud

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio.

Cuerpo de solicitud

En el cuerpo de la solicitud, proporcione los valores de los campos relevantes que deben actualizarse. Las propiedades existentes que no se incluyan en el cuerpo de la solicitud mantendrán los valores anteriores o se recalcularán según los cambios efectuados en otros valores de propiedad. Para obtener el mejor rendimiento no debe incluir valores existentes que no hayan cambiado.

Propiedad Tipo Descripción
attendees Asistente La colección de asistentes del evento. Consulte notas adicionales para actualizar propiedades específicas.
body ItemBody El cuerpo del mensaje asociado con el evento. Consulte notas adicionales para actualizar propiedades específicas.
categories Colección string Las categorías asociadas al evento.
end DateTimeTimeZone La fecha, la hora y la zona horaria en que finaliza el evento. Consulte notas adicionales para actualizar propiedades específicas.
hideAttendees Booleano Cuando se establece en true, cada asistente solo se ve a sí mismo en la convocatoria de reunión y en la lista de Seguimiento de la reunión. El valor predeterminado es false.
importance String Importancia del evento. Los valores posibles son: low, normal y high.
isAllDay Booleano Se establece como true si el evento dura todo el día. Si es el valor es true, independientemente de si se trata de un evento de un día o de varios días, la hora de inicio y de finalización debe establecerse en medianoche y debe ser de la misma zona horaria.
IsOnlineMeeting Boolean True si este evento tiene información de reuniones en línea, false en caso contrario. El valor predeterminado es false. Opcional.
isReminderOn Booleano Se establece en true si se establece una alerta para recordarle el evento al usuario.
location Ubicación La ubicación del evento.
locations Colección location Ubicaciones donde se celebra el evento o en las que se asiste. Las propiedades location y locations siempre se corresponden entre sí. Si se actualiza la propiedad location, se eliminarían las ubicaciones anteriores de la colección locations y se reemplazarían por el nuevo valor de location.
onlineMeetingProvider onlineMeetingProviderType Representa el proveedor de servicios de reuniones en línea. Los valores posibles son teamsForBusiness, skypeForBusiness y skypeForConsumer. Opcional.
recurrence PatternedRecurrence El patrón de periodicidad del evento.
reminderMinutesBeforeStart Int32 El número de minutos antes de la hora de inicio del evento en que se producirá la alerta del recordatorio.
responseRequested Booleano Se establece en true si el remitente quiere una respuesta cuando el evento se acepta o rechaza.
sensitivity String Los valores posibles son: normal, personal, private, confidential.
showAs String El estado que se mostrará. Los valores posibles son: , , , , , unknownworkingElsewhere. oofbusytentativefree
start DateTimeTimeZone La fecha de inicio, la hora y la zona horaria del evento. Consulte notas adicionales para actualizar propiedades específicas.
subject String El texto de la línea de asunto del evento.

Dado que el recurso event admite extensiones, puede utilizar la operación PATCH para agregar, actualizar o eliminar sus propios datos específicos de la aplicación en las propiedades personalizadas de una extensión en una instancia event existente.

Si el evento que se actualiza es el patrón de una serie periódica, contiene varios asistentes y tiene instancias que se han actualizado por separado, se enviarán varios mensajes de correo electrónico de notificación: uno para el patrón de la serie y otro para cada instancia que se ha actualizado.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto event actualizado en el cuerpo de la respuesta.

Nota: este método puede devolver una respuesta HTTP 400 Bad Request con un código de error ErrorOccurrenceCrossingBoundary y el siguiente mensaje de error: la repetición modificada cruza o se superpone con la repetición adyacente. Esto indica que la actualización infringe la restricción de Outlook siguiente en excepciones de periodicidad: una repetición no se puede mover al día de la repetición anterior o fechas anteriores a esta, y no se pueden mover al día de la siguiente repetición ni fechas posteriores.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/me/events/{id}
Content-type: application/json

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "2016-10-19T10:37:00Z"
  },
  "recurrence": null, 
  "reminderMinutesBeforeStart": 99,
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "teamsForBusiness",
  "isReminderOn": true,
  "hideAttendees": false,
  "categories": ["Red category"]
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 200 OK
Content-type: application/json

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "2016-10-19T10:37:00Z"
  },
  "recurrence": null,
  "iCalUId": "040000008200E00074=",
  "uid": "040000008200E00074=",
  "reminderMinutesBeforeStart": 99,
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "teamsForBusiness",
  "isReminderOn": true,
  "hideAttendees": false,
  "onlineMeeting": {
        "joinUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_NzIyNzhlMGEtM2YyZC00ZmY0LTlhNzUtZmZjNWFmZGNlNzE2%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%22bc55b173-cff6-457d-b7a1-64bda7d7581a%22%7d",
        "conferenceId": "177513992",
        "tollNumber": "+91 22 6241 6885"
    }
}