Garoon API ドキュメント

ToDo を取得する

目次

ToDo を取得する

固定リンクがコピーされました

ToDoのIDを指定することで、APIを実行したユーザー個人のToDoリストのToDoを取得します。

URL

固定リンクがコピーされました

クラウド版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoonのインストール識別子

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

パッケージ版
Windows環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/todo/todos/TODO_ID
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/todo/todos/TODO_ID
パスパラメーター
パラメーター名 説明
TODO_ID 取得する ToDo の ID

HTTP メソッド

固定リンクがコピーされました

GET

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 6.0以降

必要なアクセス権

固定リンクがコピーされました

なし

リクエスト

固定リンクがコピーされました

パラメーター

なし

リクエストの例
URL

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

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
id 数値 ToDo の ID
status 文字列 ToDo のステータス
次のいずれかの値が返ります。
  • Completed：完了
  • Uncompleted：未処理
category 数値 ToDo のカテゴリー ID
ToDo が「すべて」のカテゴリーにある場合は、0が返されます。
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": "Completed",
  "category": 123,
  "subject": "Implement Unit test",
  "hasDueDate": true,
  "dueDate": "2023-01-14T00:00:00+09:00",
  "priority": 2,
  "notes": "This is todo note. You can write multiple lines."
}

サンプルコード

固定リンクがコピーされました

curl を使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/todo/todos/3' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する APIを使ったリクエスト
1

await garoon.api('/api/v1/todo/todos/3', 'GET', {});

注意事項

固定リンクがコピーされました

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