JavaScript / CSSカスタマイズ設定の取得 – cybozu developer network

アプリのJavaScript / CSSカスタマイズの設定を取得します。

URI

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

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

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

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

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

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

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

HTTPメソッド

GET

アクセス権

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

リクエスト

パラメータ

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。

リクエストの例

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

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

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

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

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

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
scope	文字列	カスタマイズの適用範囲です。 ALL：すべてのユーザー ADMIN：アプリの管理者だけ NONE：適用しない
desktop	オブジェクト	PCで読み込まれるファイルを表すオブジェクトです。
desktop.js	配列	JavaScriptファイルの情報を表す配列です。
desktop.js[].type	文字列	ファイルの指定方法です。 URL：URLで指定されています。 FILE：添付されています。
desktop.js[].url	文字列	ファイルのURLです。
desktop.js[].file	オブジェクト	添付されたファイルの情報を表すオブジェクトです。
desktop.js[].file.contentType	文字列	MIMEタイプです。
desktop.js[].file.fileKey	文字列	キーです。
desktop.js[].file.name	文字列	名前です。
desktop.js[].file.size	文字列	サイズ（byte単位）です。
desktop.css	配列	CSSファイルの情報を表す配列です。
desktop.css[].type	文字列	ファイルの指定方法です。 URL：URLで指定されています。 FILE：添付されています。
desktop.css[].url	文字列	ファイルのURLです。
desktop.css[].file	オブジェクト	添付されたファイルの情報を表すオブジェクトです。
desktop.css[].file.contentType	文字列	MIMEタイプです。
desktop.css[].file.fileKey	文字列	キーです。
desktop.css[].file.name	文字列	名前です。
desktop.css[].file.size	文字列	サイズ（byte単位）です。
mobile	オブジェクト	スマートフォンで読み込まれるファイルを表すオブジェクトです。
mobile.js	配列	JavaScriptファイルの情報を表す配列です。
mobile.js[].type	文字列	ファイルの指定方法です。 URL：URLで指定されています。 FILE：添付されています。
mobile.js[].url	文字列	ファイルのURLです。
mobile.js[].file	オブジェクト	添付されたファイルの情報を表すオブジェクトです。
mobile.js[].file.contentType	文字列	MIMEタイプです。
mobile.js[].file.fileKey	文字列	キーです。
mobile.js[].file.name	文字列	名前です。
mobile.js[].file.size	文字列	サイズ（byte単位）です。
revision	文字列	アプリの設定のリビジョン番号です。