カテゴリーの設定情報を取得する

目次

caution
警告

このページで説明している API は、開発を検討中の API です。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効/無効の切り替え手順 (External link) を参照してください。

API に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • API ラボで提供されている API を早く本番環境で利用したい
  • こういう用途で使うために、このような API を提供してほしい

カテゴリーの設定情報を取得する

カテゴリーの設定情報を取得します。

利用するには開発中の新機能の「カテゴリーの設定を取得または更新する REST API」を有効にしてください。

URL

URL は運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/categories.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/categories.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/categories.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/categories.json

HTTP メソッド

GET

必要なアクセス権

運用環境の設定を取得する場合
  • アプリのレコード閲覧権限
  • アプリのレコード追加権限
動作テスト環境の設定を取得する場合
  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 必須 説明
app 数値または文字列 必須 アプリ ID
lang 文字列 省略可 取得する名称の言語
カテゴリー名に 言語ごとの名称 (External link) を設定している場合に指定します。
  • ja:日本語
  • en:英語
  • zh:中国語
  • user:API を実行するユーザーが表示言語に設定している言語
    言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
    • ヘッダーあり:「Accept-Language」ヘッダーで指定した言語
    • ヘッダーなし:cybozu.com 共通管理の ロケールの設定 (External link) で設定した言語
  • default:デフォルト
省略すると、デフォルトの名称を取得します。

レスポンス

プロパティ
プロパティ名 説明
enabled 真偽値 カテゴリー機能が有効かどうか
  • true:有効
  • false:無効
categories オブジェクト 設定済みのカテゴリーの情報
categories.カテゴリー名 オブジェクト 各カテゴリーの情報
categories.カテゴリー名.name 文字列 カテゴリーの名前
categories.カテゴリー名.index 文字列 カテゴリーの並び順(昇順)
categories.カテゴリー名.children オブジェクト 子カテゴリーの設定情報
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "enabled": true,
  "categories": {
    "カテゴリー1": {
      "name": "カテゴリー1",
      "index": "0",
      "children": {
        "カテゴリー1-1": {
          "name": "カテゴリー1-1",
          "index": "0",
          "children": {}
        },
        "カテゴリー1-2": {
          "name": "カテゴリー1-2",
          "index": "1",
          "children": {}
        }
      }
    }
  },
  "revision": "2"
}

制限事項

  • 同じ親をもつカテゴリー内でカテゴリー名が重複している場合には、設定を取得できません。