calendar リソース型
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
イベント リソースのコンテナーを表します。 ユーザー の予定表、または Microsoft 365 グループ の既定の予定表のいずれかを指定できます。
注: ユーザーの予定表とグループの予定表の操作方法には、わずかな相違点がいくつかあります。
- ユーザーの予定表のみを calendarGroup に編成できます。
- Outlook はグループの代わりにすべての会議出席依頼を自動的に受け入れます。 ユーザーの予定表に対してのみ、会議出席依頼を 承諾、 仮承諾、または 辞退 できます。
- Outlook はグループ イベントのアラームをサポートしていません。 ユーザーの予定表についてのみ、アラームを再通知または無視できます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | calendar collection | ユーザーのすべての予定表を取得するか、既定またはその他の特定の予定表グループの予定表を取得します。 |
| Create | calendar | 既定の予定表グループまたはユーザーの特定の予定表グループに予定表を作成します。 |
| Get | calendar | 予定表オブジェクトのプロパティと関係を取得します。 ユーザーの予定表、または Microsoft 365 グループの既定の予定表のいずれかを指定できます。 |
| Update | calendar | 予定表オブジェクトのプロパティを更新します。 ユーザーの予定表、または Microsoft 365 グループの既定の予定表のいずれかを指定できます。 |
| Delete | なし | 予定表オブジェクトを削除します。 |
| 完全に削除 | なし | 予定表フォルダーを完全に削除し、メールボックスから削除します。 |
| 予定表ビューを一覧表示する | event コレクション | ユーザーの標準として設定されている予定表 (../me/calendarView) または特定の予定表から、時間範囲で定義したカレンダー ビューのイベントの発生、例外、および単一インスタンスを取得します。 |
| イベントを一覧表示する | event コレクション | 予定表のイベント一覧を取得します。 一覧には、単一インスタンスの会議と定期的なマスターが含まれています。 |
| Create event | event | 既定または指定の予定表に新しいイベントを作成します。 |
| 空き時間スケジュールを取得する | scheduleInformation コレクション | 指定した期間について、ユーザー、配布リスト、またはリソースのコレクションの空き時間情報を取得します。 |
| 会議の日時を検索する | meetingTimeSuggestionsResult | 開催者と出席者の空き時間、および時間や場所の制約に基づいて、会議の時間と場所を提案します。 |
| 単一値のプロパティを作成する | calendar | 新規または既存の予定表に、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | calendar |
$expand または $filter を使用して、単一値の拡張プロパティを含む予定表を取得します。 |
| 複数値のプロパティを作成する | calendar | 新規または既存の予定表に、1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | calendar |
$expand を使用して、複数値の拡張プロパティを含む予定表を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| allowedOnlineMeetingProviders | onlineMeetingProviderType コレクション | この予定表でオンライン会議の作成に使用できる、オンライン会議サービス プロバイダーを表します。 使用可能な値: unknown、skypeForBusiness、skypeForConsumer、teamsForBusiness。 |
| calendarGroupId | String | 予定表を作成する calendarGroup です。 ユーザーが予定表のグループを明示的に設定したことがない場合、このプロパティは null です。 |
| canEdit | Boolean | ユーザーが予定表に書き込むことができる場合は true、それ以外の場合は false です。 予定表を作成したユーザーの場合は、このプロパティは true です。 Outlook クライアントまたは対応する calendarPermission リソースを介して予定表を共有していて、書き込みアクセスが付与されているユーザーの場合も、このプロパティは true です。 読み取り専用です。 |
| canShare | ブール値 | ユーザーに予定表を共有するためのアクセス許可がある場合は true、それ以外の場合は false です。 予定表を作成したユーザーのみがその予定表を共有できます。 読み取り専用です。 |
| canViewPrivateItems | ブール値 | ユーザーがプライベートとしてマークされている予定表アイテムを読み取ることができる場合は true、それ以外の場合は false です。 このプロパティは、Outlook クライアント、または対応する calendarPermission リソースによって設定されます。 読み取り専用です。 |
| changeKey | String | 予定表オブジェクトのバージョンを識別します。 予定表が変更されるたびに、changeKey も変更されます。 これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 読み取り専用。 |
| 色 | calendarColor | UI で予定表を他の予定表から区別するための配色テーマを指定します。 プロパティ値は auto、lightBlue、lightGreen、lightOrange、lightGray、lightYellow、lightTeal、lightPink、lightBrown、lightRed、maxColor です。 |
| defaultOnlineMeetingProvider | onlineMeetingProviderType | この予定表から送信された会議の既定のオンライン会議プロバイダーです。 使用可能な値: unknown、skypeForBusiness、skypeForConsumer、teamsForBusiness。 |
| hexColor | 文字列 | 予定表の色。3 つの 16 進数値による 16 進数の色コードです。それぞれの範囲は 00 から FF までで、RGB 色空間の赤色要素、緑色要素、および青色要素を表します。 ユーザーが明示的に予定表の色を設定したことがない場合、このプロパティは空になります。 |
| id | 文字列 | 予定表の一意の識別子。 読み取り専用です。 |
| isDefaultCalendar | Boolean | これが既定の予定表 (新しいイベントが既定で作成される予定表) の場合は true、それ以外の場合は false です。 |
| isRemovable | ブール値 | このユーザーの予定表がユーザーのメールボックスから削除できるかどうかを示します。 |
| isShared | Boolean | ユーザーが他のユーザーと予定表を共有している場合は true、それ以外の場合は false です。 予定表を共有できるのはその予定表を作成したユーザーのみであるため、同じユーザーに対して isShared と isSharedWithMe を true にすることはできません。 このプロパティは、Outlook クライアントで共有が開始されたときに設定されます。また、クライアントまたは対応する calendarPermission リソースを介して共有がキャンセルされた場合は、リセットできます。 読み取り専用です。 |
| isSharedWithMe | Boolean | ユーザーがこの予定表を共有している場合は true、それ以外の場合は false です。 予定表の所有者の場合は、このプロパティは常に false です。 このプロパティは、Outlook クライアントで共有が開始されたときに設定されます。また、クライアントまたは対応する calendarPermission リソースを介して共有がキャンセルされた場合は、リセットできます。 読み取り専用です。 |
| isTallyingResponses | ブール値 | このユーザーの予定表が会議依頼の応答の追跡をサポートしているかどうかを示します。 ユーザーのプライマリの予定表から送信された会議の招待のみが会議依頼の応答の追跡をサポートします。 |
| name | String | 予定表の名前。 |
| owner | emailAddress | 設定すると、これは予定表を作成または追加したユーザーを表します。 ユーザーが作成または追加した予定表の場合、owner プロパティがユーザーに設定されます。 ユーザーと共有されている予定表の場合は、owner プロパティがその予定表をユーザーと共有した人に設定されます。 読み取り専用です。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| calendarPermissions | calendarPermission コレクション | 予定表を共有しているユーザーのアクセス許可です。 |
| calendarView | event コレクション | 予定表のカレンダー ビュー。 ナビゲーション プロパティ。 読み取り専用です。 |
| events | event コレクション | 予定表内のイベント。 ナビゲーション プロパティ。 読み取り専用。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | 予定表に定義された、複数値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | 予定表に定義された、単一値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"allowedOnlineMeetingProviders": ["string"],
"canEdit": "boolean",
"canShare": "boolean",
"canViewPrivateItems": "boolean",
"changeKey": "string",
"color": "String",
"defaultOnlineMeetingProvider": "string",
"hexColor": "String",
"id": "string (identifier)",
"isDefaultCalendar": "boolean",
"isRemovable": "boolean",
"isShared": "boolean",
"isSharedWithMe": "boolean",
"isTallyingResponses": "boolean",
"name": "string",
"owner": {"@odata.type": "microsoft.graph.emailAddress"}
}