get_resource_schedule detail design
- Operation:
getResourceSchedule - Endpoint:
GET /resources/{resourceId}/schedule
1. 正常系入力
| Location | Name | Type | 説明 |
|---|---|---|---|
path |
resourceId |
ResourceId |
予約対象の資源を一意に識別するIDです。 |
Request body はありません。
2. 正常系前提
- 例外処理: ROUTER_HANDLED_EXCEPTIONS: 発生しない
3. 正常系リソース変更
正常系で作成/更新/削除するリソースはありません。
4. 正常系レスポンス
- Response model:
GetResourceScheduleResponse
| 項目 | 説明 | 値の取得元 |
|---|---|---|
items |
一覧レスポンスに含まれるリソース配列です。 | |
items.startAt |
予約済み時間帯の開始日時です。 | booking.start_at |
items.endAt |
予約済み時間帯の終了日時です。この時刻を含みません。 | booking.end_at |
items.label |
共有予約表に表示する固定の表示名です。 | BUSY_SLOT_LABEL |
items.reservation |
呼び出し元が予約者本人または管理者の場合だけ返す予約の詳細です。 | |
items.reservation.reservationId |
予約を一意に識別するIDです。 | row.reservation_id |
items.reservation.resourceId |
予約対象の資源を一意に識別するIDです。 | row.resource_id |
items.reservation.ownerPrincipalId |
予約者を表す認証主体IDです。 | row.owner_principal_id |
items.reservation.startAt |
予約開始日時です。 | row.start_at |
items.reservation.endAt |
予約終了日時です。この時刻を含みません。 | row.end_at |
items.reservation.purpose |
予約目的です。本人と管理者だけに返します。 | row.purpose |
items.reservation.status |
予約の状態です。 | ReservationStatus(row.status) |
items.reservation.version |
予約取消の楽観ロックに使う版です。 | row.row_version |
nextToken |
次ページを取得するために前回レスポンスから受け取る継続tokenです。 | page.next_token |