kintone API

kintone内の画面のURLを組み立てる

目次

kintone内の画面のURLを組み立てる

kintone内の画面のURLを組み立て取得します。 ゲストスペース内アプリを指定した場合は、ゲストスペース用のURLが組み立てられます。

このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。

関数

PC/モバイル

kintone.buildPageUrl(page, params)

引数

引数名 必須 説明
page 文字列 必須 画面を表す文字列
次のいずれかの値を指定します。
  • アプリの画面
    • APP_INDEX:一覧(PC)
      params.appIdの指定が必須です。params.viewIdを指定できます。
    • APP_CREATE:作成(PC)
      params.appIdの指定が必須です。
    • APP_DETAIL:詳細(PC)
      params.appIdparams.recordIdの指定が必須です。
    • APP_EDIT:編集(PC)
      params.appIdparams.recordIdの指定が必須です。
    • APP_PRINT:印刷(PC)
      params.appIdparams.recordIdの指定が必須です。
    • APP_REPORT:グラフ(PC)
      params.appIdparams.reportIdの指定が必須です。
    • APP_INDEX_MOBILE:一覧(モバイル)
      params.appIdの指定が必須です。params.viewIdを指定できます。
    • APP_CREATE_MOBILE:作成(モバイル)
      params.appIdの指定が必須です。
    • APP_DETAIL_MOBILE:詳細(モバイル)
      params.appIdparams.recordIdの指定が必須です。
    • APP_EDIT_MOBILE:編集(モバイル)
      params.appIdparams.recordIdの指定が必須です。
    • APP_REPORT_MOBILE:グラフ(モバイル)
      params.appIdparams.reportIdの指定が必須です。
params オブジェクト 必須 URLの組み立てに使用する引数
params.appId 文字列 条件必須 アプリID
アプリの各画面で必須です。
params.recordId 文字列 条件必須 レコードID
レコード詳細、レコード編集、レコード印刷の各画面で必須です。
params.viewId 文字列 省略可 一覧のID
params.reportId 文字列 条件必須 グラフのID
グラフ画面で必須です。

戻り値

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の値が取得できます。

説明
文字列 画面のURL

利用できる画面

PC/モバイル

利用できる画面は、全体カスタマイズの適用画面に従います。
kintone全体のカスタマイズが適用される画面

ただし、次の画面では利用できません。

  • 検索画面
  • アプリストア
  • プラグイン設定画面

注意事項

このAPIは実行時にサーバーからデータを取得します。取得したデータは画面遷移が発生するまでキャッシュされます。
ユーザーごとに1分当たり50回を超えるサーバーからのデータの取得があった場合、戻り値のPromiseオブジェクトが拒否(rejected)されます。