Share via


Outlook 予定表 REST API のリファレンス (バージョン 1.0)

適用対象: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

注意

Outlook REST API のバージョン 1.0 は廃止されます。 ** 2018 年 11 月 1 日** 以降、アプリは v1.0 REST エンドポイントで基本認証を使用することができなくなります。 2019 年 11 月 1 日までに、v1.0 REST エンドポイントは完全に使用停止になり、v1.0 のドキュメントはその後間もなく削除されます。 Microsoft Graph の v1.0 で Outlook REST API を使用するように、アプリの移行を始めてください。 詳細については、このお知らせをご覧ください。

予定表 API は、Office 365 の Azure Active Directory によって保護されているイベント、予定表、および予定表グループ データへのアクセス、および特にこれらのドメイン内の Microsoft アカウントの類似したデータへのアクセスを提供します。Hotmail.com、Live.com、MSN.com、Outlook.com、および Passport.com。

注意

  • 例外は、会議の日時を検索する API です。これは Microsoft アカウントではなく、Office 365 のメールボックス (Azure AD 上) にのみ適用されます。
  • リファレンスをわかりやすくするため、この記事の残りの部分では Outlook.com を、これら Microsoft のアカウント ドメインを含むものとして使用しています。

API v1.0 が不要な場合 左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、使用したいバージョンを選択します。

すべての予定表 API の操作

イベント操作

イベントはユーザーの予定表にある予定または会議を表します。イベントには、シリーズ マスター (定期的なイベントの場合)、発生、単一インスタンス、または例外を指定できます。

予定表の操作

予定表は、イベントのコンテナーの役割をします。ユーザーは複数の予定表を持つことができます。Office 365 では、各予定表は予定表グループに割り当てることができます。

予定表グループの操作

予定表グループは、複数の予定表を整理する方法です。ユーザーは、複数の予定表を Outlook または Outlook Web App 内の 1 つの予定表グループに追加できます。これにより、ユーザーはグループ内のすべての予定表を素早く簡単に表示できます。

注意

Outlook.com によってサポートされるのは、../me/calendars ショートカットでアクセス可能な既定の予定表グループのみです。 その予定表グループの削除、または別の予定表グループの作成はできません。

関連項目

予定表 REST API の使用

認証

他の Outlook REST API と同様に、予定表 API へのすべての要求に対して、有効なアクセス トークンを含める必要があります。 アクセス トークンを取得するには、アプリを登録して識別し、適切な承認を取得する必要があります。

効率化された登録と承認のオプションに関する詳細情報を参照してください。 予定表 API で特定の操作を続行する際には、この点に留意してください。

共有の予定表にアクセスするための範囲

Office 365 と Outlook.com の予定表は、共有をサポートします。予定表を作成したユーザーは、他のユーザーと予定表を共有できます。そのユーザーと共有されている予定表にアクセスするには次の範囲が必要です:

  • 読 み 取 り ア ク セ ス の 場合: https://outlook.office.com/calendars.read.shared
  • 読 み 取 り / 書 き 込 み ア ク セ ス の 場合: https://outlook.office.com/calendars.readwrite.shared

API のバージョン

予定表 REST API は、すべてのバージョンの Outlook REST API でサポートされています。機能は、特定のバージョンによって異なる場合があります。

ターゲット ユーザー

予定表 API 要求は、常に現在のユーザーのために実行されます。

Outlook REST API のすべてのサブセットに共通な情報について詳しくは、「Outlook REST API の使用」を参照してください。

イベントを取得する

イベント コレクションまたはイベントを取得します。

イベント本文は、テキストまたは HTML のいずれかにできます。現在、GET 操作によって返されるイベント本文は HTML 形式のみです。

予定表ビューを取得する

最低限必要なスコープ

以下のいずれか:

ユーザーの標準として設定されている予定表 (../me/calendarview) または別の予定表から、時間範囲で定義した予定表ビューのイベントの発生、例外、および単一インスタンスを取得します。

GET https://outlook.office.com/api/v1.0/me/calendarview?start={start_datetime}&end={end_datetime}
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID (特定の予定表から予定表ビューを取得している場合)。
start_datetime datetimeoffset イベントが開始する日時。
end_datetime datetimeoffset イベントが終了する日時。

注意

既定では、応答内の各イベントにそのプロパティがすべて含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。 パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

