カテゴリー内の他の記事

スケジュールのeventオブジェクト

フォローする

Index

eventオブジェクトのプロパティ

画面上に表示されている情報が返ります。
次のようなJSON形式になります。

基本プロパティ

プロパティ名 valueの例 説明
id 文字列 
"id": "1"
予定ID
version 文字列 

"version": "1"
バージョン
creator オブジェクト
"creator": {
"id": "1",
"code": "cybozu",
"name": "cybozu"}
登録者
creator.id 文字列

登録者のユーザーID

creator.code 文字列

登録者のログイン名

creator.name 文字列

登録者の表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

createdAt オブジェクト
"createdAt": "2017-09-26T06:25:18Z"
 

予定の作成日時

形式はISO8601のUTCタイムゾーンです。

updater オブジェクト
"updater": {
"id": "1",
"code": "cybozu",
"name": "cybozu"}
更新者
updater.id 文字列

更新者のユーザーID

updater.code 文字列

更新者のログイン名

updater.name 文字列

更新者の表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

updatedAt 文字列
"updatedAt": "2017-09-26T06:25:18Z"

予定の更新日時

形式はISO8601のUTCタイムゾーンです。

eventType 文字列
"eventType": "REGULAR"

予定のタイプ

利用可能なvalueは次のとおりです。

  • REGULAR
  • REPEATING
  • ALL_DAY
eventMenu  文字列
"eventMenu": "打合"

予定メニュー

予定メニューのデフォルト設定値「-----」のvalueは空文字列とみなされます。詳細

subject 文字列
"subject": "my打ち合わせ"
タイトル
notes 文字列
"notes": "これはメモです"

メモ

改行文字は「\n」です。

visibilityType 文字列
"visibilityType": "PRIVATE"

公開設定のタイプ

利用可能なvalueは次のとおりです。 

  • PUBLIC
  • PRIVATE
  • SET_PRIVATE_WATCHERS
useAttendanceCheck 真偽値
"useAttendanceCheck": false

出欠確認を使用しているかどうか

システム設定で「出欠確認の使用」の許可が必要です。

会社情報に関するプロパティ

プロパティ名 valueの例 説明
companyInfo オブジェクト
"companyInfo": {
  "address": "東京都○○区××"
  "name": "才望子株式会社"
  "phone": "080-1111-1111"
  "route": "日本橋 - 東京メトロ銀座線 - 渋谷"
  "routeFare": "195"
  "routeTime": "18"
  "zipCode": "123-4567"}

会社情報

companyInfo.name 文字列 会社名
companyInfo.zipCode 文字列 郵便番号
companyInfo.address 文字列 住所
companyInfo.route 文字列 路線の経路
companyInfo.routeTime 文字列 路線の所要時間
companyInfo.routeFare 文字列 路線の運賃
companyInfo.phone 文字列 電話番号

添付ファイルに関するプロパティ

プロパティ名 valueの例 説明
attachments 配列
"attachments": {
"id": "1",
"name": "figure.png",
"contentType": "image/png",
"size": "64251"}

添付ファイルのリスト

システム設定で「ファイルの添付」の許可が必要です。

attachments[].id 文字列 ファイルID
attachments[].contentType 文字列 コンテンツタイプ
attachments[].name 文字列 ファイル名
attachments[].size 文字列 ファイルのサイズ(byte)

開始と終了に関するプロパティ

プロパティ名 valueの例 説明
start オブジェクト
"start": {
"dateTime": "2017-09-27T14:00:00+09:00",
"timeZone": "Asia/Tokyo"}

開始日時とタイムゾーン

start.dateTime 文字列

予定の開始日時

形式はRFC3339です。

start.timeZone 文字列 開始日時のタイムゾーン
end オブジェクト
"end": {
"dateTime": "2017-09-27T15:00:00+09:00",
"timeZone": "Asia/Tokyo"}
終了日時とタイムゾーン
end.dateTime 文字列

予定の終了日時

