Mettre à jour un événement

Article
02/22/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettre à jour les propriétés de l’objet événement.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Remarques sur la mise à jour de propriétés spécifiques

Notez les comportements ou recommandations suivants lors de la mise à jour des propriétés correspondantes :

Mises à jour de la propriété et de la réunion des participants
- Une mise à jour d’événement qui inclut uniquement la propriété des participants dans le corps de la demande envoie une mise à jour de réunion uniquement aux participants qui ont changé.
- Une mise à jour d’événement qui supprime un participant spécifié en tant que membre d’une liste de distribution envoie une mise à jour de réunion à tous les participants.
propriété body et réunions en ligne

Avant de mettre à jour le corps d’un événement qui a été mis en place en tant que réunion en ligne, veillez d’abord à obtenir la propriété body, à appliquer les modifications appropriées au contenu et à conserver le blob de réunion pour la réunion en ligne. Par inadvertance, la suppression du blob de réunion du corps désactive la réunion en ligne.
propriétésde fin et de début et leurs fuseaux horaires ;

Lors de la mise à jour du fuseau horaire de l’heure de début ou de fin de l’événement, commencez par rechercher les fuseaux horaires pris en charge pour vous assurer de définir uniquement les fuseaux horaires qui ont été configurés pour le serveur de boîtes aux lettres de l’utilisateur.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire)	Calendars.ReadWrite
Déléguée (compte Microsoft personnel)	Calendars.ReadWrite
Application	Calendars.ReadWrite

Requête 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}

En-têtes de demande

Nom	Type	Description
Autorisation	string	Porteur {token}. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas changé.

Propriété	Type	Description
attendees	Attendee	Collection des participants à l’événement. Consultez les notes supplémentaires pour mettre à jour des propriétés spécifiques.
body	ItemBody	Corps du message associé à l’événement. Consultez les notes supplémentaires pour mettre à jour des propriétés spécifiques.
categories	String collection	Catégories associées à l’événement.
end	DateTimeTimeZone	Date, heure et fuseau horaire de fin de l’événement. Consultez les notes supplémentaires pour mettre à jour des propriétés spécifiques.
hideAttendees	Booléen	Lorsque la valeur `true`est attribuée, chaque participant ne voit qu’un seul dans la liste de la demande de réunion et du Suivi de la réunion. La valeur par défaut est False.
importance	String	Importance de l’événement. Les valeurs possibles sont `low`, `normal` et `high`.
isAllDay	Boolean	Valeur True si l’événement dure toute la journée. Si vrai, qu’il s’agisse d’un événement d’un seul jour ou de plusieurs jours, l’heure de début et de fin doit être réglée sur minuit et se trouver dans le même fuseau horaire.
isOnlineMeeting	Boolean	`True` si cet événement comporte des informations sur une réunion en ligne, `false` dans le cas contraire. La valeur par défaut est False. Facultatif.
isReminderOn	Boolean	Valeur True si une alerte est définie pour rappeler l’événement à l’utilisateur.
location	Emplacement	Emplacement de l’événement.
emplacements	Collection emplacement	Emplacements où l’événement est tenu. Les propriétés location et locations se correspondent toujours mutuellement. Si vous mettez à jour la propriété location, tous les emplacements précédents dans la collection locations sont supprimés et remplacés par la nouvelle valeur location.
onlineMeetingProvider	onlineMeetingProviderType	Représente le fournisseur de services de réunion en ligne. Les valeurs possibles sont `teamsForBusiness`, `skypeForBusiness` et `skypeForConsumer`. Facultatif.
recurrence	PatternedRecurrence	Modèle de périodicité pour l’événement.
reminderMinutesBeforeStart	Int32	Nombre de minutes avant la date de début de l’événement où l’alerte de rappel a lieu.
responseRequested	Boolean	Valeur True si l’expéditeur souhaite une réponse lorsque l’événement est accepté ou refusé.
sensitivity	String	Les valeurs possibles sont `normal`, `personal`, `private`, `confidential`.
showAs	String	État à afficher. Les valeurs possibles sont : `free` , `tentative`, `busy`, `oof`, `workingElsewhere`, `unknown`.
start	DateTimeTimeZone	Date, heure et fuseau horaire de début de l’événement. Consultez les notes supplémentaires pour mettre à jour des propriétés spécifiques.
subject	String	Texte de la ligne d’objet de l’événement.

Dans la mesure où la ressource événement prend en charge des extensions, vous pouvez utiliser l’opération PATCH pour ajouter, mettre à jour ou supprimer vos propres données spécifiques de l’application dans les propriétés personnalisées d’une extension dans une instance événement existante.

Si l’événement que vous mettez à jour est l’événement principal d’une série périodique, inclut plusieurs participants et comprend des instances mises à jour séparément, plusieurs e-mails de notification sont envoyés : un pour la série principale et un autre pour chaque instance mise à jour.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet event mis à jour dans le corps de la réponse.

Remarque : cette méthode peut renvoyer une réponse HTTP 400 Requête incorrecte avec le code d’erreur ErrorOccurrenceCrossingBoundary et le message d’erreur suivant : L’occurrence modifiée croise ou chevauche une occurrence adjacente. Cela indique que la mise à jour enfreint la restriction Outlook ci-après aux exceptions de récurrence : une occurrence ne peut pas être déplacée vers le jour de l’occurrence précédente ou un jour antérieur, ou vers le jour de l’occurrence suivante ou un jour postérieur.

Exemple

Demande

L’exemple suivant illustre une demande.

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


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Event
{
	OriginalStartTimeZone = "originalStartTimeZone-value",
	OriginalEndTimeZone = "originalEndTimeZone-value",
	ResponseStatus = new ResponseStatus
	{
		Response = ResponseType.None,
		Time = DateTimeOffset.Parse("2016-10-19T10:37:00Z"),
	},
	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);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users events patch --user-id {user-id} --event-id {event-id} --body '{\
  "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"]\
}\
'

Importante



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-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, "2016-10-19T10:37:00Z")
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)

Importante


// 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("2016-10-19T10:37:00Z");
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);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const event = {
  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']
};

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

Importante


<?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('2016-10-19T10:37:00Z'));
$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();

Importante


Import-Module Microsoft.Graph.Beta.Calendar

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

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

Importante


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 = "2016-10-19T10:37:00Z",
	),
	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)

Importante

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

Mettre à jour un événement

Remarques sur la mise à jour de propriétés spécifiques

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires

Mettre à jour un événement

Remarques sur la mise à jour de propriétés spécifiques

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Contenu connexe

Commentaires

Commentaires

Ressources supplémentaires