空き予定の検索
ユーザー・組織・施設の利用可能時間を検索できます。
HTTP メソッド
POST
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/schedule/searchAvailableTimes
使用可能なガルーンのバージョン
- クラウド版 Garoon
リクエストの例
POST /g/api/v1/schedule/searchAvailableTimes HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
リクエストボディ
リクエストボディには、次のパラメータが必須です。
- timeRanges
①start ②end が必須です。 - timeInterval
- attendees、またはfacilities
少なくとも1人の参加者、または1つの施設が必須です。
それぞれ ①type ②idまたはcode が必須です。
| パラメータ | 指定する値 | 説明 |
|---|---|---|
| timeRanges | 配列 | 時間範囲 |
| timeRanges[].start | 文字列 | 時間範囲の開始時間 |
| timeRanges[].end | 文字列 | 時間範囲の終了時間 |
| timeInterval | 数値 | 時間間隔 最小：1 最大：1,439 |
| attendees | 配列 | 参加者のリスト |
| attendees[].id | 文字列 |
参加者のユーザーID |
| attendees[].type | 文字列 | 参加者のタイプ |
| attendees[].code | 文字列 | attendees[].type プロパティの value により異なります。
|
| 配列 | 施設のリスト | |
| facilities[].id | 数値 | 施設ID |
| facilities[].code | 文字列 | 施設コード |
| facilitySearchCondition | 文字列 |
施設検索の条件
|
レスポンスの例
処理が成功すると、予定の内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| availableTimes[].start.dateTime | 文字列 |
空き予定の開始日時 |
| availableTimes[].start.timeZone | 文字列 |
空き予定の開始日時のタイムゾーン |
| availableTimes[].end.dateTime | 文字列 |
空き予定の終了日時 |
| availableTimes[].end.timeZone | 文字列 |
空き予定の終了日時のタイムゾーン |
| facility.id | 数値 |
組織ID |
| facility.code | 文字列 |
組織コード |
| facility.name | 文字列 |
組織名 |
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。