一般設定の変更 – cybozu developer network

アプリの一般設定を変更します。

このAPI は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。

URI

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

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

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

※2020年4月版からAPIトークンを利用してAPIを実行できます。

リクエストパラメータ

リクエストのパラメータの一覧です。指定を省略したパラメータの設定項目は、更新されません。

パラメータ	指定する値	必須	説明
app	数値または文字列	必須	アプリのIDを指定します。
name	文字列		アプリの名前を64文字以内で指定します。
description	文字列		アプリの説明を10,000文字以内で指定します。HTMLタグを使用できます。
icon	オブジェクト		アプリのアイコンの情報を表すオブジェクトです。
icon.type	文字列	条件必須	アイコンの種類を、次のいずれかで指定します。 kintoneに組み込みのアイコンを使用する場合：PRESET 画像をアップロードする場合：FILE 「icon」パラメータを指定する場合、このパラメータは必須です。
icon.key	文字列	条件必須	「icon.type」パラメータに「PRESET」を指定した場合に、使用するアイコンの識別子^*を指定します。
icon.file	オブジェクト	条件必須	アイコンのファイル情報を表すオブジェクトです。このパラメータは、「icon.type」パラメータに「FILE」を指定した場合に指定します。
icon.file.fileKey	文字列	条件必須	次のAPIでアップロードしたファイルのキーを指定します。ファイルのアップロード 800KBまでのファイルをアップロードできます。「icon.type」パラメータに「FILE」を指定する場合、このパラメータは必須です。
theme	文字列		デザインテーマです。 WHITE RED BLUE GREEN YELLOW BLACK ※以前提供していたテーマの CLIPBOARD,BINDER, PENCIL, CLIPS を指定した場合、WHITEのテーマで表示されます。
revision	数値または文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

^*：アイコンごとの識別子を確認するには、アプリの一般設定取得APIで取得したレスポンスのicon.keyパラメータを使用します。

リクエストの例

ヘッダ

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

ボディ

レスポンスパラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。