API Docs

Generate Page URL

Generate Page URL - kintone.buildPageUrl(page, params)

Generates the page URL.

If a guest space App is specified, the URL for the guest space will be generated.

Function

Desktop

kintone.buildPageUrl(page, params)

Parameters

Parameter Type Required Description
page String Yes A string representing the page
Specify one of the following values:
  • App pages
    • APP_INDEX: Record List (desktop)
      params.appId is required. params.viewId can be specified.
    • APP_CREATE: Record Create (desktop)
      params.appId is required.
    • APP_DETAIL: Record Details (desktop)
      params.appId and params.recordId are required.
    • APP_EDIT: Record Edit (desktop)
      params.appId and params.recordId are required.
    • APP_PRINT: Record Print (desktop)
      params.appId and params.recordId are required.
    • APP_REPORT: Graph (desktop)
      params.appId and params.reportId are required.
    • APP_INDEX_MOBILE: Record List (mobile)
      params.appId is required. params.viewId can be specified.
    • APP_CREATE_MOBILE: Record Create (mobile)
      params.appId is required.
    • APP_DETAIL_MOBILE: Record Details (mobile)
      params.appId and params.recordId are required.
    • APP_EDIT_MOBILE: Record Edit (mobile)
      params.appId and params.recordId are required.
    • APP_REPORT_MOBILE: Graph (mobile)
      params.appId and params.reportId are required.
params Object Yes The parameters used to build the URL
params.appId String Conditionally required The App ID
Required for all App pages.
params.recordId String Conditionally required The Record ID
Required for record details, record edit, and record print pages.
params.viewId String Optional The View ID
params.reportId String Conditionally required The Report ID
Required for graph pages.

Returns

A Promise object.
The following values can be retrieved when the Promise object is fulfilled:

Type Description
String Page URL

Available Pages

However, it cannot be used on the following pages:

  • Search results
  • Marketplace
  • Plug-in settings page

Notes

This API retrieves data from the server at runtime. The retrieved data is cached until a page transition occurs.
If data is retrieved from the server more than 50 times per minute per user, the returned Promise object will be rejected.