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

目次

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

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

URL

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

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/settings.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/settings.json
動作テスト環境の設定を取得する場合
通常のアプリ
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メソッド

GET

必要なアクセス権

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

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

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

リクエスト

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

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

ヘッダー
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストの例(リクエストボディにパラメーターを含める場合)
URL

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"
}

レスポンス

プロパティ
プロパティ名 説明
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:クリップ
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "name": "案件管理",
  "description": "営業部の案件管理に使用します。",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
  "revision": "24"
}

サンプルコード

curlを使ったリクエスト
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()の詳細は、次のページを参照してください。
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);