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

Garoon APIドキュメント

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

固定リンクがコピーされました

基本プロパティ
会社情報に関するプロパティ
添付ファイルに関するプロパティ
開始と終了に関するプロパティ
参加者に関するプロパティ
共有先に関するプロパティ
施設に関するプロパティ
繰り返し予定に関するプロパティ
kintone連携項目に関するプロパティ
カスタム項目（additionalItems）に関するプロパティ

閲覧権限がない予定で取得できるプロパティ
注意事項

タイムゾーンの扱い
終日予定における開始日時と終了日時
時間フィールドや分フィールドが指定されていない場合の開始日時
カスタム項目（Schedule datastore)

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

固定リンクがコピーされました

スケジュールでは、次の内容を取得できます。
プロパティの詳細は、別表を参照してください。

スケジュールオブジェクトの例を表示する

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184


{
  "event": {
    "id": "1",
    "creator": {
      "id": "1",
      "code": "sato-noboru",
      "name": "Noboru SATO"
    },
    "createdAt": "2017-09-26T06:25:18Z",
    "updater": {
      "id": "1",
      "code": "sato-noboru",
      "name": "Noboru SATO"
    },
    "updatedAt": "2017-09-26T06:25:18Z",
    "eventType": "REGULAR",
    "eventMenu": "打合",
    "subject": "打ち合わせ",
    "notes": "これはメモ\nです",
    "visibilityType": "PRIVATE",
    "useAttendanceCheck": false,
    "companyInfo": {
      "address": "東京都中央区",
      "name": "サイボウズ株式会社",
      "phone": "080-1111-1111",
      "route": "日本橋 － 東京メトロ銀座線 － 渋谷",
      "routeFare": "195",
      "routeTime": "18",
      "zipCode": "123-4567"
    },
    "attachments": [
      {
        "id": "1",
        "name": "figure.png",
        "contentType": "image/png",
        "size": "64251",
        "content": "YmFzZTY0ZmlsZQ=="
      }
    ],
    "start": {
      "dateTime": "2017-09-27T14:00:00+09:00",
      "timeZone": "Asia/Tokyo"
    },
    "end": {
      "dateTime": "2017-09-27T15:00:00+09:00",
      "timeZone": "Asia/Tokyo"
    },
    "isAllDay": false,
    "isStartOnly": false,
    "originalStartTimeZone": "Asia/Tokyo",
    "originalEndTimeZone": "Asia/Tokyo",
    "attendees": [
      {
        "id": "1",
        "code": "sato-noboru",
        "name": "Noboru SATO",
        "type": "USER",
        "attendanceResponse": {
          "status": "PENDING",
          "comment": "I am going to attend the meeting."
        }
      }
    ],
    "attendeesCandidate": [
      // JavaScript APIのみ
      {
        "id": "1",
        "code": "sato-noboru",
        "name": "Noboru SATO",
        "type": "USER"
      }
    ],
    "watchers": [
      {
        "id": "1",
        "code": "sato-noboru",
        "name": "Noboru SATO",
        "type": "USER"
      }
    ],
    "watchersCandidate": [
      // JavaScript APIのみ
      {
        "id": "1",
        "code": "sato-noboru",
        "name": "Noboru SATO",
        "type": "USER"
      }
    ],
    "facilities": [
      {
        "id": "3",
        "name": "Web会議室",
        "code": "FA_WEB"
      }
    ],
    "facilitiesCandidate": [
      // JavaScript APIのみ
      {
        "id": "3",
        "name": "Web会議室",
        "code": "FA_WEB"
      }
    ],
    "facilityUsingPurpose": "オンライン会議で利用します",
    "facilityReservationInfo": {
      "itemA": {
        "type": "SINGLE_LINE_TEXT",
        "value": "Web会議室です"
      }
    },
    "facilityUsageRequests": [
      {
        "status ": "IN_PROGRESS",
        "facility": {
          "id": "3",
          "name": "Web会議室",
          "code": "Web会議室"
        },
        "approvedBy": {
          "id": "1",
          "code": "sato-noboru",
          "name": "Noboru SATO"
        },
        "approvedDateTime": "2017-09-26T06:25:18Z"
      }
    ],
    "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": ""
      },
      "dayOfWeek": "MON",
      "dayOfMonth": "EOM",
      "exclusiveDateTimes": [
        {
          "start": "2017-12-28T00:00:00+09:00",
          "end": "2017-12-29T00:00:00+09:00"
        }
      ]
    },
    "temporaryEventCandidates": [
      // REST APIのみ
      {
        "start": {
          "dateTime": "2017-06-06T10:00:00+09:00",
          "timeZone": "Asia/Tokyo"
        },
        "end": {
          "dateTime": "2017-06-06T09:00:00+09:00",
          "timeZone": "Asia/Tokyo"
        },
        "facility": {
          "id": "1",
          "code": "room-a",
          "name": "ROOM-A"
        }
      }
    ],
    "kintone": [
      {
        "appId": 123,
        "recordId": 456
      }
    ],
    "additionalItems": {
      "item": {
        "value": "string"
      }
    }
  }
}

