kintone API ドキュメント

カテゴリーの設定情報を変更する

目次

caution
警告

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

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

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

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

カテゴリーの設定情報を変更する

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

カテゴリーの設定情報を変更します。

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

URL

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

通常のアプリ
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 メソッド

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

PUT

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
enabled 真偽値または文字列 省略可 カテゴリー機能が有効かどうか
  • true：有効
  • false：無効
categories オブジェクト 省略可 変更後のカテゴリーの情報
categories.カテゴリー名 オブジェクト 条件必須 各カテゴリーの情報
  • カテゴリーを追加するとき：
    追加するカテゴリー名をカテゴリー名に指定します。
  • カテゴリーを変更するとき：
    変更前のカテゴリー名をカテゴリー名に指定します。
  • カテゴリーを削除するとき：
    削除するカテゴリーのプロパティを指定しません。
categories.カテゴリー名.name 文字列 条件必須 カテゴリーの名前
1 文字以上 64 文字以下で指定します。
新しいカテゴリーを追加する場合は必須で、カテゴリー名と同じ値を指定します。
同じ親をもつカテゴリー内で重複する値は指定できません。
categories.カテゴリー名.index 数値または文字列 条件必須 カテゴリの並び順
categories を指定した場合は必須です。
この値の昇順にカテゴリーが並べられます。
同じ親をもつカテゴリー内で重複する値は指定できません。
categories.カテゴリー名.children オブジェクト 条件必須 子カテゴリーの設定情報
categories と同様の構造を持ちます。
categories を指定した場合は必須です。
カテゴリーは最大 ５ 階層まで追加できます。
５ 階層目のカテゴリーでは children を指定できません。
revision 数値または文字列 省略可 期待しているリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、設定は変更されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "app": 1,
  "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": {}
        },
        "既存カテゴリー名": {
          "name": "変更後カテゴリー名",
          "index": "2",
          "children": {}
        }
      }
    }
  },
  "revision": "2"
}

レスポンス

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

プロパティ
プロパティ名 型 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号

制限事項

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

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