ToDo を登録する
ToDo を登録する
API を実行したユーザー個人の ToDo リストに新しい ToDo を登録します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/todo/todos
パッケージ版
- Windows 環境
- http://
サーバーのIPアドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/todo/todos - Linux 環境
- http://
サーバーのIPアドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/todo/todos
HTTP メソッド
POST
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 6.0 以降
必要なアクセス権
なし
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
category | 数値 | 省略可 | カテゴリー ID 省略すると、「すべて」のカテゴリが設定されます。 |
subject | 文字列 | 必須 | ToDo 名 100 文字以内で指定します。 |
dueDate | 文字列 | 省略可 | ToDo の締切日 ISO8601 形式で表示されます。 省略すると、「締切日なし」が設定されます。 |
priority | 数値 | 省略可 | ToDo の重要度 次のいずれかの値を指定します。数が大きいほど重要度は高くなります。
|
notes | 文字列 | 省略可 | メモ 改行文字は「\n」です。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/todo/todos
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
id | 数値 | ToDo の ID |
status | 文字列 | ToDo のステータス 次のいずれかの値が返ります。
|
category | 数値 | ToDo のカテゴリー ID |
subject | 文字列 | ToDo 名 |
hasDueDate | 真偽値 | 締切日があるかどうか
|
dueDate | 文字列 | ToDo の締切日 形式は ISO8601 の UTC タイムゾーンです。 hasDueDate の値が false の場合、このプロパティはオブジェクトに含まれません。 |
priority | 数値 | ToDo の重要度 次のいずれかの値が返ります。数が大きいほど重要度は高くなります。
|
notes | 文字列 | メモ 改行文字は「\n」です。 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|
注意事項
- スペースの共有 ToDo は操作できません。