基本プロパティ

固定リンクがコピーされました

プロパティ名	型	例	説明
id	文字列	"id": "1"	予定ID
creator	オブジェクト	"creator": { "id": "1", "code": "sato-noboru", "name": "Noboru SATO" }	登録者
creator.id	文字列		登録者のGaroonユーザーID
creator.code	文字列		登録者のログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
creator.name	文字列		登録者の表示名個人設定（クラウド版｜パッケージ版）の「ユーザー名の後に表示する情報」の設定が適用されます。
createdAt	文字列	"createdAt": "2017-09-26T06:25:18Z"	予定の作成日時形式はISO8601のUTCタイムゾーンです。
updater	オブジェクト	"updater": { id": "1", "code": "sato-noboru", "name": "Noboru SATO" }	更新者
updater.id	文字列		更新者のGaroonユーザーID
updater.code	文字列		更新者のログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
updater.name	文字列		更新者の表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
updatedAt	文字列	"updatedAt": "2017-09-26T06:25:18Z"	予定の更新日時形式はISO8601のUTCタイムゾーンです。
eventType	文字列	"eventType": "REGULAR"	予定のタイプ利用可能な値は次のとおりです。 `REGULAR`：通常予定 `REPEATING`：繰り返し予定 `ALL_DAY`：期間予定 `TEMPORARY`：仮予定 JavaScript APIでは利用できません。
eventMenu	文字列	"eventMenu": "打合"	予定メニュー予定メニューが未選択（「-----」）の場合は、空文字列が返ります。 APIを使って予定メニューを未選択（「-----」）に設定する場合は、空文字列を指定してください。
subject	文字列	"subject": "打ち合わせ"	タイトル
notes	文字列	"notes": "これはメモ\nです"	メモ
visibilityType	文字列	"visibilityType": "PRIVATE"	公開方法利用可能な値は次のとおりです。 `PUBLIC`：公開 `PRIVATE`：非公開 `SET_PRIVATE_WATCHERS`：公開先を設定するパッケージ版Garoon 5.0〜5.5.1でのみ指定できる値です。システム設定の「非公開の予定」（クラウド版｜パッケージ版）で「登録できる」をチェックした場合だけ、値を取得できます。
useAttendanceCheck	真偽値	"useAttendanceCheck": false	予定の出欠確認（クラウド版｜パッケージ版）を使用しているかどうか `true`：予定の出欠確認をする `false`：予定の出欠確認をしないクラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント予定の出欠確認をするには、システム設定で「出欠確認の使用」（クラウド版｜パッケージ版）を許可するしてください。
companyInfo	オブジェクト	"companyInfo": { "address": "東京都中央区", "name": "サイボウズ株式会社", "phone": "080-1111-1111", "route": "日本橋－東京メトロ銀座線－渋谷", "routeFare": "195", "routeTime": "18", "zipCode": "123-4567" }	会社情報詳細は会社情報に関するプロパティを参照してください。
attachments	オブジェクト	"attachments": [ { "id": "1", "name": "figure.png", "contentType": "image/png", "size": "64251", "content": "abcde" } ]	添付ファイル詳細は添付ファイルに関するプロパティを参照してください。
start end isAllDay isStartOnly originalStartTimeZone originalEndTimeZone	ー	"start": { "dateTime": "2017-09-27T14:00:00+09:00", "timeZone": "Asia/Tokyo" }, "end": { "dateTime": "2017-09-27T15:00:00+09:00", "timeZone": "Asia/Tokyo" }, "isAllDay": false, "isStartOnly": false, "originalStartTimeZone": "Asia/Tokyo", "originalEndTimeZone": "Asia/Tokyo"	開始と終了に関するプロパティ詳細は開始と終了に関するプロパティを参照してください。
attendees attendeesCandidate	ー	"attendees": [ { "id": "1", "code": "sato-noboru", "name": "Noboru SATO", "type": "USER", "attendanceResponse": { "status": "PENDING", "comment": "I am going to attend the meeting." } } ], "attendeesCandidate": [ { "id": "1", "code": "suzuki-takeshi", "name": "Takeshi SUZUKI", "type": "USER" } ]	参加者に関するプロパティ詳細は参加者に関するプロパティを参照してください。
watchers watchersCandidate	ー	"watchers": [ { "id": "1", "code": "takahashi-keiko", "name": "Keiko TAKAHASHI", "type": "USER" } ], "watchersCandidate": [ { "id": "1", "code": "takahashi-keiko", "name": "Keiko TAKAHASHI", "type": "USER" } ]	共有先に関するプロパティ詳細は参加者に関するプロパティを参照してください。
facilities facilitiesCandidate facilityUsageRequests facilityReservationInfo facilityUsingPurpose	ー	"facilities": [ { "id": "3", "name": "Web会議室", "code": "Web会議室" } ], "facilitiesCandidate": [ { "id": "3", "name": "Web会議室", "code": "FA_WEB" } ], "facilityUsageRequests": [ { "status ": "IN_PROGRESS", "facility": { "id": "3", "name": "Web会議室", "code": "FA_WEB" }, "approvedBy": { "id": "1", "code": "sato-noboru", "name": "Noboru SATO" }, "approvedDateTime": "2017-09-26T06:25:18Z" } ], "facilityUsingPurpose": "TEST", "facilityReservationInfo": { "itemA": { "type": "SINGLE_LINE_TEXT", "value": "test" } }	施設に関するプロパティ詳細は施設に関するプロパティを参照してください。
repeatInfo temporaryEventCandidates	ー	"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": "" }, "dayOfWeek": "MON", "dayOfMonth": "EOM", "exclusiveDateTimes": [ { "start": "2017-12-28T00:00:00+09:00", "end": "2017-12-29T00:00:00+09:00" } ] }, "temporaryEventCandidates": [ { "end": { "dateTime": "2017-06-06T09:00:00+09:00", "timeZone": "Asia/Tokyo" }, "start": { "dateTime": "2017-06-06T09:00:00+09:00", "timeZone": "Asia/Tokyo" }, "facility": { "id": "1", "code": "room-a", "name": "ROOM-A" } } ]	繰り返し予定に関するプロパティ詳細は繰り返し予定に関するプロパティを参照してください。
kintone	配列（オブジェクト）	"kintone": [ { "appId": 123, "recordId": 456 } ]	kintone連携項目に関するプロパティ詳細は kintone連携項目に関するプロパティを参照してください。
additionalItems	オブジェクト	"additionalItems": { "item": { "value": "string" } }	カスタム項目（additionalItems）に関するプロパティ詳細はカスタム項目（additionalItems）に関するプロパティを参照してください。