例として、各イベントの Subject プロパティのみを返す 10 月の月間予定表ビューを取得します:

GET https://outlook.office.com/api/v1.0/me/calendarview?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject

応答の種類

指定した時間範囲で展開されたイベント

シリーズ マスターと単一イベントを取得する

最低限必要なスコープ

以下のいずれか:

シリーズ マスターと単一インスタンス イベントのコレクションを、ユーザーの標準として設定されている予定表 (../me/events) または別の予定表から取得します。拡張イベントのインスタンスを取得するには、予定表ビューを取得する、またはイベントのインスタンスを取得することができます。

GET https://outlook.office.com/api/v1.0/me/events
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID (特定の予定表からイベントを取得している場合)。

注意

応答内の各イベントにそのプロパティがすべて含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。 次の例を参照してください。 パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

次の例は、$select を使用して、応答内で各イベントの SubjectOrganizerStart、および End プロパティのみを返すように指定する方法を示します。 $select を使用しない場合にイベントに返されるプロパティの完全な一覧については、「イベントを取得する (REST)」の最初の応答サンプルをご覧ください。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/events?$select=Subject,Organizer,Start,End

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWw==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyDAAA=",
            "Subject": "Scrum",
            "Start": "2015-11-02T17:00:00Z",
            "End": "2015-11-02T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWg==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyCAAA=",
            "Subject": "team lunch",
            "Start": "2015-11-02T00:00:00Z",
            "End": "2015-11-03T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
            "Subject": "Weekly Meeting on Contoso Project",
            "Start": "2014-10-13T21:00:00Z",
            "End": "2014-10-13T22:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG92AAA=",
            "Subject": "Daily Team Meeting",
            "Start": "2014-10-13T18:00:00Z",
            "End": "2014-10-13T18:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x47Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG91AAA=",
            "Subject": "Rob:Alex 1:1",
            "Start": "2014-10-15T16:30:00Z",
            "End": "2014-10-15T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG90AAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2015-11-26T00:00:00Z",
            "End": "2015-11-27T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9zAAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2014-11-27T00:00:00Z",
            "End": "2014-11-28T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=",
            "Subject": "New Year's Day Holiday",
            "Start": "2015-01-01T00:00:00Z",
            "End": "2015-01-02T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x45w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9xAAA=",
            "Subject": "Christmas Holiday",
            "Start": "2014-12-25T00:00:00Z",
            "End": "2014-12-26T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        }
    ]
}

イベント インスタンスを取得する

最低限必要なスコープ

以下のいずれか:

指定した時間範囲のイベントのインスタンス (発生) を取得できます。イベントが SeriesMaster タイプである場合、これは指定した時間範囲内のイベントの発生と例外を返します。

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。
start_datetime datetimeoffset イベントが開始する UTC 日時。
end_datetime datetimeoffset イベントが終了する UTC 日時。

応答の種類

要求されたイベント コレクション。

注意

既定では、応答内の各イベントにそのプロパティがすべて含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。 パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

たとえば、10 月の特定のイベントのインスタンスを取得します。これには、各インスタンスの SubjectStart、および End プロパティのみが含まれます。

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEAAA=/instances?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject,Start,End

イベントを取得する

最低限必要なスコープ

以下のいずれか:

ID でイベントを取得します。

