Garoon API ドキュメント

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 の重要度
次のいずれかの値を指定します。数が大きいほど重要度は高くなります。
  • 1
  • 2
  • 3
省略すると、初期値の「2」が設定されます。
notes 文字列 省略可 メモ
改行文字は「\n」です。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/todo/todos

ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

ボディ
1
2
3
4
5
6
7

{
  "category": 0,
  "subject": "Todo 1",
  "dueDate": "2023-01-12T12:00:00+07:00",
  "priority": 1,
  "notes": "It is notes"
}

レスポンス

プロパティ
プロパティ名 型 説明
id 数値 ToDo の ID
status 文字列 ToDo のステータス
次のいずれかの値が返ります。
  • Completed：完了
  • Uncompleted：未処理
category 数値 ToDo のカテゴリー ID
subject 文字列 ToDo 名
hasDueDate 真偽値 締切日があるかどうか
  • true：ToDo の締切日が設定されている
  • false：ToDo の締切日が設定されていない
dueDate 文字列 ToDo の締切日
形式は ISO8601 の UTC タイムゾーンです。
hasDueDate の値が false の場合、このプロパティはオブジェクトに含まれません。
priority 数値 ToDo の重要度
次のいずれかの値が返ります。数が大きいほど重要度は高くなります。
  • 1
  • 2
  • 3
notes 文字列 メモ
改行文字は「\n」です。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "id": 1,
  "status": "Uncompleted",
  "category": 0,
  "subject": "Todo 1",
  "hasDueDate": true,
  "dueDate": "2023-01-12T12:00:00+07:00",
  "priority": 1,
  "notes": "It is notes"
}

サンプルコード

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

curl -X POST 'https://sample.cybozu.com/g/api/v1/todo/todos' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": 0,
    "subject": "Todo 1",
    "dueDate": "2023-01-12T12:00:00+07:00",
    "priority": 1,
    "notes": "It is notes"
  }'
Garoon REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6
7
8
9

const body = {
  category: 0,
  subject: 'Todo 1',
  dueDate: '2023-01-12T12:00:00+07:00',
  priority: 1,
  notes: 'It is notes'
};

await garoon.api('/api/v1/todo/todos', 'POST', body);

注意事項

  • スペースの共有 ToDo は操作できません。