eventMessage の取得
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
eventMessage オブジェクトのプロパティとリレーションシップを取得します。
イベント ナビゲーション プロパティに $expand
パラメーターを適用して、出席者の予定表で関連付けられているイベントを取得します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
HTML 形式またはテキスト形式でイベント メッセージ本文を取得する
イベント メッセージ本文は、HTML 形式またはテキスト形式で指定できます。
Prefer: outlook.body-content-type
ヘッダーを使用して、本文で返される目的の形式を指定し、GET
要求で uniqueBody プロパティを指定できます。
-
Prefer: outlook.body-content-type="text"
を指定して、テキスト形式で返されるイベント メッセージ本文を取得します。 -
Prefer: outlook.body-content-type="html"
を指定するか、ヘッダーをスキップして、イベント メッセージ本文を HTML 形式で返します。
いずれかのヘッダーを指定すると、応答には対応する Preference-Applied
ヘッダーが確認として含まれます。
- テキスト形式要求の場合:
Preference-Applied: outlook.body-content-type="text"
- HTML 形式要求の場合:
Preference-Applied: outlook.body-content-type="html"
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | Mail.Read |
委任 (個人用 Microsoft アカウント) | Mail.Read |
アプリケーション | Mail.Read |
HTTP 要求
GET /me/messages/{id}
GET /users/{id | userPrincipalName}/messages/{id}
GET /me/mailFolders/{id}/messages/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。
要求ヘッダー
名前 | 種類 | 説明 |
---|---|---|
Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で eventMessage オブジェクトを返します。
例
例 1
要求
最初の例では、イベント メッセージ ID に基づいてイベント メッセージのプロパティを取得する方法を示します。
GET https://graph.microsoft.com/beta/me/messages/AAMkADYAAAImV_lAAA=
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('8fd6e83b-3cc0-4bf0-8b26-950f4d7110f6')/messages/$entity",
"@odata.type":"#microsoft.graph.eventMessageRequest",
"@odata.etag":"W/\"CwAAABYAAABXlB/SL0N4Q6g6o+jSYAEuAAAImkVD\"",
"id":"AAMkADYAAAImV_lAAA=",
"createdDateTime":"2017-12-27T21:58:36Z",
"lastModifiedDateTime":"2017-12-27T23:26:38Z",
"changeKey":"CwAAABYAAABXlB/SL0N4Q6g6o+jSYAEuAAAImkVD",
"categories":[
],
"receivedDateTime":"2017-12-27T21:58:36Z",
"sentDateTime":"2017-12-27T21:58:36Z",
"hasAttachments":false,
"internetMessageId":"<MWHPR1301MB2110DCFC@MWHPR1301MB2110.namprd13.prod.outlook.com>",
"subject":"Debrief from meetup",
"bodyPreview":"Let's debrief after community meetup.",
"importance":"normal",
"parentFolderId":"AQMkADYAAAIBDAAAAA==",
"conversationId":"AAQkADYCipTiRjXQORU=",
"conversationIndex":"AdN/Xdgnql4N9FlrT0KKlOJGNdA5FQ==",
"isDeliveryReceiptRequested":null,
"isReadReceiptRequested":false,
"isRead":false,
"isDraft":false,
"webLink":"https://outlook.office365.com/owa/?ItemID=AAMkADYAAAImV%2BlAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"inferenceClassification":"focused",
"unsubscribeData":[
],
"unsubscribeEnabled":false,
"meetingMessageType":"meetingRequest",
"type":"singleInstance",
"isOutOfDate":false,
"isAllDay":false,
"isDelegated":false,
"responseRequested":true,
"body":{
"contentType":"html",
"content":"<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<style type=\"text/css\" style=\"display:none\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" dir=\"ltr\" style=\"font-size:12pt; color:#000000; font-family:Calibri,Helvetica,sans-serif\">\r\n<p style=\"margin-top:0; margin-bottom:0\">Let's debrief after community meetup.<br>\r\n</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
},
"sender":{
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
"from":{
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
"toRecipients":[
{
"emailAddress":{
"name":"Alex Wilber",
"address":"AlexW@contoso.com"
}
}
],
"ccRecipients":[
],
"bccRecipients":[
],
"replyTo":[
],
"mentionsPreview":null,
"flag":{
"flagStatus":"notFlagged"
},
"startDateTime":{
"dateTime":"2018-02-19T19:00:00.0000000",
"timeZone":"UTC"
},
"endDateTime":{
"dateTime":"2018-02-19T19:30:00.0000000",
"timeZone":"UTC"
},
"location":{
"displayName":"Mt. Hood",
"locationType":"default",
"uniqueIdType":"unknown"
},
"recurrence":null,
"previousLocation":null,
"previousStartDateTime":null,
"previousEndDateTime":null
}
例 2
要求
2 番目の例では、イベント メッセージに関連付けられているイベントを取得する方法を示します。 イベント メッセージ ID を使用してイベントのメッセージを取得し、イベント メッセージ上に明示的にキャストを提供してその event ナビゲーション プロパティにアクセスし、$expand パラメーターを適用してそのイベントのプロパティを取得します。
GET https://graph.microsoft.com/beta/me/messages/AAMkADYAAAImV_jAAA=/?$expand=microsoft.graph.eventMessage/event
応答
次の例は応答を示しています。 関連付けられているイベントのプロパティは、応答で返されます。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('8fd6e83b-3cc0-4bf0-8b26-950f4d7110f6')/messages/$entity",
"@odata.type":"#microsoft.graph.eventMessageRequest",
"@odata.etag":"W/\"CwAAABYAAABXlB/SL0N4Q6g6o+jSYAEuAAAImkVF\"",
"id":"AAMkADYAAAImV_jAAA=",
"createdDateTime":"2017-12-27T21:54:55Z",
"lastModifiedDateTime":"2017-12-27T23:26:38Z",
"changeKey":"CwAAABYAAABXlB/SL0N4Q6g6o+jSYAEuAAAImkVF",
"categories":[
],
"receivedDateTime":"2017-12-27T21:54:55Z",
"sentDateTime":"2017-12-27T21:54:54Z",
"hasAttachments":false,
"internetMessageId":"<MWHPR1301MB211042CFBF@MWHPR1301MB2110.namprd13.prod.outlook.com>",
"subject":"Kick off planning",
"bodyPreview":"Let's collect opinions from our teams and organize action items.",
"importance":"normal",
"parentFolderId":"AQMkADYAS4AAAIBDAAAAA==",
"conversationId":"AAQkADYRuffB3wDlPn-ReFZarI60=",
"conversationIndex":"AdN/XVP4JG598HfAOU+f9F4VlqsjrQ==",
"isDeliveryReceiptRequested":null,
"isReadReceiptRequested":false,
"isRead":false,
"isDraft":false,
"webLink":"https://outlook.office365.com/owa/?ItemID=AAMkADYAAAImV%2BjAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"inferenceClassification":"focused",
"unsubscribeData":[
],
"unsubscribeEnabled":false,
"meetingMessageType":"meetingRequest",
"type":"singleInstance",
"isOutOfDate":false,
"isAllDay":false,
"isDelegated":false,
"responseRequested":true,
"body":{
"contentType":"html",
"content":"<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<style type=\"text/css\" style=\"display:none\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" dir=\"ltr\" style=\"font-size:12pt; color:#000000; font-family:Calibri,Helvetica,sans-serif\">\r\n<p style=\"margin-top:0; margin-bottom:0\">Let's collect opinions from our teams and organize action items.<br>\r\n</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
},
"sender":{
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
"from":{
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
"toRecipients":[
{
"emailAddress":{
"name":"Alex Wilber",
"address":"AlexW@contoso.com"
}
}
],
"ccRecipients":[
],
"bccRecipients":[
],
"replyTo":[
],
"mentionsPreview":null,
"flag":{
"flagStatus":"notFlagged"
},
"startDateTime":{
"dateTime":"2018-02-02T22:00:00.0000000",
"timeZone":"UTC"
},
"endDateTime":{
"dateTime":"2018-02-02T23:00:00.0000000",
"timeZone":"UTC"
},
"location":{
"displayName":"Mt. Hood",
"locationType":"default",
"uniqueIdType":"unknown"
},
"recurrence":null,
"previousLocation":null,
"previousStartDateTime":null,
"previousEndDateTime":null,
"event":{
"@odata.etag":"W/\"V5Qf0i9DeEOoOqPo0mABLgAACJpBWg==\"",
"id":"AAMkADYAAAImVu6AAA=",
"createdDateTime":"2017-12-27T21:54:55.2624551Z",
"lastModifiedDateTime":"2017-12-27T22:19:16.6667889Z",
"changeKey":"V5Qf0i9DeEOoOqPo0mABLgAACJpBWg==",
"categories":[
],
"originalStartTimeZone":"Pacific Standard Time",
"originalEndTimeZone":"Pacific Standard Time",
"uid":"040000008200E00074C5B7101A82E00800000000A2A6F3535D7FD3010000000000000000100000003D770E2E8974F44B9471BDB348097FE3",
"reminderMinutesBeforeStart":15,
"isReminderOn":true,
"hasAttachments":false,
"subject":"Kick off planning",
"bodyPreview":"Let's collect opinions from our teams and organize action items.",
"importance":"normal",
"sensitivity":"normal",
"isAllDay":false,
"isCancelled":false,
"isOrganizer":false,
"responseRequested":true,
"seriesMasterId":null,
"showAs":"tentative",
"type":"singleInstance",
"webLink":"https://outlook.office365.com/owa/?itemid=AAMkADYAAAImVu6AAA%3D&exvsurl=1&path=/calendar/item",
"onlineMeetingUrl":null,
"responseStatus":{
"response":"tentativelyAccepted",
"time":"2017-12-27T22:19:12.6197462Z"
},
"body":{
"contentType":"html",
"content":"<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<style type=\"text/css\" style=\"display:none\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" dir=\"ltr\" style=\"font-size:12pt; color:#000000; font-family:Calibri,Helvetica,sans-serif\">\r\n<p style=\"margin-top:0; margin-bottom:0\">Let's collect opinions from our teams and organize action items.<br>\r\n</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
},
"start":{
"dateTime":"2018-02-02T22:00:00.0000000",
"timeZone":"UTC"
},
"end":{
"dateTime":"2018-02-02T23:00:00.0000000",
"timeZone":"UTC"
},
"location":{
"displayName":"Mt. Hood",
"locationType":"default",
"uniqueId":"Mt. Hood",
"uniqueIdType":"private"
},
"locations":[
{
"displayName":"Mt. Hood",
"locationType":"default",
"uniqueId":"Mt. Hood",
"uniqueIdType":"private"
}
],
"recurrence":null,
"attendees":[
{
"type":"required",
"status":{
"response":"none",
"time":"0001-01-01T00:00:00Z"
},
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
{
"type":"required",
"status":{
"response":"tentativelyAccepted",
"time":"0001-01-01T00:00:00Z"
},
"emailAddress":{
"name":"Alex Wilber",
"address":"AlexW@contoso.com"
}
}
],
"organizer":{
"emailAddress":{
"name":"Administrator",
"address":"admin@contoso.com"
}
},
"OnlineMeeting":null
}
}