プロパティ
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| id | integer | ID | ○ |
| name | string | タスク名 | |
| description | string | 詳細 | |
| limit_datetime | datetime | 期限 | |
| is_all_day | boolean | 終日のタスクか | |
| assigned_users | list | 担当スタッフIDリスト | ○ |
| end_datetime | list | 完了スタッフIDリスト | |
| completed | boolean | 認可ユーザーが完了しているか | |
| show_on_creator_calendar | boolean | 作成スタッフのカレンダーに表示するか ※作成スタッフのみ | |
| notify_complete | boolean | 完了時に作成スタッフに通知するか ※作成スタッフのみ | |
| shared_users | list | 共有先スタッフIDリスト | |
| shared_staff_groups | list | 共有先グループIDリスト | |
| show_on_sharer_calendar | boolean | 共有先カレンダーに表示するか ※電話メモは変更不可 | |
| creator | User | 作成スタッフ*1 | ○ |
| is_telephone_memo | boolean | 電話メモか | ○ |
| created_datetime | datetime | 作成日時 | ○ |
| updated_datetime | datetime | 更新日時 | ○ |
*1 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 | /tasks/ | タスクのリストを返す |
| 取得 | GET | /tasks[task_id] | 指定されたタスクの要素を取得する |
| 作成 | POST | /tasks/ | タスクを作成する ※電話メモの作成は不可 |
| 変更 | PUT | /tasks/[task_id] | 指定されたタスク情報を変更する(全項目差し替え) ※電話メモは変更不可 |
| 部分変更 | PATCH | /tasks/[task_id] | 指定されたタスクを部分的に変更する |
| 削除 | DELETE | /tasks/[task_id] | 指定されたタスクを削除する |
関連リソース
| リソース名 | パス | 説明 |
|---|---|---|
| assigned_users | /tasks/[task_id]/assigned_users/ | 担当ユーザーのリストを取得 |
| completed_users | /tasks/[task_id]/completed_users/ | タスクを完了した担当ユーザーのリストを取得 |
| incompleted_users | /tasks/[task_id]/incompleted_users/ | タスクを完了していない担当ユーザーのリストを取得 |
| shared_users | /tasks/[task_id]/shared_users/ | タスクを共有されたユーザーのリストを取得 |
| shared_user_groups | /tasks/[task_id]/shared_user_groups/ | タスクを共有されたユーザーグループのリストを取得 |
