一般設定の取得 – cybozu developer network

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

URI

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

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

https://(サブドメイン名).cybozu.com/k/v1/app/settings.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/settings.json

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

https://(サブドメイン名).cybozu.com/k/v1/preview/app/settings.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/settings.json

HTTPメソッド

GET

アクセス権

運用環境の設定を取得する場合、アプリにレコード閲覧権限が必要です。
テスト環境の設定を取得する場合、アプリに管理権限が必要です。
このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。
lang	文字列		アプリ名やアプリの説明に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。日本語の名称を取得する場合：ja 英語の名称を取得する場合：en 中国語の名称を取得する場合：zh ログインユーザーの言語設定で取得する場合：user* *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、 Accept-Languageヘッダがあればその設定が反映され、 Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。デフォルトの名称を取得する場合：default 省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。

URLにパラメータを含める場合

GET /k/v1/app/settings.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

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

GET /k/v1/app/settings.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
name	文字列	アプリ名です。
description	文字列	アプリの説明がHTML形式で出力されます。
icon	オブジェクト	アプリのアイコンの情報を表すオブジェクトです。
icon.type	文字列	アイコンの種類です。 FILE：アップロードした画像 PRESET：kintoneに組み込みのアイコン
icon.key	文字列	アイコンのキー(識別子)です。アプリのアイコンにkintoneに組み込みのアイコンを使用している場合に出力されます。
icon.file	オブジェクト	アイコンのファイル情報を表すオブジェクトです。アプリのアイコンにアップロードした画像を使用している場合に出力されます。
icon.file.contentType	文字列	MIMEタイプです。
icon.file.fileKey	文字列	キーです。
icon.file.name	文字列	名前です。
icon.file.size	文字列	サイズ（byte単位）です。
theme	文字列	デザインテーマです。 WHITE：プレーン CLIPBOARD：クリップボード BINDER：バインダー PENCIL：えんぴつ CLIPS：クリップ ※2017年2月版より次の値が追加になりました。 RED BLUE GREEN YELLOW BLACK
revision	文字列	アプリの設定のリビジョン番号です。