アプリの一般設定を取得する
アプリの一般設定を取得します。
URL
URL は、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/app/settings.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/app/settings.json
動作テスト環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/preview/app/settings.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/preview/app/settings.json
HTTP メソッド
GET
必要なアクセス権
運用環境の設定を取得する場合
次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
動作テスト環境の設定を取得する場合
- アプリ管理権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリ ID |
lang | 文字列 | 省略可 | 取得する名称の言語 アプリ名や説明に 言語ごとの名称
|
リクエストの例(URLにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/settings.json?app=8&lang=ja
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/settings.json
ヘッダー
|
|
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
name | 文字列 | アプリ名 |
description | 文字列 | アプリの説明 HTML 形式で出力されます。 |
icon | オブジェクト | アプリのアイコンの情報 |
icon.type | 文字列 | アイコンの種類
|
icon.key | 文字列 | アイコンのキー(識別子) kintone の組込みアイコンを使用している場合に出力されます。 |
icon.file | オブジェクト | アイコンのファイル情報 アップロードした画像を使用している場合に出力されます。 |
icon.file.contentType | 文字列 | アイコンの MIME タイプ |
icon.file.fileKey | 文字列 | アイコンのファイルキー |
icon.file.name | 文字列 | アイコンの名前 |
icon.file.size | 文字列 | アイコンのファイルサイズ(byte 単位) |
theme | 文字列 | デザインテーマ
|
revision | 文字列 | アプリの設定のリビジョン番号 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|