アプリの一般設定を取得します。
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
必要なアクセス権
運用環境の設定を取得する場合、次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
テスト環境の設定を取得する場合
- アプリ管理権限
※2020年4月版からAPIトークンを利用してAPIを実行できます。
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
| lang | 文字列 | アプリ名やアプリの説明に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
|
リクエストの例
送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「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 | 文字列 | アイコンの種類です。
|
| icon.key | 文字列 | アイコンのキー(識別子)です。アプリのアイコンにkintoneに組み込みのアイコンを使用している場合に出力されます。 |
| icon.file | オブジェクト | アイコンのファイル情報を表すオブジェクトです。アプリのアイコンにアップロードした画像を使用している場合に出力されます。 |
| icon.file.contentType | 文字列 | MIMEタイプです。 |
| icon.file.fileKey | 文字列 | キーです。 |
| icon.file.name | 文字列 | 名前です。 |
| icon.file.size | 文字列 | サイズ（byte単位）です。 |
| theme | 文字列 |
デザインテーマです。 RED BLUE GREEN YELLOW BLACK |
| revision | 文字列 | アプリの設定のリビジョン番号です。 |
レスポンスの例
JavaScriptサンプル
XMLHttpRequest
アプリの「高度な設定」をAPI経由で取得できますでしょうか？できない場合は今後の追加の予定はありますでしょうか？
AY様
cybozu.com developer network事務局です。
現状、アプリの「高度な設定」情報を取得するAPIはなく、
現時点で、上記のAPI追加の予定もございません。
ご希望に沿えず申し訳ございません。
よろしくお願い致します。