JavaScript / CSSカスタマイズ設定を取得する

固定リンクがコピーされました

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

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/app/customize.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/customize.json
URL（動作テスト環境）	https://sample.cybozu.com/k/v1/preview/app/customize.json
URL（動作テスト環境のゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/customize.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
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です。
mobile.css	配列	CSSファイルの一覧
mobile.css[].type	文字列	ファイルの指定方法 `URL`：URLで指定されている場合 `FILE`：アップロードして指定されている場合
mobile.css[].url	文字列	ファイルのURL
mobile.css[].file	オブジェクト	添付されたファイルの情報
mobile.css[].file.contentType	文字列	MIMEタイプ
mobile.css[].file.fileKey	文字列	ファイルキー
mobile.css[].file.name	文字列	ファイル名
mobile.css[].file.size	文字列	ファイルのサイズ単位はbyteです。
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

固定リンクがコピーされました

アプリ管理権限

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/customize.json?app=8

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/customize.json

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

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3


{
  "app": "8"
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


{
  "scope": "ALL",
  "desktop": {
    "js": [
      {
        "type": "URL",
        "url": "https://sample.com/example.js"
      },
      {
        "type": "FILE",
        "file": {
          "contentType": "application/javascript",
          "fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023",
          "name": "sample.js",
          "size": "12345"
        }
      }
    ],
    "css": []
  },
  "mobile": {
    "js": [
      {
        "type": "FILE",
        "file": {
          "contentType": "application/javascript",
          "fileKey": "20140823043800E9F53A742F7F4416B6E47234DBD6C0D4025",
          "name": "mobile.js",
          "size": "12345"
        }
      },
      {
        "type": "URL",
        "url": "https://sample.com/example-mobile.js"
      }
    ],
    "css": []
  },
  "revision": "15"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  app: kintone.app.getId()
};

await kintone.api(kintone.api.url('/k/v1/app/customize.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/app/customize.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 8
  }'

制限事項

固定リンクがコピーされました

APIトークンは使用できません。

kintone API

kintone APIドキュメント

JavaScript / CSSカスタマイズ設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

制限事項