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

目次

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

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

この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の値を使用します。
一般設定を取得するAPI
icon.file オブジェクト 条件必須 アイコンのファイル情報
icon.typeに「FILE」を指定する場合は必須です。
icon.file.fileKey 文字列 条件必須 ファイルをアップロードするAPIでアップロードしたファイルのキー
800KBまでのファイルを指定できます。
ファイルをアップロードするAPI
icon.typeに「FILE」を指定する場合は必須です。
theme 文字列 省略可 デザインテーマ
  • WHITE:初期設定
  • RED:レッド
  • GREEN:グリーン
  • BLUE:ブルー
  • YELLOW:イエロー
  • BLACK:ブラック
2017年2月メンテナンスより前に提供していた次のテーマを指定した場合、初期設定のテーマで表示されます。
  • CLIPBOARD
  • BINDER
  • PENCIL
  • CLIPS
titleField オブジェクト 省略可 レコードのタイトルの情報
titleField.selectionMode 文字列 条件必須 レコードのタイトルとして利用するフィールドの選択方法
次のいずれかの値を指定します。
  • AUTO:自動設定を利用する
  • MANUAL:フィールドを選択する
titleFieldを指定した場合は必須です。
titleField.code 文字列 条件必須 レコードのタイトルとして利用するフィールドのフィールドコード
titleField.selectionModeに「MANUAL」を指定した場合は必須です。
titleField.selectionModeに「AUTO」を指定した場合は、このパラメーターは無視されます。
enableThumbnails 真偽値 省略可 サムネイルを表示するかどうか
enableBulkDeletion 真偽値 省略可 レコード一括削除を有効にするかどうか
enableComments 真偽値 省略可 レコードのコメント機能を有効にするかどうか
enableDuplicateRecord 真偽値 省略可 「レコードを再利用する」機能を有効にするかどうか
numberPrecision オブジェクト 省略可 数値と計算の精度
kintoneヘルプ:数値と計算の精度 (External link)
numberPrecision.digits 文字列 省略可 全体の桁数
1から30までの整数を指定します。
numberPrecision.decimalPlaces 文字列 省略可 小数部の桁数
0から10までの整数を指定します。
numberPrecision.roundingMode 文字列 省略可 数値の丸めかた
次のいずれかの値を指定します。
  • HALF_EVEN:最近接偶数への丸め
  • UP:切り上げ
  • DOWN:切り捨て
firstMonthOfFiscalYear 文字列 省略可 第一四半期の開始月
1から12までの整数を指定します。
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
{
  "app": 21,
  "name": "案件管理",
  "description": "案件の管理に使用するアプリです。",
  "icon": {
    "type": "PRESET",
    "key": "APP72"
  },
  "theme": "WHITE",
  "titleField": {
    "selectionMode": "MANUAL",
    "code": "文字列1行_0"
  },
  "enableThumbnails": true,
  "enableBulkDeletion": false,
  "enableComments": true,
  "enableDuplicateRecord": true,
  "numberPrecision": {
    "digits": "16",
    "decimalPlaces": "4",
    "roundingMode": "HALF_EVEN"
  },
  "firstMonthOfFiscalYear": "4",
  "revision": 1
}

レスポンス

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

サンプルコード

curlを使ったリクエスト
 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
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",
    "titleField": {
      "selectionMode": "MANUAL",
      "code": "文字列1行_0"
    },
    "enableThumbnails": true,
    "enableBulkDeletion": false,
    "enableComments": true,
    "enableDuplicateRecord": true,
    "numberPrecision": {
      "digits": "16",
      "decimalPlaces": "4",
      "roundingMode": "HALF_EVEN"
    },
    "firstMonthOfFiscalYear": "4"
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
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
const body = {
  app: kintone.app.getId(),
  name: '案件管理',
  description: '案件の管理に使用するアプリです。',
  icon: {
    type: 'PRESET',
    key: 'APP72'
  },
  theme: 'WHITE',
  titleField: {
    selectionMode: 'MANUAL',
    code: '文字列1行_0'
  },
  enableThumbnails: true,
  enableBulkDeletion: false,
  enableComments: true,
  enableDuplicateRecord: true,
  numberPrecision: {
    digits: '16',
    decimalPlaces: '4',
    roundingMode: 'HALF_EVEN'
  },
  firstMonthOfFiscalYear: '4'
};

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