形式はRFC3339です。

end.timeZone 文字列   終了日時のタイムゾーン
isAllDay 真偽値
"isAllDay": false

終日の予定かどうか

 

isStartOnly 真偽値
"isStartOnly": false

開始のみの予定かどうか

originalStartTimeZone 文字列
"originalStartTimeZone": "Asia/Tokyo"
予定の登録または更新時にstart.timeZone または repeatInfo.timeZone プロパティに設定されたタイムゾーン
originalEndTimeZone 文字列
"originalEndTimeZone": "Asia/Tokyo"
予定の登録または更新時に end.timeZone または repeatInfo.timeZone プロパティに設定されたタイムゾーン

参加者に関するプロパティ

プロパティ名 valueの例 説明
attendees 配列
"attendees": [{
"id": "1",
"code": "cybozu",
"name": "cybozu",
"type": "USER"}]

参加者のリスト

attendees[].id 文字列 -

参加者のユーザーID

attendees[].code 文字列 - attendees[].type プロパティのvalueにより異なります。
  • 「ORGANIZATION」 の場合:組織コード
  • 「USER」 の場合:ログイン名
attendees[].name 文字列 -

参加者の表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

attendees[].type 文字列 -

参加者のタイプ

利用可能なvalueは次のとおりです。 

  • ORGANIZATION
  • USER
attendees[].attendanceResponse オブジェクト -

各参加者の出欠確認の情報

システム設定で「出欠確認の使用」の許可が必要です。

attendees[].attendanceResponse.status 文字列

各参加者の出欠確認の状態

利用可能なvalueは次のとおりです。

  • PENDING
  • ACCEPTED
  • DECLINED
attendees[].attendanceResponse.comment 文字列 - 各参加者が出欠確認に回答したときのメッセージ
attendeesCandidate 配列
"attendeesCandidate": [{
"id": "1",
"code": "cybozu",
"name": "cybozu",
"type": "USER"}]

参加者の候補リスト

attendeesCandidate[].id 文字列 - 参加者の候補リストのユーザーID
※JavaScript APIのみ
attendeesCandidate[].code 文字列 - 参加者の候補リストのログイン名
attendeesCandidate[].name 文字列 -

参加者の候補リストの表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

attendeesCandidate[].type 文字列 - 参加者の候補リストのタイプ
watchers 配列
"watchers": [{
"id": "1",
"code": "cybozu",
"name": "cybozu",
"type": "USER"}]

公開先のリスト

watchers[].id 文字列 -

公開先のユーザーID

watchers[].code 文字列 -

watchers[].type プロパティのvalueにより異なります。

  • 「ORGANIZATION」 の場合:組織コード
  • 「USER」 の場合:ログイン名
  • 「ROLE」の場合:ロール名
watchers[].name 文字列 -

公開先の表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

watchers[].type 文字列 -

公開先のタイプ

利用可能なvalueは次のとおりです。 

  • ORGANIZATION
  • USER
  • ROLE
watchersCandidate[] 配列
"watchersCandidate": [{
"id": "1",
"code": "cybozu",
"name": "cybozu",
"type": "USER"}]

公開先の候補リスト

watchersCandidate[].id 配列 -

公開先の候補リストの表示名
※JavaScript APIのみ

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

watchersCandidate[].code 配列 -

公開先の候補リストのログイン名

watchersCandidate[].name 配列 -

公開先の候補リストの表示名

watchersCandidate[].type 配列 -

公開先の候補リストのタイプ

施設に関するプロパティ

プロパティ名 valueの例 説明
facilities 配列
"facilities": [{
"id": "3",
"name": "Web会議室",
"code": "Web会議室"}]

施設のリスト

facilities[].id 文字列 - 施設名ID
facilities[].name 文字列 - 施設名
facilities[].code 文字列 - 施設コード
facilitiesCandidate[] 配列
"facilitiesCandidate": [{
"id": "3",
"name": "Web会議室",
"code": "Web会議室"}]

