プロパティ
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| id | integer | ID | ○ |
| type | string | タイプ*1 | ○ |
| title | string | タイトル | |
| owner | User | オーナー | |
| creator | User | 作成者*2 | ○ |
| users | list | 参加ユーザーIDリスト | ○ |
| groups | list | 参加スタッフグループIDリスト | |
| has_confirm | boolean | 内容確認があるか ※参加スタッフでない場合はレスポンスに含まれない | ○ |
| confirmed | boolean | 認可ユーザーが確認済みか ※参加スタッフでない場合や内容確認がない場合は、レスポンスに含まれない | ○ |
| has_question | boolean | アンケートのあるトピックか | ○ |
| related_event | Event | 関連予定 | ○ |
| created_datetime | datetime | 作成日時 | ○ |
| updated_datetime | datetime | 更新日時 | ○ |
*1 typeでは以下の値を返します。
| 値 | 説明 |
|---|---|
| regular | 通常トピック |
| event | 予定関連トピック |
*2 creatorでは以下の値を返します。
| 値 | 説明 |
|---|---|
| id | user_idの値 |
| name | ユーザー名 ※フルネーム |
| last_name | 苗字の値 |
| last_name_kana | 苗字の値（カナ） |
| first_name | 名の値 |
| first_name_kana | 名の値（カナ） |
| full_name | ユーザー名 ※フルネーム |
| full_name_kana | ユーザー名（カナ） ※フルネーム |
| memo | メモ値 |
| role | ユーザータイプ |
| mail_address1 | メールアドレス値 |
| mail_address2 | サブメールアドレス値 |
メソッド
| メソッド名 | HTTPメソッド | パス | 処理 |
|---|---|---|---|
| リスト | GET | /messages/ | トピックのリストを返す |
| 取得 | GET | /messages/[message_id] | 指定されたトピックの要素を取得する |
| 作成 | POST | /messages/ | トピックを作成する |
| 変更 | PUT | /messages/[message_id] | 指定されたトピック情報を変更する（全項目差し替え） ※予定関連トピックの参加者は変更不可 |
| 部分変更 | PATCH | /messages/[message_id] | 指定されたトピック情報を部分的に変更する |
| 削除 | DELETE | /messages/[message_id] | 指定されたトピックを削除する |
関連リソース
| リソース名 | パス | 説明 |
|---|---|---|
| comments | リソース名の遷移先参照 | リソース名の遷移先参照 |
| users | /messages/[message_id]/users/ | 参加ユーザーのリストを返す ※ロールに関わらず |
| confirmed_users | /messages/[message_id]/confirmed_users/ | 内容確認済みユーザーのリストを返す |
| user_groups | /messages/[message_id]/user_groups/ | 指定したトピックの参加ユーザーグループのリストを返す |