^*1 パッケージ版Garoon 5.0〜5.5.1でのみ指定できます。 ^

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

固定リンクがコピーされました

プロパティ名	型	例	説明
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	文字列		電話番号

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

固定リンクがコピーされました

予定にファイルを添付するには、システム設定で予定へのファイル添付を許可してください。
詳細は、Garoonヘルプ（クラウド版｜パッケージ版）を確認してください。

プロパティ名	型	例	説明
attachments	配列	"attachments": [ { "id": "1", "name": "figure.png", "contentType": "image/png", "size": "64251", "content": "abcde" } ]	添付ファイルクラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
attachments[].id	文字列		ファイルID
attachments[].contentType	文字列		コンテンツタイプ
attachments[].name	文字列		ファイル名
attachments[].size	文字列		ファイルのサイズ（byte）
attachments[].content	文字列		ファイルの内容予定を登録するAPI や予定を更新するAPI で指定できるプロパティです。その他のREST APIやJavaScript APIでは、値を取得できません。

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

固定リンクがコピーされました

プロパティ名	型	例	説明
start	オブジェクト	"start": { "dateTime": "2017-09-27T14:00:00+09:00", "timeZone": "Asia/Tokyo" }	予定の開始日時に関する情報繰り返し予定の場合、次のJavaScript APIで取得できます。予定の登録に成功したときのイベント予定の変更に成功したときのイベント予定の詳細画面を表示したときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定を削除するときのイベント予定の削除に成功したときのイベント予定の詳細画面で予定の値を取得するAPI を実行したとき開始日時に関するその他の注意事項は、次を参照してください。タイムゾーンの扱い終日予定における開始日時と終了日時時間フィールドや分フィールドが指定されていない場合の開始日時
start.dateTime	文字列		予定の開始日時形式はRFC 3339です。
start.timeZone	文字列		開始日時のタイムゾーン
end	オブジェクト	"end": { "dateTime": "2017-09-27T15:00:00+09:00", "timeZone": "Asia/Tokyo" }	予定の終了日時に関する情報繰り返し予定の場合、次のJavaScript APIで取得できます。予定の登録に成功したときのイベント予定の変更に成功したときのイベント予定の詳細画面を表示したときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定を削除するときのイベント予定の削除に成功したときのイベント予定の詳細画面で予定の値を取得するAPI を実行したとき終了日時に関するその他の注意事項は、次を参照してください。タイムゾーンの扱い終日予定における開始日時と終了日時
end.dateTime	文字列		予定の終了日時形式はRFC 3339です。
end.timeZone	文字列		終了日時のタイムゾーン
isAllDay	真偽値	"isAllDay": false	終日予定かどうか `true`：終日予定である `false`：終日予定ではないクラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
isStartOnly	真偽値	"isStartOnly": false	開始のみの予定かどうか `true`：開始のみの予定 `false`：開始と終了が設定された予定クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベント予定の変更に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
originalStartTimeZone	文字列	"originalStartTimeZone": "Asia/Tokyo"	`start.timeZone`または`repeatInfo.timeZone`に設定されたタイムゾーン次のJavaScript APIで取得できます。予定の詳細画面を表示したときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の詳細画面で予定の値を取得するAPI を実行したとき
originalEndTimeZone	文字列	"originalEndTimeZone": "Asia/Tokyo"	`end.timeZone`または`repeatInfo.timeZone`に設定されたタイムゾーン次のJavaScript APIで取得できます。予定の詳細画面を表示したときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の詳細画面で予定の値を取得するAPI を実行したとき

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

