基本カレンダーの予定の登録

POST/users/{userId}/calendar/events

基本カレンダーに予定を登録する。

Authorization

oauth2

Authorization Code OAuth Flow

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

Scope

calendar

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/calendar/events

Path Parameters

ParameterTypeDescription
userIdstring

ユーザーを特定するID (URLエンコードする)

  • ユーザーID(userId)
  • ログインID(email)
  • 自身(me)

required
example : userf7da-f82c-4284-13e7-030f3b4c756x

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

予定および繰返し/繰返し例外予定を配列で入力する。
配列の要素はすべて同じeventIdで入力。

PropertyTypeDescription
eventComponentsarray (Event)

配列の要素はすべて同じeventIdで入力。

Event

PropertyTypeDescription
eventIdstring

予定ID
指定しない場合には自動的に割り当てられる


minLength : 1
maxLength : 255
summarystring

予定の内容


required
descriptionstring

予定のメモ


minLength : 0
maxLength : 5000
locationstring

予定の場所

mapobject (map)

地図情報

mapUrlobject (mapUrl)

地図URL

categoryIdstring

予定のカテゴリーID
1~14の値を指定する。

organizerobject (organizer)

主催者
予定が属するカレンダーを示す。

  • 基本カレンダー: 基本カレンダーのマスターのログインID
  • 基本カレンダー以外: カレンダー固有のカレンダーのメールアドレス
startobject (start)

予定の開始または終了日時


required
endobject (end)

予定の開始または終了日時

recurrencearray (Recurrence)

繰返し情報


minItems : 0
maxItems : 100
recurringEventIdstring
transparencystring

表示方法

  • OPAQUE: 予定あり
  • TRANSPARENT: 空き時間

default : OPAQUE
Allowed values : OPAQUE, TRANSPARENT
visibilitystring

公開/非公開

  • PUBLIC: 公開
  • PRIVATE: 非公開

default : PUBLIC
Allowed values : PUBLIC, PRIVATE
sequenceinteger
default : 0
minimum : 0
format : int32
attendeesarray (Attendee)

参加者リスト


minItems : 0
maxItems : 500
videoMeetingobject (videoMeeting)

ビデオ通話ミーティング

remindersarray (Alarm)

通知情報


minItems : 0
maxItems : 100

map

PropertyTypeDescription
typestring

地図タイプ(googleなど)

geostring

経緯度

mapUrl

PropertyTypeDescription
mapUrlstring

地図のURL

imageIdstring

地図の画像ID

organizer

PropertyTypeDescription
emailstring

主催者のメールアドレス


required
displayNamestring

主催者名

start

PropertyTypeDescription
datestring

終日予定の場合の日付 (YYYY-MM-DD)

dateTimestring

時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

時間予定(dateTime)の場合のタイムゾーン
https://developers.worksmobile.com/jp/reference/appendix

end

PropertyTypeDescription
datestring

終日予定の場合の日付 (YYYY-MM-DD)

dateTimestring

時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

時間予定(dateTime)の場合のタイムゾーン
https://developers.worksmobile.com/jp/reference/appendix

Recurrence

PropertyTypeDescription
Recurrencestring

繰返し予定のルールを設定

Attendee

PropertyTypeDescription
idstring

設備ID
設備を指定する場合は必須

設備から設備IDを取得するAPIは用意されていない
設備を予約した予定を取得することで設備IDを確認可能

emailstring

参加者メールアドレス
参加者を指定する場合は必須

displayNamestring

参加者または設備名

partstatstring

予定招待への回答

  • NEEDS-ACTION: 未回答
  • ACCEPTED: 承諾
  • DECLINED: 辞退
  • TENTATIVE : 未定

Allowed values : NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE
isResourceboolean

設備フラグ


default : false
isExternalResourceboolean

外部設備フラグ


default : false
isOptionalboolean

任意参加フラグ


default : false

videoMeeting

PropertyTypeDescription

Alarm

PropertyTypeDescription
methodstring

通知方法

  • DISPLAY: プッシュ通知
  • EMAIL: メール通知

required
Allowed values : DISPLAY, EMAIL
triggerstring

予定開始前の通知タイミング。
詳細はこちらを参照。
例)
-PT0S : イベント予定時刻
-PT15M : 15分前
-PT12H : 12時間前
-P1D : 1日前
-P1W : 1週間前
-P6DT12H : 6日 12時間前

triggerDateTimeobject (triggerDateTime)

時間情報

triggerDateTime

PropertyTypeDescription
dateTimestring

日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

Request Example

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}

Response

HTTP 201

OK

PropertyTypeDescription
eventComponentsarray (Event)

予定情報

Event

PropertyTypeDescription
eventIdstring

予定ID


