インスタンスの一覧表示
名前空間: microsoft.graph
指定した時間範囲のイベントのインスタンス (発生) を取得します。
イベントが seriesMaster
型の場合、この API は、指定した時間範囲内のイベントの発生と例外を返します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Calendars.ReadBasic | Calendars.Read |
委任 (個人用 Microsoft アカウント) | Calendars.ReadBasic | Calendars.Read |
アプリケーション | Calendars.ReadBasic | Calendars.Read |
HTTP 要求
GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
クエリ パラメーター
要求 URL に、次の必須のクエリ パラメーターを値で指定します。
パラメーター | 種類 | 説明 |
---|---|---|
startDateTime | String | 時間範囲の開始日時は、ISO 8601 形式で表されます。 例: "2015-11-08T19:00:00.0000000"。 |
endDateTime | String | 時間範囲の終了日時は、ISO 8601 形式で表されます。 例: "2015-11-08T20:00:00.0000000"。 |
このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。
要求ヘッダー
名前 | 種類 | 説明 |
---|---|---|
Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
優先: outlook.timezone | string | これを使用して、応答内の開始および終了時刻のタイム ゾーンを指定します。 指定しない場合、これらの時刻値は UTC で返されます。 省略可能。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で Event オブジェクトのコレクションを返します。
例
要求
次の例では、指定した時間範囲内の定期的な系列のマスター イベントの発生と例外を取得します。
GET https://graph.microsoft.com/v1.0/me/events/AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAENAAAiIsqMbYjsT5e-T7KzowPTAAAa_WKzAAA=/instances?startDateTime=2019-04-08T09:00:00.0000000&endDateTime=2019-04-30T09:00:00.0000000&$select=subject,bodyPreview,seriesMasterId,type,recurrence,start,end
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('bb8775a4-4d8c-42cf-a1d4-4d58c2bb668f')/events('AAMkAGUzYRgWAAA%3D')/instances(subject,bodyPreview,seriesMasterId,type,recurrence,start,end)",
"value": [
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sE1TatAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "Changing meeting from 4/15 to 4/16.",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "exception",
"recurrence": null,
"start": {
"dateTime": "2019-04-16T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-16T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1ru1JMcAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-08T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-08T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sa1do_AAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-22T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-22T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sw1n3PAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-29T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-29T21:00:00.0000000",
"timeZone": "UTC"
}
}
]
}