固定リンクがコピーされました

プロパティ名	型	例	説明
attendees	配列	"attendees": [ { "id": "1", "code": "sato-noboru", "name": "Noboru SATO", "type": "USER", "attendanceResponse": { "status": "PENDING", "comment": "I am going to attend the meeting." } } ]	参加者の一覧クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
attendees[].id	文字列		参加者のGaroonユーザーID
attendees[].code	文字列		参加者のコード `type`の値によって異なります。 `ORGANIZATION`：組織コード `USER`：ログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
attendees[].name	文字列		参加者の表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
attendees[].type	文字列		参加者のタイプ利用可能な値は次のとおりです。 `ORGANIZATION`：組織 `USER`：ユーザー
attendees[].attendanceResponse	オブジェクト		参加者の出欠確認の情報予定の出欠確認をするには、システム設定で「出欠確認の使用」（クラウド版｜パッケージ版）を許可してください。
attendees[].attendanceResponse.status	文字列		参加者の出欠確認の状態利用可能な値は次のとおりです。 `PENDING`：未回答 `ACCEPTED`：出席 `DECLINED`：欠席
attendees[].attendanceResponse.comment	文字列		参加者が出欠確認に回答したときのメッセージ
attendeesCandidate	配列	"attendeesCandidate": [ { "id": "1", "code": "suzuki-takeshi", "name": "Takeshi SUZUKI", "type": "USER" }	参加者の候補一覧次のイベントを除くJavaScript APIで取得できます。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
attendeesCandidate[].id	文字列		参加者の候補リストのGaroonユーザーID
attendeesCandidate[].code	文字列		参加者の候補リストのログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
attendeesCandidate[].name	文字列		参加者の候補リストの表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
attendeesCandidate[].type	文字列		参加者の候補リストのタイプ

共有先に関するプロパティ

固定リンクがコピーされました

パッケージ版5.5以前では、項目「共有先」の名称は「公開先」です。

プロパティ名	型	例	説明
watchers	配列	"watchers": [ { "id": "1", "code": "takahashi-keiko", "name": "Keiko TAKAHASHI", "type": "USER" } ]	共有先クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
watchers[].id	文字列		共有先のGaroonユーザーID
watchers[].code	文字列		共有先のログイン名 `type`の値によって異なります。 `USER`：ログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。 `ORGANIZATION`：組織コード `ROLE`：ロール名
watchers[].name	文字列		共有先の表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
watchers[].type	文字列		共有先のタイプ `ORGANIZATION`：組織 `USER`：ユーザー `ROLE`：ロール
watchersCandidate	配列	"watchersCandidate": [ { "id": "1", "code": "takahashi-keiko", "name": "Keiko TAKAHASHI", "type": "USER" } ]	共有先の候補一覽次のイベントを除くJavaScript APIで取得できます。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
watchersCandidate[].id	文字列		共有先の候補一覽の表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
watchersCandidate[].code	文字列		共有先の候補一覽のログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
watchersCandidate[].name	文字列		共有先の候補一覽の表示名
watchersCandidate[].type	文字列		共有先の候補リストのタイプ

施設に関するプロパティ

固定リンクがコピーされました

プロパティ名	型	例	説明
facilities	配列	"facilities": [ { "id": "3", "name": "Web会議室", "code": "Web会議室" } ],	施設の一覽クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
facilities[].id	文字列		施設名ID
facilities[].name	文字列		施設名
facilities[].code	文字列		施設コード
facilitiesCandidate	配列	"facilitiesCandidate": [ { "id": "3", "name": "Web会議室", "code": "FA_WEB" } ]	施設の候補一覽次のイベントを除くJavaScript APIで取得できます。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
facilitiesCandidate[].id	文字列		施設の候補リストの施設ID
facilitiesCandidate[].name	文字列		施設の候補リストの施設名
facilitiesCandidate[].code	文字列		施設の候補リストの施設コード
facilityUsageRequests	配列	"facilityUsageRequests": [ { "status ": "IN_PROGRESS", "facility": { "id": "3", "name": "Web会議室", "code": "FA_WEB" }, "approvedBy": { "id": "1", "code": "sato-noboru", "name": "Noboru SATO" }, "approvedDateTime": "2017-09-26T06:25:18Z" } ]	施設の予約情報クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
facilityUsageRequests[].status	文字列		承認ステータス利用可能な値は次のとおりです。 `IN_PROGRESS`：申請中 `APPROVED`：承認 `REJECTED`：却下
facilityUsageRequests[].facility	オブジェクト		予約された施設
facilityUsageRequests[].facility.id	文字列		予約された施設ID
facilityUsageRequests[].facility.name	文字列		予約された施設名
facilityUsageRequests[].facility.code	文字列		予約された施設コード
facilityUsageRequests[].approvedBy	オブジェクト	"approvedBy": { "id": "1", "code": "sato-noboru", "name": "Noboru SATO"}	承認者の情報
facilityUsageRequests[].approvedBy.id	文字列		承認者のGaroonユーザーID
facilityUsageRequests[].approvedBy.code	文字列		承認者のログイン名パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。
facilityUsageRequests[].approvedBy.name	文字列		承認者の表示名個人設定の「ユーザー名の後に表示する情報」の設定が適用されます。
facilityUsageRequests[].approvedDateTime	文字列		申請が承認された日時形式はISO8601のUTCタイムゾーンです。
facilityReservationInfo	オブジェクト	"facilityReservationInfo": { "itemA": { "type": "SINGLE_LINE_TEXT", "value": "test" } }	施設予約情報の項目クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
facilityReservationInfo.`ITEM_CODE`.type	文字列	-	カスタマイズ項目のタイプ利用可能な値は次のとおりです。 `SINGLE_LINE_TEXT`：文字列（1行） `MULTI_LINE_TEXT`：文字列（複数） `DROP_DOWN`：メニュー
facilityReservationInfo.`ITEM_CODE`.value	文字列	-	カスタマイズ項目の値
facilityUsingPurpose	文字列	"facilityUsingPurpose": "TEST"	施設の利用目的クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベントシステム設定で、「施設の利用申請」（クラウド版｜パッケージ版）を有効にしてください。

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

固定リンクがコピーされました

プロパティ名	型	例	説明
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": "" }, "dayOfWeek": "MON", "dayOfMonth": "EOM", "exclusiveDateTimes": [ { "start": "2017-12-28T00:00:00+09:00", "end": "2017-12-29T00:00:00+09:00" } ] }	繰り返し予定クラウド版およびパッケージ版における、次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベントパッケージ版における次のイベントでは取得できません。予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
repeatInfo.type	文字列		繰り返し条件利用可能な値は次のとおりです。 `EVERY_DAY`：毎日 `EVERY_WEEKDAY`：毎日（土日を除く） `EVERY_WEEK`：毎週 `ONCE_EVERY_TWO_WEEKS`：2週間ごと ^1 `ONCE_EVERY_THREE_WEEKS`：3週間ごと ^1 `EVERY_1STWEEK`：毎月第1 `EVERY_2NDWEEK`：毎月第2 `EVERY_3RDWEEK`：毎月第3 `EVERY_4THWEEK`：毎月第4 `EVERY_LASTWEEK`：毎月最終 `EVERY_MONTH`：毎月
repeatInfo.range	オブジェクト		繰り返し予定の範囲
repeatInfo.range.type	文字列		繰り返し予定の範囲のタイプデフォルトは空文字列です。利用可能な値は次のとおりです。 `THIS_EVENT_ONLY`：今回の予定だけ `ON_AND_AFTER_THIS_EVENT`：変更する日以降の予定 `ALL_EVENT`：すべての予定
repeatInfo.range.date	文字列		現在編集中の繰り返し予定の日付 YYYY-MM-DD形式です。
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	真偽値		繰り返し予定が終日の予定かどうか `true`：終日予定である `false`：終日予定ではない
repeatInfo.isStartOnly	真偽値		繰り返し予定が開始のみの予定かどうか `true`：開始のみの予定 `false`：開始と終了が設定された予定
repeatInfo.timeZone	文字列		`repeatInfo.time`に指定した値のタイムゾーン
repeatInfo.dayOfWeek	文字列		週次の繰り返し予定の曜日利用可能な値は次のとおりです。 `MON`：月曜日 `TUE`：火曜日 `WED`：水曜日 `THU`：木曜日 `FRI`：金曜日 `SAT`：土曜日 `SUN`：日曜日
repeatInfo.dayOfMonth	文字列		月次の繰り返し予定の日付利用可能な値は次のとおりです。 1〜31：数字の日にちたとえば、毎月1日の場合には、「1」が返ります。 `EOM`：月末
repeatInfo.exclusiveDateTimes	配列		繰り返し予定から分離された予定の一覧
repeatInfo.exclusiveDateTimes[].start	文字列		繰り返し予定から分離された予定の開始日時形式はRFC 3339です（タイムゾーン含む）。
repeatInfo.exclusiveDateTimes[].end	文字列		繰り返し予定から分離された予定の終了日時形式はRFC 3339です（タイムゾーン含む）。
repeatInfo.temporaryEventCandidates[]	配列	"temporaryEventCandidates": [ { "end": { "dateTime": "2017-06-06T09:00:00+09:00", "timeZone": "Asia/Tokyo" }, "start": { "dateTime": "2017-06-06T09:00:00+09:00", "timeZone": "Asia/Tokyo" }, "facility": { "id": "1", "code": "room-a", "name": "ROOM-A" } } ]	期間予定情報 REST APIでのみ操作できます。
temporaryEventCandidates	配列		期間予定情報
temporaryEventCandidates[].start.dateTime	文字列		期間予定の開始日時形式はRFC 3339です。
temporaryEventCandidates[].start.timeZone	文字列		期間予定の開始日時のタイムゾーン
temporaryEventCandidates[].end.dateTime	文字列		期間予定の終了日時形式はRFC 3339です。
temporaryEventCandidates[].end.timeZone	文字列		期間予定の終了日時のタイムゾーン
temporaryEventCandidates[].facility.id	文字列		期間予定の施設ID
temporaryEventCandidates[].facility.code	文字列		期間予定の施設コード
temporaryEventCandidates[].facility.name	文字列		期間予定の施設名

^*1 クラウド版およびパッケージ版Garoon 6.0以降でのみ指定できます。 ^

kintone連携項目に関するプロパティ

固定リンクがコピーされました

クラウド版Garoonで、予定に関連付けられたkintoneの連携項目に関するプロパティです。
クラウド版Garoonヘルプ：kintone連携の設定

このプロパティは、Garoonのアップデートオプションで次の項目が有効になっていると利用できます。
「予定を取得するAPIの値に、スケジュールのkintone連携で設定しているアプリの情報を追加」
アップデートオプションを有効にする手順は、次のページを参照してください。
Garoonクラウド版ヘルプ：Garoonの新機能を有効または無効にする

プロパティ名	型	例	説明
kintone	オブジェクト	"kintone": [ { "appId": 123, "recordId": 456 } ]	関連付けられたkintoneの情報連携項目の設定がない、または予定に関連付けられたkintoneの連携項目がない場合は、空配列が返ります。次のイベントまたはAPIで取得できます。 JavaScript API 予定を登録するときのイベント予定の登録に成功したときのイベント予定の変更画面を表示した後のイベント予定を変更するときのイベント予定の変更に成功したときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定を削除するときのイベント予定の削除に成功したときのイベント予定の詳細画面を表示した後のイベント予定の値を取得する REST API 1件の予定を取得する複数の予定を取得する
kintone[].appId	文字列		関連付けられたkintoneのアプリのID
kintone[].recordId	文字列		関連付けられたkintoneのレコードID

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

固定リンクがコピーされました

カスタム項目は、他サービスとAPIを連携して取得した値など、予定に付加情報を保存するための項目です。
保存した値は、予定の各画面には表示されません。

カスタム項目（additionalItems）の廃止について

このプロパティは、クラウド版およびパッケージ版Garoon 6.0以降で廃止されました。
予定に付加情報を保存したい場合は、「予定のカスタム項目（Schedule datastore）」を利用してください。

REST API：予定のカスタム項目（Schedule datastore）を取得する
JavaScript API：カスタム項目（Schedule datastore）の値を取得する

注意事項

カスタム項目を利用する場合、同じようにカスタム項目を利用する別のカスタマイズは、同時に適用できません。
他のカスタマイズにより、上書きされてしまう可能性があります。

カスタム項目（additionalItems）のプロパティ

プロパティ名	型	例	説明
additionalItems	オブジェクト	"additionalItems": { "item": { "value": "string" } }	次のイベントでは取得できません。予定を削除するときのイベント予定の参加に成功したときのイベント予定から抜けることに成功したときのイベント予定の登録に成功したときのイベントポップアップウィンドウで予定の登録に成功したときのイベント予定の変更に成功したときのイベントドラッグ&ドロップで予定の変更に成功したときのイベント
additionalItems.item.value	文字列		予定の付加情報

閲覧権限がない予定で取得できるプロパティ

固定リンクがコピーされました

複数の予定を取得するAPI のリクエストパラメーターで、「showPrivate=true」を指定したときに取得できる予定のプロパティは、次のとおりです。

id：値は「0」です。
subject：APIを実行するユーザーの言語設定に応じて、次の文字列が返ります。
- 日本語：「予定あり」
- 英語：「Private appointment」
- 中国語（簡体字）：「已有安排」
- 中国語（繁体字）：「已有安排」
eventType：「REGULAR」「REPEATING」が返ります。
visibilityType
start
end
isAllDay
isStartOnly
originalStartTimeZone
originalEndTimeZone
attendees
- targetTypeに「user」または「organization」を設定している場合には、targetに指定したユーザーまたは組織の情報だけ返ります。
- targetTypeに「facility」を設定している場合には、このプロパティは返りません。
facilities
- targetTypeにfacilityを設定している場合には、targetに指定した施設の情報だけ返ります。
- targetTypeに「user」または「organization」を設定している場合には、このプロパティは返りません。

注意事項

固定リンクがコピーされました

タイムゾーンの扱い

固定リンクがコピーされました

Garoon JavaScript APIで取得したとき

次のAPIで取得したスケジュールオブジェクトのstartとendには、画面に表示されているタイムゾーンが適用されます。

たとえばタイムゾーンを「Asia/Tokyo」に設定しているユーザーが、「America/Los_Angeles」に設定しているユーザーが登録した予定を変更するとします。
このとき、予定を変更するときのイベントで取得したstartとendのタイムゾーンには、予定を登録したユーザーの「America/Los_Angeles」が適用されます。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "start": {
    "dateTime": "2023-01-03T08:00:00-08:00",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2023-01-03T09:00:00-08:00",
    "timeZone": "America/Los_Angeles"

  },
  "originalStartTimeZone": undefined,
  "originalEndTimeZone": undefined
}

