GET/users/{userId}/calendars/events/search

ユーザーのカレンダー全体を対象に予定を検索する。

  • 検索期間は 180 日まで指定できる。startTime と endTime のいずれかが指定されていない場合には、現在時刻の前後3か月を対象に検索する。
  • 登録・変更した予定が検索結果に反映されるまでに時間を要する場合がある。
  • リクエストの状況により、応答に時間を要したり、利用が制限される場合がある。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

calendar
calendar.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/calendars/events/search

Path Parameters

ParameterTypeDescription
userId string 

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

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

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

Query Parameters

ParameterTypeDescription
query string 

検索語

  • URL エンコードして指定する。
  • 大文字と小文字は区別しない。
  • 指定しない場合には、検索語条件無しで結果を返す。
  • queryFilters を指定する場合には必須。

minLength : 2
maxLength : 100
example : 定例会議 
queryFilters string 

検索対象項目

  • 指定可能な値:
    • summary : タイトル
    • attendee : 参加者
    • location : 場所
    • description : メモ
  • 複数の値を指定する場合は、カンマ（,）で区切る
  • 既定では、タイトル、参加者、場所、メモのすべてを検索対象とする。

example : summary,attendee 
startTime string 

予定検索の開始日時 (ISO-8601 形式: YYYY-MM-DDThh:mm:ssTZD)

  • 「+」は 「%2B」にエンコードする

example : 2021-06-03T10:00:00%2B09:00 
endTime string 

予定検索の終了日時 (ISO-8601 形式: YYYY-MM-DDThh:mm:ssTZD)

  • 「+」は 「%2B」にエンコードする

example : 2021-06-03T11:00:00%2B09:00 
count integer 

取得数


default : 50
minimum : 1
maximum : 100
example : 50
format : int32 
cursor string 

次のリスト取得時に使用するカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
events array (EventComponents) 

予定リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

EventComponents

PropertyTypeDescription
eventComponents array (Event) 

予定情報

 
organizerCalendarId string 

イベントが属しているカレンダー ID

 

Event

PropertyTypeDescription
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) 

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

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

readOnly : true 
start object (start) 

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


required 
end object (end) 

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

 
recurrence array (Recurrence) 

繰返し情報


minItems : 0
maxItems : 100 
recurringEventId string 

繰返し例外予定 ID

  • 参照) https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.4.4
 
transparency string 

表示方法

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

default : OPAQUE
Allowed values : OPAQUE, TRANSPARENT 
visibility string 

公開/非公開

  • PUBLIC : 公開
  • PRIVATE : 非公開

default : PUBLIC
Allowed values : PUBLIC, PRIVATE 
sequence integer 

シーケンス番号

  • 参照) https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.7.4

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 
viewUrl string 

予定情報の参照 URL


minLength : 0
format : uri
readOnly : true 
priority integer 

予定の重要度 0 : 重要度の指定なし 1 : 最も重要 2 : 次に重要 .... 9 : 最も低い重要度


default : 0
minimum : 0
maximum : 9 

createdTime

PropertyTypeDescription
dateTime string 

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

 
timeZone string 

タイムゾーン

 

updatedTime

PropertyTypeDescription
dateTime string 

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

 
timeZone string 

タイムゾーン

 

map

PropertyTypeDescription
type string 

地図タイプ（google など）

 
geo string 

経緯度

 

mapUrl

PropertyTypeDescription
mapUrl string 

地図の URL

 
imageId string 

地図の画像 ID

 

organizer

PropertyTypeDescription
email string 

主催者のメールアドレス


required 
displayName string 

主催者名

 

start

PropertyTypeDescription
date string 

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

  • start.date は予定期間に含み、end.date は予定期間に含まない。
 
dateTime string 

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

 
timeZone string 

時間予定 (dateTime) の場合の タイムゾーン

 

end

PropertyTypeDescription
date string 

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

  • start.date は予定期間に含み、end.date は予定期間に含まない。
 
dateTime string 

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

 
timeZone string 

時間予定 (dateTime) の場合の タイムゾーン

 

Recurrence

PropertyTypeDescription
Recurrence string 

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

  • 参照)
  • EXDATE: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.1
  • RRULE: https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10
    例) 毎週木曜日の繰返し
    RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=TH
 

Attendee

PropertyTypeDescription
id string 

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

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

 
email string 

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

 
displayName string 

参加者または設備名

 
partstat string 

予定招待への回答

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

Allowed values : NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE 
isResource boolean 

設備フラグ


default : false 
isOptional boolean 

任意参加フラグ


default : false 
resourceValue string 

リソースの固有値

 

videoMeeting

PropertyTypeDescription
url string 

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


format : uri 
resourceId string 

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

 

Alarm

PropertyTypeDescription
method string 

通知方法

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

required
Allowed values : DISPLAY, EMAIL 
trigger string 

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

 
triggerDateTime object (triggerDateTime) 

時間情報

 

triggerDateTime

PropertyTypeDescription
dateTime string 

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

 
timeZone string 

タイムゾーン

 

File

PropertyTypeDescription
fileUrl string 

ファイル URL


readOnly : true 
fileName string 

ファイル名


readOnly : true 
fileSize integer 

ファイルサイズ


minimum : 0
format : int64
readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリストが存在する場合のカーソル値


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
nullable : true 

Response Example

example

1{2  "events": [3    {4      "eventComponents": [5        {6          "eventId": "eventr8123-wehuh324-qwejqw123",7          "createdTime": {8            "dateTime": "2021-12-12T22:44:59",9            "timeZone": "Asia/Tokyo"10          },11          "updatedTime": {12            "dateTime": "2021-12-14T21:01:31",13            "timeZone": "Asia/Tokyo"14          },15          "summary": "定例会議",16          "description": "Memo",17          "location": "第一会議室",18          "organizer": {19            "email": "user1@example.com",20            "displayName": "userName1"21          },22          "start": {23            "dateTime": "2021-12-13T14:00:00",24            "timeZone": "Asia/Tokyo"25          },26          "end": {27            "dateTime": "2021-12-13T15:00:00",28            "timeZone": "Asia/Tokyo"29          },30          "attendees": [31            {32              "email": "attendee1@example.com",33              "displayName": "user1",34              "partstat": "NEEDS-ACTION",35              "isOptional": false,36              "isResource": false37            }38          ],39          "viewUrl": "https://calendar.worksmobile.com/permanentLink.nhn"40        }41      ],42      "organizerCalendarId": "calendar-96b8-4c74-8277-7953e0b4604a"43    }44  ],45  "responseMetaData": {46    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="47  }48}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found