Actualizar evento

Espacio de nombres: microsoft.graph

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 la solicitud

En el cuerpo de la solicitud, únicamente proporcione los valores de las propiedades que deben actualizarse. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Propiedad	Tipo	Descripción
attendees	Attendee	La colección de asistentes del evento.
body	ItemBody	El cuerpo del mensaje asociado con el evento.
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.
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, high.
isAllDay	Booleano	Se establece como true si el evento dura todo el día.
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	Location	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	Cadena	Los valores posibles son: normal, personal, private, confidential
showAs	String	El estado que se mostrará. Los valores posibles son: free, tentative, busy, oof, workingElsewhere, unknown.
start	DateTimeTimeZone	La fecha de inicio, la hora y la zona horaria del evento.
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.

HTTP

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

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "datetime-value"
  },
  "recurrence": null,
  "reminderMinutesBeforeStart": 99,
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "teamsForBusiness",
  "isReminderOn": true,
  "hideAttendees": false,
  "categories": ["Red category"]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Event
{
	OriginalStartTimeZone = "originalStartTimeZone-value",
	OriginalEndTimeZone = "originalEndTimeZone-value",
	ResponseStatus = new ResponseStatus
	{
		Response = ResponseType.None,
		Time = DateTimeOffset.Parse("datetime-value"),
	},
	Recurrence = null,
	ReminderMinutesBeforeStart = 99,
	IsOnlineMeeting = true,
	OnlineMeetingProvider = OnlineMeetingProviderType.TeamsForBusiness,
	IsReminderOn = true,
	HideAttendees = false,
	Categories = new List<string>
	{
		"Red category",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Events["{event-id}"].PatchAsync(requestBody);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users events patch --user-id {user-id} --event-id {event-id} --body '{\
  "originalStartTimeZone": "originalStartTimeZone-value",\
  "originalEndTimeZone": "originalEndTimeZone-value",\
  "responseStatus": {\
    "response": "",\
    "time": "datetime-value"\
  },\
  "recurrence": null,\
  "reminderMinutesBeforeStart": 99,\
  "isOnlineMeeting": true,\
  "onlineMeetingProvider": "teamsForBusiness",\
  "isReminderOn": true,\
  "hideAttendees": false,\
  "categories": ["Red category"]\
}\
'

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewEvent()
originalStartTimeZone := "originalStartTimeZone-value"
requestBody.SetOriginalStartTimeZone(&originalStartTimeZone) 
originalEndTimeZone := "originalEndTimeZone-value"
requestBody.SetOriginalEndTimeZone(&originalEndTimeZone) 
responseStatus := graphmodels.NewResponseStatus()
response := graphmodels.NONE_RESPONSETYPE 
responseStatus.SetResponse(&response) 
time , err := time.Parse(time.RFC3339, "datetime-value")
responseStatus.SetTime(&time) 
requestBody.SetResponseStatus(responseStatus)
recurrence := null
requestBody.SetRecurrence(&recurrence) 
reminderMinutesBeforeStart := int32(99)
requestBody.SetReminderMinutesBeforeStart(&reminderMinutesBeforeStart) 
isOnlineMeeting := true
requestBody.SetIsOnlineMeeting(&isOnlineMeeting) 
onlineMeetingProvider := graphmodels.TEAMSFORBUSINESS_ONLINEMEETINGPROVIDERTYPE 
requestBody.SetOnlineMeetingProvider(&onlineMeetingProvider) 
isReminderOn := true
requestBody.SetIsReminderOn(&isReminderOn) 
hideAttendees := false
requestBody.SetHideAttendees(&hideAttendees) 
categories := []string {
	"Red category",
}
requestBody.SetCategories(categories)

events, err := graphClient.Me().Events().ByEventId("event-id").Patch(context.Background(), requestBody, nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Event event = new Event();
event.setOriginalStartTimeZone("originalStartTimeZone-value");
event.setOriginalEndTimeZone("originalEndTimeZone-value");
ResponseStatus responseStatus = new ResponseStatus();
responseStatus.setResponse(ResponseType.None);
OffsetDateTime time = OffsetDateTime.parse("datetime-value");
responseStatus.setTime(time);
event.setResponseStatus(responseStatus);
event.setRecurrence(null);
event.setReminderMinutesBeforeStart(99);
event.setIsOnlineMeeting(true);
event.setOnlineMeetingProvider(OnlineMeetingProviderType.TeamsForBusiness);
event.setIsReminderOn(true);
event.setHideAttendees(false);
LinkedList<String> categories = new LinkedList<String>();
categories.add("Red category");
event.setCategories(categories);
Event result = graphClient.me().events().byEventId("{event-id}").patch(event);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const event = {
  originalStartTimeZone: 'originalStartTimeZone-value',
  originalEndTimeZone: 'originalEndTimeZone-value',
  responseStatus: {
    response: '',
    time: 'datetime-value'
  },
  recurrence: null,
  reminderMinutesBeforeStart: 99,
  isOnlineMeeting: true,
  onlineMeetingProvider: 'teamsForBusiness',
  isReminderOn: true,
  hideAttendees: false,
  categories: ['Red category']
};

await client.api('/me/events/{id}')
	.update(event);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Event;
use Microsoft\Graph\Generated\Models\ResponseStatus;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Event();
$requestBody->setOriginalStartTimeZone('originalStartTimeZone-value');
$requestBody->setOriginalEndTimeZone('originalEndTimeZone-value');
$responseStatus = new ResponseStatus();
$responseStatus->setResponse(new ResponseType('none'));
$responseStatus->setTime(new \DateTime('datetime-value'));
$requestBody->setResponseStatus($responseStatus);
$requestBody->setRecurrence(null);
$requestBody->setReminderMinutesBeforeStart(99);
$requestBody->setIsOnlineMeeting(true);
$requestBody->setOnlineMeetingProvider(new OnlineMeetingProviderType('teamsForBusiness'));
$requestBody->setIsReminderOn(true);
$requestBody->setHideAttendees(false);
$requestBody->setCategories(['Red category', 	]);

$result = $graphServiceClient->me()->events()->byEventId('event-id')->patch($requestBody)->wait();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Calendar

$params = @{
	originalStartTimeZone = "originalStartTimeZone-value"
	originalEndTimeZone = "originalEndTimeZone-value"
	responseStatus = @{
		response = ""
		time = [System.DateTime]::Parse("datetime-value")
	}
	recurrence = $null
	reminderMinutesBeforeStart = 99
	isOnlineMeeting = $true
	onlineMeetingProvider = "teamsForBusiness"
	isReminderOn = $true
	hideAttendees = $false
	categories = @(
	"Red category"
)
}

# A UPN can also be used as -UserId.
Update-MgUserEvent -UserId $userId -EventId $eventId -BodyParameter $params

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.event import Event
from msgraph.generated.models.response_status import ResponseStatus

graph_client = GraphServiceClient(credentials, scopes)

request_body = Event(
	original_start_time_zone = "originalStartTimeZone-value",
	original_end_time_zone = "originalEndTimeZone-value",
	response_status = ResponseStatus(
		response = ResponseType.None,
		time = "datetime-value",
	),
	recurrence = None,
	reminder_minutes_before_start = 99,
	is_online_meeting = True,
	online_meeting_provider = OnlineMeetingProviderType.TeamsForBusiness,
	is_reminder_on = True,
	hide_attendees = False,
	categories = [
		"Red category",
	],
)

result = await graph_client.me.events.by_event_id('event-id').patch(request_body)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta. Nota: El objeto de respuesta que se muestra aquí puede haberse acortado para mejorar la legibilidad.

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

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "datetime-value"
  },
  "recurrence": null,
  "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"
  }
}

Contenido relacionado

• Agregar datos personalizados a los recursos mediante extensiones
• Agregar datos personalizados a los usuarios mediante extensiones abiertas
• Agregar datos personalizados a los grupos mediante extensiones de esquema