GET https://outlook.office.com/api/v1.0/me/events/{event_id}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "DateTimeCreated": "2014-10-19T23:13:47.3959685Z",
    "DateTimeLastModified": "2014-10-23T20:23:47.0735997Z",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x49w==",
    "Categories": [],
    "StartTimeZone": "Pacific Standard Time",
    "EndTimeZone": "Pacific Standard Time",
    "ResponseStatus": {
        "Response": "Organizer",
        "Time": "0001-01-01T00:00:00Z"
    },
    "iCalUId": "040000008200E00074C5B7101A82E0080000000005F3F755F2EBCF010000000000000000100000007547017C91509D42A5B60C97141AA3DD",
    "Reminder": 15,
    "HasAttachments": false,
    "Subject": "Weekly Meeting on Contoso Project",
    "Body": {
        "ContentType": "HTML",
        "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nSetting up some time to review the budget and planning on the Contoso Project\r\n</body>\r\n</html>\r\n"
    },
    "BodyPreview": "Setting up some time to review the budget and planning on the Contoso Project",
    "Importance": "Normal",
    "Sensitivity": "Normal",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Location": {
        "DisplayName": "Alex's Office"
    },
    "IsAllDay": false,
    "IsCancelled": false,
    "IsOrganizer": true,
    "Recurrence": {
        "Pattern": {
            "Type": "Weekly",
            "Interval": 1,
            "Month": 0,
            "DayOfMonth": 0,
            "DaysOfWeek": [
                "Monday"
            ],
            "FirstDayOfWeek": "Sunday",
            "Index": "First"
        },
        "Range": {
            "Type": "NoEnd",
            "StartDate": "2014-10-13T00:00:00-07:00",
            "EndDate": "0001-01-01T00:00:00Z",
            "NumberOfOccurrences": 0
        }
    },
    "ResponseRequested": true,
    "SeriesMasterId": null,
    "ShowAs": "Busy",
    "Type": "SeriesMaster",
    "Attendees": [
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Janet Schorr",
                "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
            }
        },
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Pavel Bansky",
                "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
            }
        }
    ],
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }

応答の種類

要求されたイベント

注意

既定では、応答にはイベントのすべてのプロパティが含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。 パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

次の例は、$select を使用して、イベントの SubjectOrganizerStart、および End プロパティのみを返すように指定する方法を示しています。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=?$select=Subject,Organizer,Start,End

応答のサンプル

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "Subject": "Weekly Meeting on Contoso Project",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }
}

同期イベント

最低限必要なスコープ

以下のいずれか:

ユーザーの標準として設定されている予定表 (../me/calendarview) または別の予定表から、指定した時間範囲の新規、更新済み、または削除済みのイベントを同期して取得します。このような一連の時間範囲内のイベントは予定表ビューとも呼ばれます。返されるイベントには、定期的なアイテムの発生と例外、および単一のインスタンスが含まれている場合があります。

予定表ビューの同期には、通常、それぞれが GET 呼び出しである 2 つ以上の同期要求のラウンドが必要です。予定表ビューを同期するには、予定表ビューを取得する場合とほぼ同じ方法で GET メソッドを使用します。ただし、特定の要求ヘッダー、および必要に応じて deltaToken または skipToken を含める必要があります。

要求ヘッダー

  • 以前の同期要求から返される skipToken を含む同期要求を除き、すべての同期要求で "Prefer: odata.track-changes" ヘッダーを指定する必要があります。最初の応答で Preference-Applied: odata.track-changes ヘッダーを探して、リソースが同期をサポートすることを確認してから、先に進みます。(skipToken に関する詳細については、以下のサンプルの 2 番目の応答データを参照)。

  • "Prefer: odata.maxpagesize={x}" ヘッダーを指定して、同期要求が返すイベントの最大数を示すことができます。

予定表ビューのイベント同期の一般的なラウンドは次のとおりです。

  1. 必須の Prefer: odata.track-changes ヘッダーを指定して最初の GET 要求を行います。同期要求に対する最初の応答では、常に deltaToken が返されます。(2 番目以降の GET 要求は、前の応答で受信した deltaToken または skipToken のいずれかを含むため、最初の GET 要求とは異なります。)

  2. 最初の応答が Preference-Applied: odata.track-changes ヘッダーを返した場合は、同期を進めることができます。

    • 2 番目 GET 要求を行います。最初の GET 要求から返された Prefer: odata.track-changes ヘッダーと deltaToken を指定して、追加のイベントがあるかどうかを調べます。2 番目の要求では、追加のイベントと、skipToken (さらにイベントがある場合) と deltaToken (最後のイベントが同期された場合。この場合は停止できます) のどちらか一方が返されます。

    • 前の呼び出しから返された skipToken を指定して GET 呼び出しを送信することで、同期を続けます。@odata.deltaLink ヘッダーと再び deltaToken (同期が完了したことを示します) が含まれる最後の応答を受け取ると、停止します。

同期のラウンドにおける最初とそれ以降の呼び出しの構文を見てみましょう。

既定の予定表で同期するには

最初の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

2 番目の要求、またはそれ以降のラウンドの最初の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

同じラウンドの 3 番目またはそれ以降の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

特定の予定表で同期するには

最初の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

2 番目の要求、またはそれ以降のラウンドの最初の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

