プロパティ
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| id | integer | ID | ○ |
| name | string | グループ名 | |
| description | string | 説明 | |
| users | list | 参加スタッフIDリスト リスト及び/groupsのエンドポイント以外のレスポンスには含まれません | |
| is_incomplete | boolean | 登録が完了しているか | ○ |
| created_datetime | datetime | 作成日時 | ○ |
| updated_datetime | datetime | 更新日時 | ○ |
メソッド
| メソッド名 | HTTPメソッド | パス | 処理 |
|---|---|---|---|
| リスト | GET | /groups/ | グループ情報リストを返す |
| 取得 | GET | /groups/[group_id] | 指定されたグループ情報を取得する |
| 作成 | POST | /groups/ | グループを作成する |
| 変更 | PUT | /groups/[group_id] | グループ情報を変更する |
| 削除 | DELETE | /groups/[group_id] | 指定グループを削除する |
関連リソース
| リソース名 | パス | 説明 |
|---|---|---|
| users | /groups/[group_id]/users | グループに参加しているスタッフのリストを返す |