予定の詳細画面を表示した後のイベントで取得したstartとendのタイムゾーンには、ログインユーザーの「Asia/Tokyo」が適用されます。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "start": {
    "dateTime": "2023-01-04T01:00:00+09:00",
    "timeZone": "Asia/Tokyo"
  },
  "end": {
    "dateTime": "2023-01-04T02:00:00+09:00",
    "timeZone": "Asia/Tokyo"
  },
  "originalStartTimeZone": "America/Los_Angeles",
  "originalEndTimeZone": "America/Los_Angeles"
}

Garoon REST APIで取得したとき

次のAPIで取得したスケジュールオブジェクトのstartとendには、APIを実行したユーザーのタイムゾーンが適用されます。

終日予定における開始日時と終了日時

固定リンクがコピーされました

終日予定におけるstart.dateTimeおよびend.dateTimeの時刻は、「00:00±hh:mm」が返ります。
適用されるタイムゾーンはタイムゾーンの扱いを参照してください。

時間フィールドや分フィールドが指定されていない場合の開始日時

固定リンクがコピーされました

時間フィールドだけを指定した場合、start.dateTimeの時刻は「HH:00±hh:mm」が返ります。
例：時間が「10」で分が未指定「--」の場合、「10:00±hh:mm」

分フィールドだけを指定した場合、start.dateTimeの時刻は「00:00±hh:mm」が返ります。
例：時間が未指定「--」で分「30」の場合、「00:00±hh:mm」

適用されるタイムゾーンはタイムゾーンの扱いを参照してください。

カスタム項目（Schedule datastore)

固定リンクがコピーされました

カスタム項目（Schedule datastore）の命名規則は、カスタム項目（Schedule datastore）の値をセットするを参照ください。

Garoon APIドキュメント

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

目次

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

基本プロパティ

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

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

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

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

共有先に関するプロパティ

施設に関するプロパティ

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

kintone連携項目に関するプロパティ

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

カスタム項目（additionalItems）の廃止について

注意事項

カスタム項目（additionalItems）のプロパティ

閲覧権限がない予定で取得できるプロパティ

注意事項

タイムゾーンの扱い

Garoon JavaScript APIで取得したとき

Garoon REST APIで取得したとき

終日予定における開始日時と終了日時

時間フィールドや分フィールドが指定されていない場合の開始日時

カスタム項目（Schedule datastore)