施設の候補リストです。

 

facilitiesCandidate[].id 文字列 -

施設の候補リストの施設ID
※JavaScript APIのみ

facilitiesCandidate[].name 文字列 -

施設の候補リストの施設名

facilitiesCandidate[].code 文字列 - 施設の候補リストの施設コード
facilityUsingPurpose 文字列
"facilityUsingPurpose": "TEST"

施設の利用目的

システム設定で「施設の利用申請」の有効化が必要です。

facilityReservationInfo オブジェクト
"facilityReservationInfo": {
"itemA": {
"type": "SINGLE_LINE_TEXT",
"value": "test"
}
}

施設予約情報

システム設定で「施設の利用申請」の有効化が必要です。

facilityReservationInfo. 
<ITEM_CODE>.type 
文字列 -

カスタム項目のタイプ 

利用可能なvalueは次のとおりです。 

  • SINGLE_LINE_TEXT
  • MULTI_LINE_TEXT
  • DROP_DOWN
facilityReservationInfo. 
<ITEM_CODE>.value
文字列 - カスタム項目の値
facilityUsageRequests 配列
"facilityUsageRequests": [{
"status ": "IN_PROGRESS",
"facility": {
"id": "3",
"name": "Web会議室",
"code": "Web会議室"
}
}]

施設の利用申請のリスト

次の条件のどちらかを満たす場合に返ります。

  • システム設定で「施設の利用申請」が有効化されていること
  • 施設の利用承認履歴データがある
facilityUsageRequests[].facility  オブジェクト -  
facilityUsageRequests[].facility.id 文字列 - 予約された施設ID
facilityUsageRequests[].facility.name  文字列 - 予約された施設名
facilityUsageRequests[].facility.code  文字列 - 予約された施設コード
facilityUsageRequests[].status  文字列 -

承認ステータス 

利用可能なvalueは次のとおりです。

  • IN_PROGRESS
  • REJECTED 
  • APPROVED
facilityUsageRequests[].approvedBy  オブジェクト -  
facilityUsageRequests[].approvedBy.id 文字列 -

承認者のユーザーID

facilityUsageRequests[].approvedBy.code 文字列 -

承認者のログイン名 

facilityUsageRequests[].approvedBy.name 文字列 -

承認者の表示名

個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。

facilityUsageRequests[].approvedDateTime 文字列 -

申請が承認された日時

形式はISO8601のUTCタイムゾーンです。

繰り返し予定に関するプロパティ

プロパティ名 valueの例 説明
repeatInfo オブジェクト
"repeatInfo": {
"type": "EVERY_DAY",
"period": {
  "start": "2017-09-28",
   "end": "2017-10-09"
},
 "time": {
"start": "00:00",
"end": "00:00"
},
"timeZone": "Asia/Tokyo",
"isAllDay": true,
"isStartOnly": false,
"range": {
"type": "",
"date": ""
}
}

繰り返し予定情報

repeatInfo.range オブジェクト - 繰り返し予定の範囲
repeatInfo.range.type  文字列 -

ユーザーが編集したい繰り返し予定の範囲のタイプ

デフォルトは空文字列です。

利用可能なvalueは次のとおりです。 

  • THIS_EVENT_ONLY
  • ON_AND_AFTER_THIS_EVENT
  • ALL_EVENT 
repeatInfo.range.date 文字列 -

現在編集中の繰り返し予定の日付

YYYY-MM-DD形式です。

repeatInfo.type 文字列 -

繰り返し条件

利用可能なvalueは次のとおりです。

  • EVERY_DAY
  • EVERY_WEEKDAY
  • EVERY_WEEK
  • EVERY_1STWEEK
  • EVERY_2NDWEEK
  • EVERY_3RDWEEK
  • EVERY_4THWEEK
  • EVERY_LASTWEEK
  • EVERY_MONTH 
repeatInfo.period オブジェクト - 繰り返し期間
repeatInfo.period.start 文字列 -

