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