同じラウンドの 3 番目またはそれ以降の要求:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

パラメーター

パラメーター 説明
URL パ ラ メ ー タ
user_context 文字列 ユーザー コンテキスト。現在のユーザーのコンテキストを示すには、値 "me" を使用できます。また、users/{upn} の形式も使用できます。upn はユーザー プリンシパル名であり、通常はユーザーの電子メール アドレスです。
calendar_id 文字列 予定表 ID (特定の予定表から予定表ビューを取得している場合)。
start_datetime datetimeoffset イベントが開始する日時。
end_datetime datetimeoffset イベントが終了する日時。
delta_token 文字列 以前の同期の応答で、@odata.deltaLink の値の一部として返される deltaToken 文字列。
skip_token 文字列 以前の同期の応答で、@odata.nextLink の値の一部として返される skipToken 文字列。

注意

  • 最初の要求で "Prefer: odata.track-changes" を指定する際に、応答が同期をサポートしている場合は、応答のヘッダーに "Preference-applied: odata.track-changes" が含まれます。
  • サポートされていないリソースを同期しようとするか、またはこれが最初の同期要求でない場合は、応答のヘッダーに "Preference-applied" は表示されません。
  • クエリ パラメーター startdatetime と enddatetime を変更することで、変更タイム ウィンドウを変更できます。
  • 応答内の各イベントにそのプロパティがすべて含まれます。
  • 定期的なアイテムの場合、同期応答には、定期的なマスターおよび例外イベントのイベント全体が返されます。
  • 定期的なアイテムのインスタンスは省略されて、Start および End のプロパティのみが含まれます。残りの発生イベント情報は定期的なマスター イベントから取得できます。参照情報については、「イベント リソース」をご覧ください。
  • $filter$count$select$skip$top、および $search クエリ パラメーターは使用できません。

応答の種類

指定した時間範囲の展開されたイベントと省略されたイベント。

ユーザーの既定の予定表を同期する最初と 2 番目の同期要求の例を次に示します。各要求では、一度に 1 つの完全なイベントのみを返すように指定されています。

  • 最初の応答は、1 つのイベント、deltaLink および deltaToken を返します。
  • 2 番目の要求では、その deltatoken を使用します。2 番目の応答は、1 つのイベント、nextLink および skipToken を返します。

同期を完了するには、同期応答が deltaLinkdeltaToken を返すまで、以前の同期要求から返された skipToken を使用します。この場合、このラウンドの同期は完了します。次のラウンドの同期のために deltaToken を保存します。

詳細については、「Outlook 予定表ビューでイベントを同期する」を参照してください。

最初の要求のサンプル

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z HTTP/1.1
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

最初の応答データのサンプル

Preference-Applied: odata.track-changes

    {
        "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView",
        "value": [
            {
                "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('asdas==')",
                "@odata.etag": "W/\"L8Z+4Y4u7k+97uRKg==\"",
                "Id": "AQMkANJAAAAA==",
                "ChangeKey": "L8Z+AAAAARKg==",
                "Categories": [
                ],
                "DateTimeCreated": "2015-04-10T17:54:49.2725912Z",
                "DateTimeLastModified": "2015-04-10T17:54:49.3038538Z",
                "Subject": "Discuss the Calendar REST API",
                "BodyPreview": "I think it will meet our requirements!",
                "Body": {
                    "ContentType": "HTML",
                    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
                },
                "Importance": "Normal",
                "HasAttachments": false,
                "Start": "2015-04-05T18:00:00Z",
                "StartTimeZone": "Pacific Standard Time",
                "End": "2015-04-05T19:00:00Z",
                "EndTimeZone": "Pacific Standard Time",
                "Reminder": 15,
                "Location": {
                    "DisplayName": "",
                    "Address": null
                },
                "ResponseStatus": {
                    "Response": "Organizer",
                    "Time": "0001-01-01T00:00:00Z"
                },
                "ShowAs": "Busy",
                "IsAllDay": false,
                "IsCancelled": false,
                "IsOrganizer": true,
                "ResponseRequested": true,
                "Type": "SingleInstance",
                "SeriesMasterId": null,
                "Attendees": [
                ],
                "Recurrence": null,
                "Organizer": {
                    "EmailAddress": {
                        "Address": "user0@contoso.com",
                        "Name": "user0"
                    }
                },
                "iCalUId": "040000008200E9888E07599CCFA23",
                "WebLink": "https://outlook.office.com/owa/?ItemID=AAAINJAAAAA%3D%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
            }
        ],
        "@odata.deltaLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-04-10T00%3a00%3a00Z&%24deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c"
    }