繰り返し期間の開始日

YYYY-MM-DD形式です。

repeatInfo.period.end 文字列 -

繰り返し期間の終了日

YYYY-MM-DD形式です。

repeatInfo.time オブジェクト -

繰り返し予定の時間

HH:MM形式です。

repeatInfo.time.start 文字列 -

繰り返し予定の開始時刻

HH:MM形式です。

repeatInfo.time.end 文字列 -

繰り返し予定の終了時刻

HH:MM形式です。

repeatInfo.isAllDay 真偽値 - 繰り返し予定が終日の予定かどうか 
repeatInfo.isStartOnly 真偽値 - 繰り返し予定がが開始のみの予定かどうか
repeatInfo.timeZone 文字列 - repeatInfo.time プロパティのタイムゾーン
repeatInfo.dayOfWeek 文字列 -

週次の繰り返し予定の曜日

利用可能なvalueは次のとおりです。

  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN 
repeatInfo.dayOfMonth 文字列 -

月次の繰り返し予定の日付

利用可能なvalueは次のとおりです。

  • 数字の日付の場合:  "1"〜"31"
    (例)1日: "1" 
  • 月末の場合: "EOM" 
repeatInfo.exclusiveDateTimes 配列 - 繰り返し予定から分離された予定の一覧
repeatInfo.exclusiveDateTimes [].start 文字列 - 繰り返し予定から分離された予定の開始日時

形式はRFC3339です(タイムゾーン含む)。

repeatInfo.exclusiveDateTimes [].end  文字列 -

繰り返し予定から分離された予定の終了日時

形式はRFC3339です(タイムゾーン含む)。

temporaryEventCandidates[].start.dateTime 文字列  

期間予定の開始日時

形式はRFC3339です。

temporaryEventCandidates[].start.timeZone 文字列 - 期間予定の開始日時のタイムゾーン
temporaryEventCandidates[].end.dateTime 文字列 -

期間予定の終了日時

形式はRFC3339です。

temporaryEventCandidates[].end.timeZone 文字列 - 期間予定の終了日時のタイムゾーン
temporaryEventCandidates[].facility.id 文字列 - 期間予定の施設ID
※REST APIのみ
temporaryEventCandidates[].facility.code 文字列 - 期間予定の施設コード
temporaryEventCandidates[].facility.name 文字列 - 期間予定の施設名 

カスタム項目に関するプロパティ

プロパティ名 valueの例 説明
additionalItems オブジェクト
"additionalItems": {
  "item": {
    "value": "string"
  }
}

予定のAPI用連携項目

additionalItems.item.value 文字列

予定のAPI用連携項目の値

注意事項

値の取得時

  • timeZone プロパティは、画面上で使用されている値と同じ値になります。
    たとえば、予定の登録または変更画面では、タイムゾーンの値はイベントのタイムゾーンになります。詳細画面では、タイムゾーンの値はログインしているユーザーのタイムゾーンになります。
    また、dateTime プロパティはtimeZone プロパティ値によって調整されます。
  • 繰り返し予定の場合、予定を登録または編集するときには「開始」および「終了」プロパティは返らず、詳細画面を表示するときに返ります。
  • 終日の予定の場合、dateTime プロパティはそのタイムゾーンの00:00になります。

終日予定のデータ例の一部抜粋(予定の登録画面)

上記データが、ログインユーザーのタイムゾーンである "Asia / Bangkok"タイムゾーンで返った例の一部抜粋(予定の詳細画面)

  • 時間フィールドの組み合わせが無効な場合、固定値が返ります。
時間フィールド 分フィールド 戻り値
- 30 00:00
10 - 10:00

値の設定時

  • eventMenu プロパティについて、予定メニューのデフォルト設定値「-----」は、空の文字列と見なされます。
    デフォルト設定値をAPIで設定するためには、 「-----」の代わりに空の文字列を指定する必要があります。 
    「-----」を指定した場合はエラーが発生します。

 Top

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。