POST/users/{userId}/calendars/{calendarId}/events
指定カレンダーに予定を登録する。
Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token
calendar
Parameter | Type | Description |
---|---|---|
userId | string | ユーザーを特定するID (URLエンコードする)
required example : userf7da-f82c-4284-13e7-030f3b4c756x |
calendarId | string | カレンダーID required example : calendar-96b8-4c74-8277-7953e0b4604a |
Header | type | Description |
---|---|---|
Authorization | string | Bearer {token} required |
Content-Type | string | application/json required example : application/json |
予定および繰返し/繰返し例外予定を配列で入力する。
配列の要素はすべて同じeventIdで入力。
Property | Type | Description |
---|---|---|
eventComponents | array (Event) | 配列の要素はすべて同じeventIdで入力。 |
Property | Type | Description |
---|---|---|
eventId | string | 予定ID minLength : 1 maxLength : 255 |
summary | string | 予定の内容 required |
description | string | 予定のメモ minLength : 0 maxLength : 5000 |
location | string | 予定の場所 |
map | object (map) | 地図情報 |
mapUrl | object (mapUrl) | 地図URL |
categoryId | string | 予定のカテゴリーID |
organizer | object (organizer) | 主催者
|
start | object (start) | 予定の開始または終了日時 required |
end | object (end) | 予定の開始または終了日時 |
recurrence | array (Recurrence) | 繰返し情報 minItems : 0 maxItems : 100 |
recurringEventId | string | |
transparency | string | 表示方法
default : OPAQUE Allowed values : OPAQUE, TRANSPARENT |
visibility | string | 公開/非公開
default : PUBLIC Allowed values : PUBLIC, PRIVATE |
sequence | integer | default : 0 minimum : 0 format : int32 |
attendees | array (Attendee) | 参加者リスト minItems : 0 maxItems : 500 |
videoMeeting | object (videoMeeting) | ビデオ通話ミーティング |
reminders | array (Alarm) | 通知情報 minItems : 0 maxItems : 100 |
Property | Type | Description |
---|---|---|
type | string | 地図タイプ(googleなど) |
geo | string | 経緯度 |
Property | Type | Description |
---|---|---|
mapUrl | string | 地図のURL |
imageId | string | 地図の画像ID |
Property | Type | Description |
---|---|---|
string | 主催者のメールアドレス required | |
displayName | string | 主催者名 |
Property | Type | Description |
---|---|---|
date | string | 終日予定の場合の日付 (YYYY-MM-DD) |
dateTime | string | 時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string | 時間予定(dateTime)の場合のタイムゾーン |
Property | Type | Description |
---|---|---|
date | string | 終日予定の場合の日付 (YYYY-MM-DD) |
dateTime | string | 時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string | 時間予定(dateTime)の場合のタイムゾーン |
Property | Type | Description |
---|---|---|
Recurrence | string | 繰返し予定のルールを設定
|
Property | Type | Description |
---|---|---|
id | string | 設備ID
|
string | 参加者メールアドレス | |
displayName | string | 参加者または設備名 |
partstat | string | 予定招待への回答
Allowed values : NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE |
isResource | boolean | 設備フラグ default : false |
isExternalResource | boolean | 外部設備フラグ default : false |
isOptional | boolean | 任意参加フラグ default : false |
Property | Type | Description |
---|
Property | Type | Description |
---|---|---|
method | string | 通知方法
required Allowed values : DISPLAY, EMAIL |
trigger | string | 予定開始前の通知タイミング。 |
triggerDateTime | object (triggerDateTime) | 時間情報 |
Property | Type | Description |
---|---|---|
dateTime | string | 日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string |
example
1{
2 "eventComponents": [
3 {
4 "eventId": "eventr8123-wehuh324-qwejqw123",
5 "summary": "Meeting",
6 "description": "Memo",
7 "location": "CUNY Graduate Center",
8 "map": {
9 "type": "google",
10 "geo": "40.7486484;-73.98400699999999"
11 },
12 "mapUrl": {
13 "mapUrl": "https://mapUrl.googlemap.com",
14 "imageId": "imageId123"
15 },
16 "categoryId": "1",
17 "organizer": {
18 "email": "user1@example.com",
19 "displayName": "ワークス 太郎"
20 },
21 "start": {
22 "dateTime": "2021-12-13T14:00:00",
23 "timeZone": "Asia/Tokyo"
24 },
25 "end": {
26 "dateTime": "2021-12-13T15:00:00",
27 "timeZone": "Asia/Tokyo"
28 },
29 "recurrence": [
30 "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=SU",
31 "EXDATE;TZID=Asia/Tokyo:20211213T140000"
32 ],
33 "recurringEventId": "TZID=Asia/Tokyo:20211213T140000",
34 "transparency": "OPAQUE",
35 "visibility": "PUBLIC",
36 "sequence": 1,
37 "attendees": [
38 {
39 "email": "attendee1@example.com",
40 "displayName": "user1",
41 "partstat": "NEEDS-ACTION",
42 "isExternalResouce": false,
43 "isOptional": false,
44 "isResource": false
45 },
46 {
47 "email": "attendee2@example.com",
48 "displayName": "user2",
49 "partstat": "ACCEPTED",
50 "isExternalResouce": false,
51 "isOptional": true,
52 "isResource": false
53 },
54 {
55 "id": "10000355/10029600@97d9ddb4-ae93-4469-8471-110c573d13z1",
56 "partstat": "ACCEPTED",
57 "resourceValue": "https://calendar.worksmobile.com/resources/resource/10000355/10029600@97d9ddb4-ae93-4469-8471-110c573d13z1",
58 "isExternalResouce": false,
59 "isOptional": false,
60 "isResource": true
61 },
62 {
63 "email": "attendee3@example.com",
64 "displayName": "user3",
65 "partstat": "DECLINED",
66 "isExternalResouce": false,
67 "isOptional": false,
68 "isResource": false
69 }
70 ],
71 "videoMeeting": {
72 "url": "https://works.do/x4gOs1_call",
73 "resourceId": "x4gOs1_call"
74 },
75 "reminders": [
76 {
77 "method": "DISPLAY",
78 "trigger": "-PT10M"
79 },
80 {
81 "method": "EMAIL",
82 "triggerDateTime": {
83 "dateTime": "2021-12-13T10:00:00",
84 "timeZone": "Asia/Tokyo"
85 }
86 }
87 ]
88 }
89 ]
90}
OK
Property | Type | Description |
---|---|---|
eventComponents | array (Event) | 予定情報 |
Property | Type | Description |
---|---|---|
eventId | string | 予定ID required minLength : 1 maxLength : 255 |
createdTime | object (createdTime) | 時間情報 readOnly : true |
updatedTime | object (updatedTime) | 時間情報 readOnly : true |
summary | string | 予定の内容 required minLength : 0 maxLength : 200 |
description | string | 予定のメモ minLength : 0 maxLength : 5000 |
location | string | 予定の場所 minLength : 0 maxLength : 100 |
map | object (map) | 地図情報 |
mapUrl | object (mapUrl) | 地図URL |
categoryId | string | 予定のカテゴリーID |
organizer | object (organizer) | 主催者
|
start | object (start) | 予定の開始または終了日時 required |
end | object (end) | 予定の開始または終了日時 |
recurrence | array (Recurrence) | 繰返し情報 minItems : 0 maxItems : 100 |
recurringEventId | string | |
transparency | string | 表示方法
default : OPAQUE Allowed values : OPAQUE, TRANSPARENT |
visibility | string | 公開/非公開
default : PUBLIC Allowed values : PUBLIC, PRIVATE |
sequence | integer | default : 0 minimum : 0 format : int32 |
attendees | array (Attendee) | 参加者リスト minItems : 0 maxItems : 500 |
videoMeeting | object (videoMeeting) | ビデオ通話ミーティング |
reminders | array (Alarm) | 通知情報 minItems : 0 maxItems : 100 |
attachments | array (File) | 添付ファイル(添付ファイルのサイズの合計が100MB以下) readOnly : true |
Property | Type | Description |
---|---|---|
dateTime | string | 日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string |
Property | Type | Description |
---|---|---|
dateTime | string | 日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string |
Property | Type | Description |
---|---|---|
type | string | 地図タイプ(googleなど) |
geo | string | 経緯度 |
Property | Type | Description |
---|---|---|
mapUrl | string | 地図のURL |
imageId | string | 地図の画像ID |
Property | Type | Description |
---|---|---|
string | 主催者のメールアドレス required | |
displayName | string | 主催者名 |
Property | Type | Description |
---|---|---|
date | string | 終日予定の場合の日付 (YYYY-MM-DD) |
dateTime | string | 時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string | 時間予定(dateTime)の場合のタイムゾーン |
Property | Type | Description |
---|---|---|
date | string | 終日予定の場合の日付 (YYYY-MM-DD) |
dateTime | string | 時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string | 時間予定(dateTime)の場合のタイムゾーン |
Property | Type | Description |
---|---|---|
Recurrence | string | 繰返し予定のルールを設定
|
Property | Type | Description |
---|---|---|
id | string | 設備ID
|
string | 参加者メールアドレス | |
displayName | string | 参加者または設備名 |
partstat | string | 予定招待への回答
Allowed values : NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE |
isResource | boolean | 設備フラグ default : false |
isExternalResource | boolean | 外部設備フラグ default : false |
isOptional | boolean | 任意参加フラグ default : false |
resourceValue | string | リソースの固有値
readOnly : true |
Property | Type | Description |
---|---|---|
url | string | ビデオ通話ミーティングURL readOnly : true |
resourceId | string | ビデオ通話ミーティングID readOnly : true |
Property | Type | Description |
---|---|---|
method | string | 通知方法
required Allowed values : DISPLAY, EMAIL |
trigger | string | 予定開始前の通知タイミング。 |
triggerDateTime | object (triggerDateTime) | 時間情報 |
Property | Type | Description |
---|---|---|
dateTime | string | 日時 (YYYY-MM-DDTHH:mm:ss) |
timeZone | string |
Property | Type | Description |
---|---|---|
fileUrl | string | ファイルURL readOnly : true |
fileName | string | ファイル名 readOnly : true |
fileSize | integer | ファイルサイズ minimum : 0 format : int64 readOnly : true |
example
1{
2 "eventComponents": [
3 {
4 "eventId": "eventr8123-wehuh324-qwejqw123",
5 "createdTime": {
6 "dateTime": "2021-12-12T22:44:59",
7 "timeZone": "Asia/Tokyo"
8 },
9 "updatedTime": {
10 "dateTime": "2021-12-14T21:01:31",
11 "timeZone": "Asia/Tokyo"
12 },
13 "summary": "Meeting",
14 "description": "Memo",
15 "location": "CUNY Graduate Center",
16 "map": {
17 "type": "google",
18 "geo": "40.7486484;-73.98400699999999"
19 },
20 "mapUrl": {
21 "mapUrl": "https://mapUrl.googlemap.com",
22 "imageId": "imageId123"
23 },
24 "categoryId": "1",
25 "organizer": {
26 "email": "user1@example.com",
27 "displayName": "ワークス 太郎"
28 },
29 "start": {
30 "dateTime": "2021-12-13T14:00:00",
31 "timeZone": "Asia/Tokyo"
32 },
33 "end": {
34 "dateTime": "2021-12-13T15:00:00",
35 "timeZone": "Asia/Tokyo"
36 },
37 "transparency": "OPAQUE",
38 "visibility": "PUBLIC",
39 "sequence": 1,
40 "attendees": [
41 {
42 "email": "attendee1@example.com",
43 "displayName": "user1",
44 "partstat": "NEEDS-ACTION",
45 "isExternalResouce": false,
46 "isOptional": false,
47 "isResource": false
48 },
49 {
50 "email": "attendee2@example.com",
51 "displayName": "user2",
52 "partstat": "ACCEPTED",
53 "isExternalResouce": false,
54 "isOptional": true,
55 "isResource": false
56 },
57 {
58 "id": "10000355/10029600@97d9ddb4-ae93-4469-8471-110c573d13z1",
59 "partstat": "ACCEPTED",
60 "resourceValue": "https://calendar.worksmobile.com/resources/resource/10000355/10029600@97d9ddb4-ae93-4469-8471-110c573d13z1",
61 "isExternalResouce": false,
62 "isOptional": false,
63 "isResource": true
64 },
65 {
66 "email": "attendee3@example.com",
67 "displayName": "user3",
68 "partstat": "DECLINED",
69 "isExternalResouce": false,
70 "isOptional": false,
71 "isResource": false
72 }
73 ],
74 "videoMeeting": {
75 "url": "https://works.do/x4gOs1_call",
76 "resourceId": "x4gOs1_call"
77 },
78 "reminders": [
79 {
80 "method": "DISPLAY",
81 "trigger": "-PT10M"
82 },
83 {
84 "method": "EMAIL",
85 "triggerDateTime": {
86 "dateTime": "2021-12-13T10:00:00",
87 "timeZone": "Asia/Tokyo"
88 }
89 }
90 ],
91 "attachments": [
92 {
93 "fileUrl": "https://calendar.worksmobile.com/file/download?scheduleId=20211212T134459Z-153@zvcweb06.wcal.nfra.io&path=21785b23-760z-4394-badf-6463c9474746.10029600",
94 "fileName": "4024939274.pdf",
95 "fileSize": 48506
96 }
97 ]
98 }
99 ]
100}
Bad Request
Forbidden
Not Found