Garoon API ドキュメント

ToDo リストのカテゴリーを取得する

目次

ToDo リストのカテゴリーを取得する

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

APIを実行したユーザー個人のToDoリストのカテゴリーを取得します。

URL

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

クラウド版

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

パッケージ版

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

  • IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoonのインストール識別子
Windows環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/todo/categories
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/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

ヘッダー
1
2
3

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

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

ボディ
1
2
3

{
  "limit": 30
}

レスポンス

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

プロパティ
プロパティ名 型 説明
categories 配列 カテゴリーの配列
categories.id 数値 カテゴリー ID
categories.name 文字列 カテゴリー名
hasNext 真偽値 次のカテゴリーがあるかどうか
  • true：次のカテゴリーがある
  • false：次のカテゴリーがない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "categories": [
    {
      "id": "1",
      "name": "category 1"
    },
    {
      "id": "3",
      "name": "category 3"
    },
    {
      "id": "4",
      "name": "category 4"
    },
    {
      "id": "5",
      "name": "category 5"
    }
  ],
  "hasNext": false
}

サンプルコード

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

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

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

const body = {
  limit: 30
};

await garoon.api('/api/v1/todo/categories', 'GET', body);

注意事項

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

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