2 番目の要求のサンプル

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z&$deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

2 番目の応答データのサンプル

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('AAMkAD0jAAA=')",
            "@odata.etag": "W/\"P2fd7QAAAAAVFA==\"",
            "Id": "AAMkADNkNmVlOTITVAAAAAA0jAAA=",
            "ChangeKey": "P2fdmIU1QAAAAAVFA==",
            "Categories": [
            ],
            "DateTimeCreated": "2015-04-15T18:59:11.0226221Z",
            "DateTimeLastModified": "2015-04-15T18:59:11.0694979Z",
            "Subject": "1 hour",
            "BodyPreview": "\u200b",
            "Body": {
                "ContentType": "HTML",
                "Content": "<html><body>content</body></html>"
            },
            "Importance": "Normal",
            "HasAttachments": false,
            "Start": "2015-04-16T18:00:00Z",
            "StartTimeZone": "Pacific Standard Time",
            "End": "2015-04-16T19:00:00Z",
            "EndTimeZone": "Pacific Standard Time",
            "Reminder": 15,
            "Location": {
                "DisplayName": "",
                "Address": {
                    "Street": "",
                    "City": "",
                    "State": "",
                    "CountryOrRegion": "",
                    "PostalCode": ""
                }
            },
            "ResponseStatus": {
                "Response": "Organizer",
                "Time": "0001-01-01T00:00:00Z"
            },
            "ShowAs": "Busy",
            "IsAllDay": false,
            "IsCancelled": false,
            "IsOrganizer": true,
            "ResponseRequested": true,
            "Type": "SingleInstance",
            "SeriesMasterId": null,
            "Attendees": [
            ],
            "Recurrence": null,
            "Organizer": {
                "EmailAddress": {
                    "Address": "user0@contoso.com",
                    "Name": "user0"
                }
            },
            "iCalUId": "040000008200E09BB89A316862",
            "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADNkNmVlOAA%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
        }
    ],
    "@odata.nextLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-08-10T00%3a00%3a00Z&%24skipToken=530c9d02ae1a4d96804538bd4d381546"
}

会議の日時を検索する

この機能は現在、バージョン 2.0ベータ版で使用できます。

会議室を取得する (プレビュー)

この機能は現在、ベータ版でのみ使用可能です。

イベントを作成する

予定表イベントを作成する

最低限必要なスコープ

以下のいずれか:

予定表の events エンドポイントに投稿することによって、ユーザーの標準として設定されている予定表または特定の予定表にイベントを作成します。 イベントが作成されると、サーバーはすべての出席者に招待状を送信します。

既定では、StartEnd の時刻値は UTC になります。 StartEnd のタイム ゾーンを指定し、対応するタイム ゾーンの時刻を表現して、UTC の時間オフセットを含めることができます。

以下の例は、太平洋標準時の時刻値を割り当てる方法を示します。 1 つのタイム ゾーンを指定する場合は、その他のタイム ゾーンに対しても値を指定する必要があることに注意してください。

POST https://outlook.office.com/api/v1.0/me/events
POST https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/events
Content-Type: application/json
{
  "Subject": "Discuss the Calendar REST API",
  "Body": {
    "ContentType": "HTML",
    "Content": "I think it will meet our requirements!"
  },
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Type": "Required"
    }
  ]
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1RAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:56:10.1058291Z",
  "DateTimeLastModified": "2014-01-22T20:56:10.3402186Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": ""
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Status": {
        "Response": "None",
        "Time": "0001-01-01T00:00:00Z"
      },
      "Type": "Required"
    }
  ],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

応答の種類

新しいイベント

既定では、応答に新しいイベントのすべてのプロパティが含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。

以下は、応答内の新しいイベントの StartEnd プロパティのみを含める例です。

POST https://outlook.office.com/api/v1.0/me/events?$Select=Start,End

イベントを更新する

予定表イベントを更新する

最低限必要なスコープ

以下のいずれか:

イベントを変更します。指定したプロパティのみが変更されます。ユーザーが開催者である場合、サーバーはすべての出席者に会議の更新を送信します。

