event リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ユーザーの予定表か、Microsoft 365 グループの既定の予定表のイベントです。
イベントに含まれる参加者の最大数、および Exchange Online メールボックスから送信される eventMessage の受信者の最大数は 500 です。 詳細については、「送信の制限」を参照してください。
このリソースは以下をサポートしています。
注: ユーザーの予定表とグループの予定表、およびそのイベントの操作方法には、わずかな相違点がいくつかあります。
- calendarGroup にはユーザーの予定表のみを整理できます。
- 添付ファイル オブジェクトは、ユーザーの予定表のイベントのみに追加できます。しかし、グループの予定表のイベントには追加できません。
- Outlook はグループの代わりにすべての会議出席依頼を自動的に受け入れます。 ユーザーの予定表に対してのみ、会議出席依頼を承諾、仮承諾、または辞退できます。
- Outlook はグループ イベントのアラームをサポートしていません。 ユーザーの予定表についてのみ、リマインダーを再起動または無視できます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | Event コレクション | ユーザーのメールボックス内のイベント オブジェクトの一覧を取得します。 一覧には、単一インスタンスの会議と定期的なマスターが含まれています。 |
| Create | event | インスタンス コレクションへの投稿により、新しいイベントを作成します。 |
| Get | event | event オブジェクトのプロパティとリレーションシップを読み取ります。 |
| 更新する | event | イベント オブジェクトを更新します。 |
| 削除 | なし | event オブジェクトを削除します。 |
| 完全に削除 | なし | イベントを完全に削除し、ユーザーのメールボックスの [回復可能なアイテム] フォルダーの Purges フォルダーに配置します。 |
| Get delta | event コレクション | ユーザーのプライマリ 予定表の calendarView (イベントの範囲) で追加、削除、または更新された一連のイベントを取得します。 |
| イベントを転送する | なし | 会議のイベントの開催者または出席者が、新しい受信者に会議出席依頼を転送します。 |
| イベントをキャンセルする | なし | 開催者からの取り消しメッセージをすべての出席者に送信し、指定の会議を取り消します。 |
| イベントを承諾する | なし | ユーザーの予定表の指定のイベントを承諾します。 |
| 仮承諾 | なし | ユーザーの予定表の指定のイベントを仮承諾します。 |
| イベントを辞退する | なし | ユーザーの予定表の指定のイベントに対する詳細を辞退します。 |
| 通知を消す | なし | ユーザーの予定表の指定したイベントのリマインダーを無視します。 |
| アラームを再通知する | なし | ユーザーの予定表の指定したイベントのリマインダーを新しい時刻まで延期します。 |
| イベント インスタンスを一覧表示する | Event コレクション | event オブジェクトのコレクションを取得します。 |
| 添付ファイル | ||
| 添付ファイルを一覧表示する | Attachment コレクション | イベントのすべての添付ファイルを取得します。 |
| 添付ファイルを追加する | Attachment | attachments コレクションへの投稿により、イベントに新しい添付ファイルを追加します。 |
| オープン拡張機能 | ||
| Create open extension | openTypeExtension | オープン拡張機能を作成し、新規または既存のリソースにカスタム プロパティを追加します。 |
| Get open extension | openTypeExtension コレクション | 拡張機能の名前で識別されるオープン拡張機能を取得します。 |
| 拡張プロパティ | ||
| 単一値のプロパティを作成する | event | 新規または既存のイベントに、1 つ以上の単一値の拡張プロパティを作成します。 |
| 単一値のプロパティを取得する | event |
$expand または $filter を使用して、単一値の拡張プロパティを含むイベントを取得します。 |
| 複数値のプロパティを作成する | event | 新規または既存のイベントに、1 つ以上の複数値の拡張プロパティを作成します。 |
| 複数値のプロパティを取得する | event |
$expand を使用して、複数値の拡張プロパティを含むイベントを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| allowNewTimeProposals | Boolean |
true 会議の開催者が、返信時に招待者が新しい時間を提案できる場合。それ以外の場合は false。 省略可能です。 既定値は true です。 |
| attendees | Attendee コレクション | イベントの出席者のコレクション。 |
| body | ItemBody | イベントに関連付けられたメッセージの本文。 HTML 形式またはテキスト形式にできます。 |
| bodyPreview | String | イベントに関連付けられたメッセージのプレビュー。 テキスト形式です。 |
| cancelledOccurrences | String collection | イベントが系列マスターの場合、定期的な系列内の取り消されたインスタンスの occurrenceId プロパティ値を格納します。 取り消された定期的な系列のインスタンスは canceledOccurences と呼ばれます。 Get 操作の $select にのみ返されます。これは、系列マスターイベントの ID (つまり、seriesMasterId プロパティ値) を指定します。 |
| categories | String collection | イベントに関連付けられたカテゴリ。 各カテゴリは、ユーザーに対して定義されている outlookCategory の displayName プロパティに対応しています。 |
| changeKey | String | イベント オブジェクトのバージョンを識別します。 イベントを変更するたびに ChangeKey も変更されます。 これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 |
| createdDateTime | DateTimeOffset | Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| end | DateTimeTimeZone | イベントが終了する日付、時刻、タイムゾーン。 既定で、終了時刻は UTC 単位です。 |
| exceptionOccurrences | event コレクション | 定期的な系列の例外となるイベント インスタンスの ID プロパティ値が含まれます。 例外は、件名、開始または終了時刻、出席者など、定期的な系列での他の発生と異なる場合があります。 例外には、取り消された出現は含まれません。 系列マスター イベントの ID (つまり、seriesMasterId プロパティ値) を指定する GET 操作の$selectと$expandでのみ返されます。 |
| hasAttachments | Boolean | イベントに添付ファイルが含まれている場合、true に設定します。 |
| hideAttendees | Boolean |
true に設定すると、各出席者は会議出席依頼と会議の管理リストにのみ表示されます。 既定値は false です。 |
| iCalUId | String | 予定表全体のイベントの固有識別子。 この ID は、定期的なアイテムの出現ごとに異なります。 読み取り専用。 |
| id | String | イベントの一意の識別子。
既定では、この値は、アイテムをあるコンテナー (フォルダーや予定表など) から別のコンテナーに移動したときに変更されます。 この動作を変更するには、Prefer: IdType="ImmutableId" ヘッダーを使用します。 詳細については「Outlook リソースの不変識別子を取得する」を参照してください。 大文字と小文字は区別され、読み取り専用です。 |
| importance | String | イベントの重要度。 可能な値は low、normal、high です。 |
| isAllDay | Boolean | イベントが一日中続く場合に、true に設定します。 true の場合、1 日または複数日のイベントであるかどうかに関係なく、開始時刻と終了時刻を午前 0 時に設定し、同じタイムゾーンにする必要があります。 |
| isCancelled | Boolean | イベントがキャンセルされた場合に、true に設定します。 |
| isDraft | Boolean | ユーザーが Outlook で会議を更新したが、出席者に更新プログラムを送信していない場合は、true に設定します。 すべての変更が送信されている場合、またはイベントが出席者のいない予定の場合は、false に設定します。 |
| isOnlineMeeting | Boolean | このイベントにオンライン会議情報がある場合は True (つまり、onlineMeeting が onlineMeetingInfo リソースを指している場合)、そうでない場合は false です。 規定値は false (onlineMeeting は null) です。 省略可能です。 isOnlineMeeting を true に設定すると、Microsoft Graph は onlineMeeting を初期化します。 その後、 isOnlineMeeting に対するそれ以上の変更は無視され、会議はオンラインのままです。 |
| isOrganizer | ブール型 | 予定表の所有者 (calendar の owner プロパティで指定) がイベントの主催者 (event の organizer プロパティで指定) の場合、true に設定されます。 代理人が所有者の代わりにイベントを主催した場合にも適用されます。 |
| isReminderOn | Boolean | ユーザーにイベントを通知するアラートを設定する場合は、true に設定します。 |
| lastModifiedDateTime | DateTimeOffset | Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| location | Location | イベントの場所。 |
| locations | Location コレクション | イベントを開催する場所、または参加者がいる場所。 location プロパティと locations プロパティは常に互いに一致します。 location プロパティを更新すると、locations コレクションに含まれる既存のすべての場所が削除されて、location の新しい値に置き換えられます。 |
| occurrenceId | String | 定期的なイベント系列の発生の識別子。 イベントが定期的な系列に含まれていない場合は Null。 プロパティ値の形式は OID です。{seriesMasterId - 値}。{発生 - 開始 - 日付}。 {発生 - 開始 - 日付} のタイムゾーンは、対応する recurrenceRange で定義される recurrenceTimeZone プロパティです。 このプロパティは、変更または取り消された出現を含む、定期的な系列内の任意の発生を識別できます。 このプロパティを使用して、定期的な系列の発生でサポートされているすべての操作を実行できます。 |
| onlineMeeting | OnlineMeetingInfo | 参加者がオンラインで会議に参加するための詳細。 既定値は null です。 読み取り専用です。 isOnlineMeeting および onlineMeetingProvider プロパティを設定して会議をオンラインで有効にすると、Microsoft Graph は onlineMeeting を初期化します。 設定すると、会議はオンラインのままであり、 isOnlineMeeting、 onlineMeetingProvider、 onlneMeeting プロパティを 再度変更することはできません。 |
| onlineMeetingProvider | onlineMeetingProviderType | オンライン会議のサービス プロバイダーを表します。 規定値では、onlineMeetingProvider は unknown です。 使用可能な値は unknown、teamsForBusiness、skypeForBusiness および skypeForConsumer です。 省略可能です。 onlineMeetingProvider を設定すると、Microsoft Graph は onlineMeeting を初期化します。 その後、 onlineMeetingProvider を 再度変更することはできません。会議はオンラインのままです。 |
| onlineMeetingUrl | String | オンライン会議の URL。 このプロパティは、Outlook で開催者が Skype などのオンライン会議としてイベントを指定する場合にのみ設定します。 読み取り専用です。 URL にアクセスしてオンライン会議に参加するには、イベントの onlineMeeting プロパティによって公開される joinUrlを使用します。 将来、onlineMeetingUrl プロパティが非推奨となる予定です |
| organizer | Recipient | イベントの開催者。 |
| originalEndTimeZone | String | イベントの作成時に設定された終了タイム ゾーン。 値 tzone://Microsoft/Custom は、デスクトップの Outlook で、従来のカスタム タイム ゾーンが設定されていることを示します。 |
| originalStart | DateTimeOffset | 定期的な一連の発生または例外として最初に作成されたイベントの開始時刻を表します。 このプロパティは、単一インスタンスであるイベントには返されません。 日付と時刻の情報は ISO 8601 形式で表され、常に UTC で表されます。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| originalStartTimeZone | String | イベントが作成されたときに設定された開始タイム ゾーン。 値 tzone://Microsoft/Custom は、デスクトップの Outlook で、従来のカスタム タイム ゾーンが設定されていることを示します。 |
| recurrence | PatternedRecurrence | イベントの繰り返しパターン。 |
| reminderMinutesBeforeStart | Int32 | アラーム通知を行う、イベント開始時間前の分数。 |
| responseRequested | Boolean | 既定値は true なので、開催者は招待者にイベントに返信するように求めます。 |
| responseStatus | ResponseStatus | イベント メッセージへの応答で送信される応答のタイプを識別します。 |
| sensitivity | String | 使用可能な値: normal、personal、private、confidential。 |
| seriesMasterId | String | 対象イベントが定期的なアイテムの一部である場合、定期的なアイテムのマスター アイテムの ID。 |
| showAs | String | 表示するステータス。 使用可能な値: free、tentative、busy、oof、workingElsewhere、unknown。 |
| 開始 | DateTimeTimeZone | イベントの開始日、時間、タイム ゾーン。 既定で、開始時刻は UTC 単位です。 |
| subject | String | イベントの件名行のテキスト。 |
| transactionId | String | クライアントが同じイベントの作成を再試行した場合に冗長 な POST 操作を回避するために、サーバーのクライアント アプリによって指定されたカスタム識別子。 これは、ネットワーク接続が低いと、クライアントが以前のイベント作成要求に対するサーバーからの応答を受信する前にタイムアウトする場合に役立ちます。 イベントの作成時に transactionId を 設定した後、後続の更新で transactionId を 変更することはできません。 このプロパティは、アプリで設定されている場合にのみ、応答ペイロードで返されます。 省略可能です。 |
| type | String | イベントの種類。 使用可能な値は、singleInstance、occurrence、exception、seriesMaster です。 読み取り専用 |
| uid | 文字列 | 予定表イベントの一意識別子。 定期的なイベントの場合、値はシリーズ マスターと、そのすべての発生に対して同じになります (例外を含む)。 |
| webLink | String | Web 上の Outlook でイベントを開く URL。 Outlook on the web は、メールボックスにサインインしている場合にブラウザーでイベントを開きます。 それ以外の場合は、Outlook on the web はサインインするように求めます。 iFrame 内からこの URL にアクセスすることはできません。 |
注:
webLink プロパティでは、Outlook on the web の以前のバージョンでのみイベントを開く URL を指定します。 以下はその URL 形式で、{event-id} は id プロパティの URL エンコード値です。
職場または学校のアカウントの場合:
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemMicrosoft アカウントの場合:
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Outlook on the web の現在のバージョンで URL を開くには、URL を次の形式のいずれかに変換し、その URL を使用してイベントを開きます。
職場または学校のアカウントの場合:
https://outlook.office365.com/calendar/item/{event-id}Microsoft アカウントの場合:
https://outlook.live.com/calendar/item/{event-id}
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| attachments | Attachment コレクション | イベントの FileAttachment、ItemAttachment、referenceAttachment の各添付ファイルのコレクション。 ナビゲーション プロパティ。 読み取り専用。 Null 許容型。 |
| calendar | Calendar | イベントを含む予定表。 ナビゲーション プロパティ。 読み取り専用。 |
| extensions | Extension コレクション | イベントに対して定義されているオープン拡張機能のコレクション。 Null 許容型です。 |
| instances | Event コレクション | イベントが系列マスターの場合、定期的な系列の発生。 このプロパティには、繰り返しパターンの一部である出現と、変更された例外が含まれます。 系列から取り消された出現箇所は含まれません。 ナビゲーション プロパティ。 読み取り専用。 Null 許容型。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | イベントに対して定義された、複数値の拡張プロパティのコレクション。 読み取り専用。 Null 許容型。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | イベントに対して定義された、単一値の拡張プロパティのコレクションです。 読み取り専用。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"cancelledOccurrences":["string"],
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"exceptionOccurrences":["microsoft.graph.event"],
"hasAttachments": true,
"hideAttendees": false,
"iCalUId": "String",
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"occurrenceId":"string",
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"type": "String",
"uid": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }]
}