予定表を更新する
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
予定表オブジェクトのプロパティを更新します。 予定表には、ユーザーの予定表、または Microsoft 365 グループの既定の予定表のいずれかを指定できます。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
イベントが含まれている予定表の種類および要求されたアクセス許可の種類 (委任またはアプリケーション) に応じて、この API を呼び出すには、次のいずれかの権限が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
予定表 | 委任 (職場または学校のアカウント) | 委任 (個人用 Microsoft アカウント) | アプリケーション |
---|---|---|---|
ユーザーの予定表 | Calendars.ReadWrite | Calendars.ReadWrite | Calendars.ReadWrite |
グループ予定表 | Group.ReadWrite.All | サポートされていません。 | サポートされていません。 |
HTTP 要求
ユーザーまたはグループの既定の予定表。
PATCH /me/calendar
PATCH /users/{id | userPrincipalName}/calendar
PATCH /groups/{id}/calendar
既定の calendarGroup のユーザーの予定表。
PATCH /me/calendars/{id}
PATCH /users/{id | userPrincipalName}/calendars/{id}
指定の calendarGroup のユーザーの 予定表。
PATCH /me/calendarGroups/{id}/calendars/{id}
PATCH /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
Content-Type | application/json. 必須です。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。
プロパティ | 型 | 説明 |
---|---|---|
color | String | UI で予定表を他の予定表から区別するための配色テーマを指定します。 プロパティ値は、LightBlue=0、LightGreen=1、LightOrange=2、LightGray=3、LightYellow=4、LightTeal=5、LightPink=6、LightBrown=7、LightRed=8、MaxColor=9、Auto=-1 です。 |
isDefaultCalendar | Boolean | この予定表がユーザーの既定の予定表であれば True、そうでなければ False。 |
name | String | 予定表の名前。 |
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で、更新された予定表オブジェクトを返します。
例
要求
次の例では、サインインしているユーザーの既定の予定表の名前を更新します。
PATCH https://graph.microsoft.com/beta/me/calendar
Content-type: application/json
{
"name": "Social events"
}
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#me/calendars/$entity",
"@odata.id":"https://graph.microsoft.com/beta/users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/calendars('AAMkADJmMVAAA=')",
"id":"AAMkADJmMVAAA=",
"name":"Social events",
"color":"auto",
"hexColor": "",
"isDefaultCalendar":false,
"changeKey":"DxYSthXJXEWwAQSYQnXvIgAAIxGttg==",
"canShare":true,
"canViewPrivateItems":true,
"isShared":false,
"isSharedWithMe":false,
"canEdit":true,
"allowedOnlineMeetingProviders": [
"teamsForBusiness"
],
"defaultOnlineMeetingProvider": "teamsForBusiness",
"isTallyingResponses": true,
"isRemovable": false,
"owner":{
"name":"Samantha Booth",
"address":"samanthab@contoso.com"
}
}