PATCH https://outlook.office.com/api/v1.0/me/events/{event_id}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。

要求本文に任意の書き込み可能な event プロパティを指定します。

要求のサンプル

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=
Content-Type: application/json
{
  "Location": {
    "DisplayName": "Your office"
  }
}

応答のサンプル

状態コード: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:49:05.5657528Z",
  "DateTimeLastModified": "2014-01-22T21:14:17.4886416Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": "Your office"
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

応答の種類

更新されたイベント。ユーザーが開催者である場合、サーバーはすべての出席者に会議の更新を送信します。

既定では、応答には更新されたイベントのすべてのプロパティが含まれます。 最適なパフォーマンスを得るためには、$select を使用して必要なプロパティのみを指定します。 Id プロパティは常に返されます。

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE1MFKPQWAAA=?$select=Location

イベントに応答する

イベントを承諾する

最低限必要なスコープ

以下のいずれか:

指定したイベントを承諾します。

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/accept
パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。必須です。
本文パラメータ
コメント 文字列 応答に含まれるテキスト。省略可。
SendResponse ブール値 true UNTRANSLATED_CONTENT_START if a response is to be sent to the organizer; otherwise, false. Optional. Default is true. UNTRANSLATED_CONTENT_END

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/accept

Content-Type: application/json

{
  "Comment": "Great idea!",
  "SendResponse": "true"
}

応答

成功した応答は、HTTP 202 承認済みの応答コードで示されます。

イベントを仮承諾する

最低限必要なスコープ

以下のいずれか:

指定したイベントを仮承諾します。

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/tentativelyaccept
パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。必須です。
本文パラメータ
コメント 文字列 応答に含まれるテキスト。省略可。
SendResponse ブール値 true UNTRANSLATED_CONTENT_START if a response is to be sent to the organizer; otherwise, false. Optional. Default is true. UNTRANSLATED_CONTENT_END

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/tentativelyaccept

Content-Type: application/json

{
  "Comment": "I'll confirm later!",
  "SendResponse": "true"
}

応答

成功した応答は、HTTP 202 承認済みの応答コードで示されます。

イベントを辞退する

最低限必要なスコープ

以下のいずれか:

指定したイベントへの招待を辞退します。

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/decline
パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。必須です。
本文パラメータ
コメント 文字列 応答に含まれるテキスト。省略可。
SendResponse ブール値 true UNTRANSLATED_CONTENT_START if a response is to be sent to the organizer; otherwise, false. Optional. Default is true. UNTRANSLATED_CONTENT_END

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/decline

Content-Type: application/json

{
  "Comment": "Sorry, maybe next time!",
  "SendResponse": "true"
}

応答

成功した応答は、HTTP 202 承認済みの応答コードで示されます。

イベントを転送する (プレビュー)

この機能は現在、ベータ版でのみ使用可能です。

イベントを削除する

予定表イベントを削除する

最低限必要なスコープ

以下のいずれか:

イベントをサインインしているユーザーの削除済みアイテム フォルダーに移動します。イベントが会議であり、サインインしているユーザーが開催者である場合は、サーバーはすべての出席者にキャンセルを送信します。

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/events/AAMkAGE0M4v1OAAA=

応答のサンプル

Status code: 204 

イベントをキャンセルする (プレビュー)

この機能は現在、ベータ版でのみ使用可能です。

添付ファイルを取得する

添付ファイルのコレクションまたは添付ファイルを取得できます。

添付ファイルのコレクションを取得する

最低限必要なスコープ

以下のいずれか:

特定のイベントから添付ファイルを取得します。

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。

応答の種類

FileAttachment または ItemAttachment の種類を使用できる添付ファイル コレクション。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments",
    "value": [
        {
            "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2NGTG9yAAA=')/Attachments('AAMkAGI2NGLwydGuOzcHf1FBlo=')",
            "Id": "AAMkAGI2NGLwydGuOzcHf1FBlo=",
            "DateTimeLastModified": "2014-10-22T00:30:26Z",
            "Name": "Company Party.docx",
            "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "Size": 11647,
            "IsInline": false,
            "ContentId": null,
            "ContentLocation": null,
            "ContentBytes": "UEsDBBQABgAIAAAAIQDfpNJs...AAF4pAAAAAA=="
            "IsContactPhoto": false
        }
    ]
}

