Get Views
Gets the View settings of an App.
Method | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/app/views.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/views.json |
Authentication | Password Authentication , API Token Authentication , Session Authentication |
Content-Type | application/json (not needed if specifying the query with a query string) |
Contents
Pre-live Settings
Apps may hold pre-live settings that have not yet been deployed to the live app.
Access the pre-live settings with the below URL.
URL | https://{subdomain}.kintone.com/k/v1/preview/app/views.json |
---|---|
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/views.json |
Permissions
- Permission to view records or add records is needed when obtaining information of live apps.
- App Management Permissions are needed when obtaining information of pre-live settings.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer | Yes | The App ID |
lang | String | The localized language to retrieve the data in:
|
*If the user language setting is set to Use Web browser settings, the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the Localization settings in the System Administrator's menu will be used.
Sample Request
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
revision | String | The revision number of the App settings. |
views | Object | An object listing View information. |
views.{viewname}.builtinType | String | The type of the built-in View.
|
views.{viewname}.date | String | The field code set for the Date Field. Responded for Calendar Views. |
views.{viewname}.fields | Array | The list of field codes for the fields displayed in the View. Responded for List Views. |
views.{viewname}.filterCond | String | The filter condition as a query. For more information on query formats refer to the following document: Query String |
views.{viewname}.html | String | The HTML code set for the View. Responded for Custom Views. |
views.{viewname}.id | String | The View ID. |
views.{viewname}.index | String | The display order (ascending) of the View, when listed with other views. |
views.{viewname}.name | String | The name of the View. |
views.{viewname}.pager | Boolean | The pagination settings. Responded for Custom Views.
|
views.{viewname}.device | String | The scope of where the view is displayed.
|
views.{viewname}.sort | String | The sort order as a query. For more information on query formats refer to the following document: Query String |
views.{viewname}.title | String | The field code set for the Title Field. Responded for Calendar Views. |
views.{viewname}.type | String | The type of View.
|
Sample Response
|
|
Limitations
This API cannot be used to retrieve View settings if there are multiple Views with the same name.