ToDo リストのカテゴリーを取得する
ToDo リストのカテゴリーを取得する
API を実行したユーザー個人の ToDo リストのカテゴリーを取得します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/todo/categories
パッケージ版
- Windows 環境
- http://
サーバーのIPアドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/todo/categories - Linux 環境
- http://
サーバーのIPアドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/todo/categories
HTTP メソッド
GET
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 6.0 以降
必要なアクセス権
なし
リクエスト
パラメーター
リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、
Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
limit | 数値 | 省略可 | 取得するカテゴリーの制限数 1 から 1,000 まで指定できます。省略すると 100 が設定されます。 指定された条件に一致するカテゴリーが他にある場合でも、指定した値より取得できるカテゴリー数が少なくなる可能性があります。 |
offset | 数値 | 省略可 | 取得するカテゴリーの先頭からスキップする数 省略すると、 0 が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/todo/categories?limit=30
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
categories | 配列 | カテゴリーの配列 |
categories.id | 数値 | カテゴリー ID |
categories.name | 文字列 | カテゴリー名 |
hasNext | 真偽値 | 次のカテゴリーがあるかどうか
|
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|
注意事項
- スペースの共有 ToDo は操作できません。