添付ファイルを取得する

最低限必要なスコープ

以下のいずれか:

特定のイベントから添付ファイルを取得します。

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。
attachment_id 文字列 添付ファイル ID。

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

応答の種類

要求された添付ファイルまたはアイテムの添付ファイル

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments/$entity",
    "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2WRAAADTG9yAAA=')/Attachments('AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=')",
    "Id": "AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo="
    "DateTimeLastModified": "2014-10-22T00:30:26Z",
    "Name": "Company Party.docx",
    "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "Size": 11647,
    "IsInline": false,
    "ContentId": null,
    "ContentLocation": null,
    "ContentBytes": "UEsDBBQABgAIAAAAIQD...AAF4pAAAAAA==",
    "IsContactPhoto": false
}

添付ファイルを作成する

イベントの添付ファイルまたはアイテムの添付ファイルを作成できます。

添付ファイルを作成する

最低限必要なスコープ

以下のいずれか:

イベントに添付ファイルを追加します。

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。
本文パラメータ
@odata.type 文字列 #Microsoft.OutlookServices.FileAttachment
名前 文字列 添付ファイルの名前。
ContentBytes バイナリ 添付するファイル。

応答の種類

新しい添付ファイル

アイテムの添付ファイルを作成する

最低限必要なスコープ

以下のいずれか:

イベントにアイテムの添付ファイルを追加します。

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。
本文パラメータ
@odata.type 文字列 #Microsoft.OutlookServices.ItemAttachment
名前 文字列 添付ファイルの名前。
アイテム MessageEvent、または Contact エンティティ。 添付するアイテム。

応答の種類

新しいアイテムの添付ファイル

参照添付ファイルを作成する

最低限必要なスコープ

https://outlook.office.com/calendars.readwrite

イベントに参照添付ファイルを追加します。

この機能は現在、ベータ版でのみ使用可能です。

添付ファイルを削除する

イベントの添付ファイルを削除する

最低限必要なスコープ

以下のいずれか:

イベントの指定した添付ファイルを削除します。添付ファイルは、添付ファイルまたはアイテムの添付ファイルにすることができます。

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}
必須パラメーター 説明
URL パ ラ メ ー タ
event_id 文字列 イベント ID。
attachment_id 文字列 添付ファイル ID。

要求のサンプル

DELETE https:/outlook.office.com/api/v1.0/me/events/AAMkAGE0MG4v1OAAA=/attachments/AAMkAGITG9yAAA=

応答のサンプル

Status code: 204

アラームを取得する

予定表から 2 つの日付と時刻の間のイベントのアラーム一覧を取得します。

最低限必要なスコープ

以下のいずれか:

この機能は現在、バージョン 2.0ベータ版で使用できます。

アラームを再通知する

アラームを再通知して、新しい時間までアラームを延期します。

最低限必要なスコープ

以下のいずれか:

この機能は現在、バージョン 2.0ベータ版で使用できます。

アラームを消す

トリガーされたアラームを消します。

最低限必要なスコープ

以下のいずれか:

この機能は現在、バージョン 2.0ベータ版で使用できます。

予定表を取得する

予定表のコレクションまたは予定表を取得できます。

予定表のコレクションを取得する

最低限必要なスコープ

以下のいずれか:

ユーザーのすべての予定表 (calendars) を取得するか、または特定の予定表グループの予定表を取得します。

GET https://outlook.office.com/api/v1.0/me/calendars
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

必須パラメーター 説明
URL パ ラ メ ー タ
calender_group_id 文字列 予定表グループ ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/calendars

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
            "Name": "Calendar",
            "Color": "Auto",
            "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
        }
    ]
}

応答の種類

要求された予定表のコレクション。

予定表を取得する

最低限必要なスコープ

以下のいずれか:

ID で予定表を取得します。../me/calendar エンドポイントを使用して、ユーザーの標準として設定されている予定表を取得できます。

GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/calendars/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=

応答のサンプル

状態コード: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
    "Name": "Calendar",
    "Color": "Auto",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
}

応答の種類

要求された予定表

予定表を作成する

予定表を作成する

最低限必要なスコープ

以下のいずれか:

ショートカットを使用して既定の予定表グループに予定表を作成するか、グループの calendars エンドポイントに投稿することによって特定の予定表グループに予定表を作成します。../me/calendars

