アプリの一般設定を取得する

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

アプリの一般設定を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/app/settings.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/settings.json
URL（動作テスト環境）	https://sample.cybozu.com/k/v1/preview/app/settings.json
URL（動作テスト環境のゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/settings.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

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

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

レスポンスプロパティ

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

プロパティ名	型	説明
name	文字列	アプリ名
description	文字列	アプリの説明 HTML形式で出力されます。
icon	オブジェクト	アプリのアイコンの情報
icon.type	文字列	アイコンの種類 `PRESET`：kintoneの組込みアイコン `FILE`：アップロードした画像
icon.key	文字列	アイコンのキー（識別子） kintoneの組込みアイコンを使用している場合に出力されます。
icon.file	オブジェクト	アイコンのファイル情報アップロードした画像を使用している場合に出力されます。
icon.file.contentType	文字列	アイコンのMIMEタイプ
icon.file.fileKey	文字列	アイコンのファイルキー
icon.file.name	文字列	アイコンの名前
icon.file.size	文字列	アイコンのファイルサイズ（byte単位）
theme	文字列	デザインテーマ `WHITE`：初期設定 `RED`：レッド `GREEN`：グリーン `BLUE`：ブルー `YELLOW`：イエロー `BLACK`：ブラック 2017年2月メンテナンスより前に作成されたアプリでは、次の値になることがあります。 `CLIPBOARD`：クリップボード `BINDER`：バインダー `PENCIL`：えんぴつ `CLIPS`：クリップ
titleField	オブジェクト	レコードのタイトルの情報
titleField.selectionMode	文字列	レコードのタイトルとして利用するフィールドの選択方法 `AUTO`：自動設定を利用する `MANUAL`：フィールドを選択する
titleField.code	文字列	レコードのタイトルとして利用するフィールドのフィールドコード `titleField.selectionMode`の値によって異なります。「自動設定を利用する」の場合：自動設定されたフィールドのフィールドコード「フィールドを選択する」の場合：設定されているフィールドのフィールドコード
enableThumbnails	真偽値	サムネイルを表示するかどうか
enableBulkDeletion	真偽値	レコード一括削除を有効にするかどうか
enableComments	真偽値	レコードのコメント機能を有効にするかどうか
enableDuplicateRecord	真偽値	「レコードを再利用する」機能を有効にするかどうか
enableInlineRecordEditing	真偽値	レコード一覧でのインライン編集を有効にするかどうか
numberPrecision	オブジェクト	数値と計算の精度 kintoneヘルプ：数値と計算の精度
numberPrecision.digits	文字列	全体の桁数 1から30までの整数が返ります。
numberPrecision.decimalPlaces	文字列	小数部の桁数 0から10までの整数が返ります。
numberPrecision.roundingMode	文字列	数値の丸めかた `HALF_EVEN`：最近接偶数への丸め `UP`：切り上げ `DOWN`：切り捨て
firstMonthOfFiscalYear	文字列	第一四半期の開始月 1から12までの整数が返ります。
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

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

運用環境の設定を取得する場合

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

次のいずれかの権限が必要です。

アプリのレコード閲覧権限
アプリのレコード追加権限

動作テスト環境の設定を取得する場合

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

アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/settings.json?app=8&lang=ja

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/settings.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


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

リクエストボディ

1
2
3
4


{
  "app": 8,
  "lang": "ja"
}

サンプルレスポンス

 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


{
  "name": "案件管理",
  "description": "営業部の案件管理に使用します。",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
  "titleField": {
    "selectionMode": "MANUAL",
    "code": "文字列1行_0"
  },
  "enableThumbnails": true,
  "enableBulkDeletion": false,
  "enableComments": true,
  "enableDuplicateRecord": true,
  "enableInlineRecordEditing": true,
  "numberPrecision": {
    "digits": "16",
    "decimalPlaces": "4",
    "roundingMode": "HALF_EVEN"
  },
  "firstMonthOfFiscalYear": "4",
  "revision": "24"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5
6


const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

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

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2


curl -X GET 'https://sample.cybozu.com/k/v1/app/settings.json?app=8&lang=ja' \
  -H 'X-Cybozu-API-Token: API_TOKEN'

kintone API

kintone APIドキュメント

アプリの一般設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

運用環境の設定を取得する場合

動作テスト環境の設定を取得する場合

サンプル