kintone API ドキュメント

アプリの一般設定を変更する

目次

アプリの一般設定を変更する

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

アプリの一般設定を変更します。

このAPIは、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、このAPIを実行した後に アプリ設定を運用環境へ反映する APIを実行してください。

URL

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

通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/settings.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/settings.json

HTTP メソッド

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

PUT

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

パラメーター

リクエストのパラメーターの一覧です。指定を省略したパラメーターの設定項目は、更新されません。

パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
name 文字列 省略可 アプリの名前
指定できる値は 1 文字以上 64 文字以内です。
description 文字列 省略可 アプリの説明
10,000 文字以内で指定します。HTML タグを使用できます。
icon オブジェクト 省略可 アプリのアイコンの情報
icon.type 文字列 条件必須 アイコンの種類
次のいずれかの値を指定します。
  • PRESET：kintone の組込みアイコンを使用する場合
  • FILE：画像をアップロードする場合
iconを指定する場合は必須です。
icon.key 文字列 条件必須 使用するアイコンの識別子
icon.typeに「PRESET」を指定する場合は必須です。
アイコンの識別子には、kintone の組込みアイコンを使用しているアプリで 一般設定を取得する APIで取得したicon.keyの値を使用します。
icon.file オブジェクト 条件必須 アイコンのファイル情報
icon.typeに「FILE」を指定する場合は必須です。
icon.file.fileKey 文字列 条件必須 ファイルをアップロードする APIでアップロードしたファイルのキー
800KB までのファイルを指定できます。
icon.typeに「FILE」を指定する場合は必須です。
theme 文字列 省略可 デザインテーマ
  • WHITE：初期設定
  • RED：レッド
  • GREEN：グリーン
  • BLUE：ブルー
  • YELLOW：イエロー
  • BLACK：ブラック
2017 年 2 月メンテナンスより前に提供していた次のテーマを指定した場合、初期設定のテーマで表示されます。
  • CLIPBOARD
  • BINDER
  • PENCIL
  • CLIPS
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

{
  "app": 21,
  "name": "案件管理",
  "description": "案件の管理に使用するアプリです。",
  "icon": {
    "type": "PRESET",
    "key": "APP72"
  },
  "theme": "WHITE",
  "revision": 1
}

レスポンス

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

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

{
  "revision": "2"
}

サンプルコード

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

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/settings.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "name": "案件管理",
    "description": "案件の管理に使用するアプリです。",
    "icon": {
      "type": "PRESET",
      "key": "APP72"
    },
    "theme": "WHITE"
  }'
kintone REST API リクエストを送信する APIを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const body = {
  app: kintone.app.getId(),
  name: '案件管理',
  description: '案件の管理に使用するアプリです。',
  icon: {
    type: 'PRESET',
    key: 'APP72'
  },
  theme: 'WHITE'
};

await kintone.api(kintone.api.url('/k/v1/preview/app/settings.json', true), 'PUT', body);