POST https://outlook.office.com/api/v1.0/me/calendars
POST https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars
必須パラメーター 説明
URL パ ラ メ ー タ
calender_group_id 文字列 予定表グループ ID (特定のグループから予定表を取得している場合)。
本文パラメータ
名前 文字列 新しい予定表の名前。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/calendars
Content-Type: application/json
{
  "Name": "Social"
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLHAAA=",
  "Name": "Social",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ=="
}

応答の種類

新しい予定表

予定表を更新する

予定表を更新する

最低限必要なスコープ

以下のいずれか:

予定表の書き込み可能なプロパティを変更します。

PATCH https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID。
本文パラメータ
名前 文字列 予定表の新しい名前。

要求のサンプル

PATCH https://outlook.office.com/api/v1.0/me/calendars/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=
Content-Type: application/json
{
  "Name": "Social events"
}

応答のサンプル

状態コード: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=",
  "Name": "Social events",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw=="

応答の種類

更新された予定表

予定表を削除する

予定表を削除する

最低限必要なスコープ

以下のいずれか:

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_id 文字列 予定表 ID。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

応答のサンプル

Status code: 204

予定表グループを取得する

予定表グループのコレクションまたは予定表グループを取得できます。

注意

Outlook.com によってサポートされるのは、../me/calendars ショートカットでアクセス可能な既定の予定表グループのみです。

予定表グループのコレクションを取得する

最低限必要なスコープ

以下のいずれか:

メールボックス内の予定表グループを取得します。

GET https://outlook.office.com/api/v1.0/me/calendargroups

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/calendargroups

応答のサンプル

状態コード: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
      "Name": "My Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==",
      "ClassId": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuMAAA=",
      "Name": "Other Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==",
      "ClassId": "0006f0b8-0000-0000-c000-000000000046"
    }
  ]
}

応答の種類

要求された予定表グループのコレクション。

予定表グループを取得する

最低限必要なスコープ

以下のいずれか:

ID で予定表グループを取得します。

GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

注意

パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」をご覧ください。

必須パラメーター 説明
URL パ ラ メ ー タ
calendar_group_id 文字列 予定表グループ ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=

応答のサンプル

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
    "Name": "My Calendars",
    "ClassId": "0006f0b7-0000-0000-c000-000000000046",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g=="
}

応答の種類

要求された予定表グループ

予定表グループを作成する

予定表グループを作成します。Name は、予定表グループの唯一の書き込み可能なプロパティです。

注意

Outlook.com によってサポートされるのは、../me/calendars ショートカットでアクセス可能な既定の予定表グループのみです。 Outlook.com で別の予定表グループを作成することはできません。

予定表グループを作成する

最低限必要なスコープ

以下のいずれか:

POST https://outlook.office.com/api/v1.0/me/calendargroups
必須パラメーター 説明
URL パラメータ
本文パラメータ
名前 文字列 予定表グループの名前。
POST https://outlook.office.com/api/v1.0/me/calendargroups
Content-Type: application/json
{
  "Name": "Birthdays"
}

応答のサンプル

状態コード :201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Birthdays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

応答の種類

新しい予定表グループ

予定表グループを更新する

予定表グループを更新する

最低限必要なスコープ

以下のいずれか:

予定表グループの名前を変更します。Name は、唯一の書き込み可能な予定表グループのプロパティです。

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_group_id 文字列 予定表グループ ID。
本文パラメータ
名前 文字列 更新された予定表グループの名前。
PATCH https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=
{
  "Name": "Holidays"
}

応答のサンプル

状態コード: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Holidays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

応答の種類

更新された予定表グループ

予定表グループを削除する

注意

Outlook.com によってサポートされるのは、../me/calendars ショートカットでアクセス可能な既定の予定表グループのみです。 この予定表グループは削除しないでください。

予定表グループを削除する

最低限必要なスコープ

以下のいずれか:

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}
必須パラメーター 説明
URL パ ラ メ ー タ
calendar_group_id 文字列 予定表グループ ID。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM4xLGAAA=

応答のサンプル

Status code: 204

次の手順

アプリケーション開発を開始する準備ができている方にも、単に詳しい情報を必要としている方にも、最適なコンテンツをご用意しています。

Office 365 プラットフォームの使い方の詳細については、次のリンク先をご覧ください。