required
minLength : 1
maxLength : 255
createdTimeobject (createdTime)

時間情報


readOnly : true
updatedTimeobject (updatedTime)

時間情報


readOnly : true
summarystring

予定の内容


required
minLength : 0
maxLength : 200
descriptionstring

予定のメモ


minLength : 0
maxLength : 5000
locationstring

予定の場所


minLength : 0
maxLength : 100
mapobject (map)

地図情報

mapUrlobject (mapUrl)

地図URL

categoryIdstring

予定のカテゴリーID
1~14の値を指定する。

organizerobject (organizer)

主催者
予定が属するカレンダーを示す。

  • 基本カレンダー: 基本カレンダーのマスターのログインID
  • 基本カレンダー以外: カレンダー固有のカレンダーのメールアドレス
startobject (start)

予定の開始または終了日時


required
endobject (end)

予定の開始または終了日時

recurrencearray (Recurrence)

繰返し情報


minItems : 0
maxItems : 100
recurringEventIdstring
transparencystring

表示方法

  • OPAQUE: 予定あり
  • TRANSPARENT: 空き時間

default : OPAQUE
Allowed values : OPAQUE, TRANSPARENT
visibilitystring

公開/非公開

  • PUBLIC: 公開
  • PRIVATE: 非公開

default : PUBLIC
Allowed values : PUBLIC, PRIVATE
sequenceinteger
default : 0
minimum : 0
format : int32
attendeesarray (Attendee)

参加者リスト


minItems : 0
maxItems : 500
videoMeetingobject (videoMeeting)

ビデオ通話ミーティング

remindersarray (Alarm)

通知情報


minItems : 0
maxItems : 100
attachmentsarray (File)

添付ファイル(添付ファイルのサイズの合計が100MB以下)


readOnly : true

createdTime

PropertyTypeDescription
dateTimestring

日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

updatedTime

PropertyTypeDescription
dateTimestring

日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

map

PropertyTypeDescription
typestring

地図タイプ(googleなど)

geostring

経緯度

mapUrl

PropertyTypeDescription
mapUrlstring

地図のURL

imageIdstring

地図の画像ID

organizer

PropertyTypeDescription
emailstring

主催者のメールアドレス


required
displayNamestring

主催者名

start

PropertyTypeDescription
datestring

終日予定の場合の日付 (YYYY-MM-DD)

dateTimestring

時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

時間予定(dateTime)の場合のタイムゾーン
https://developers.worksmobile.com/jp/reference/appendix

end

PropertyTypeDescription
datestring

終日予定の場合の日付 (YYYY-MM-DD)

dateTimestring

時間予定の場合の日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

時間予定(dateTime)の場合のタイムゾーン
https://developers.worksmobile.com/jp/reference/appendix

Recurrence

PropertyTypeDescription
Recurrencestring

繰返し予定のルールを設定

Attendee

PropertyTypeDescription
idstring

設備ID
設備を指定する場合は必須

設備から設備IDを取得するAPIは用意されていない
設備を予約した予定を取得することで設備IDを確認可能

emailstring

参加者メールアドレス
参加者を指定する場合は必須

displayNamestring

参加者または設備名

partstatstring

予定招待への回答

  • NEEDS-ACTION: 未回答
  • ACCEPTED: 承諾
  • DECLINED: 辞退
  • TENTATIVE : 未定

Allowed values : NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE
isResourceboolean

設備フラグ


default : false
isExternalResourceboolean

外部設備フラグ


default : false
isOptionalboolean

任意参加フラグ


default : false
resourceValuestring

リソースの固有値

  • isResourceまたはisExternalResourceがtrueの場合は必須

readOnly : true

videoMeeting

PropertyTypeDescription
urlstring

ビデオ通話ミーティングURL


readOnly : true
resourceIdstring

ビデオ通話ミーティングID


readOnly : true

Alarm

PropertyTypeDescription
methodstring

通知方法

  • DISPLAY: プッシュ通知
  • EMAIL: メール通知

required
Allowed values : DISPLAY, EMAIL
triggerstring

予定開始前の通知タイミング。
詳細はこちらを参照。
例)
-PT0S : イベント予定時刻
-PT15M : 15分前
-PT12H : 12時間前
-P1D : 1日前
-P1W : 1週間前
-P6DT12H : 6日 12時間前

triggerDateTimeobject (triggerDateTime)

時間情報

triggerDateTime

PropertyTypeDescription
dateTimestring

日時 (YYYY-MM-DDTHH:mm:ss)

timeZonestring

File

PropertyTypeDescription
fileUrlstring

ファイルURL


readOnly : true
fileNamestring

ファイル名


readOnly : true
fileSizeinteger

ファイルサイズ


minimum : 0
format : int64
readOnly : true

Response Example

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}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found