kintone API ドキュメント

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

目次

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

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

URL

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

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/customize.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/app/customize.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/customize.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app/customize.json

HTTP メソッド

GET

必要なアクセス権

  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
リクエストの例（URLにパラメーターを含める場合）
URL

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

ヘッダー
1
2
3

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

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

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

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"
}

レスポンス

プロパティ
プロパティ名 型 説明
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 文字列 アプリの設定のリビジョン番号
レスポンスの例
 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"
}

サンプルコード

curl を使ったリクエスト
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,
  }'
kintone REST API リクエストを送信する 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);

制限事項

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