Update Views
Updates the View settings of an App.
This API updates the pre-live settings.
After using this API, use the following API to deploy the settings to the live App:
Deploy App Settings
Method | PUT |
---|---|
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 |
Authentication | Password Authentication , API Token Authentication , Session Authentication |
Content-Type | application/json |
Contents
Permissions
List/Calendar View:
- App Management Permissions are needed.
Customize View:
- Only Kintone Administrators can use this API.
- API Tokens cannot be used with this API.
Request Parameters
This API will replace all current Views with the Views listed in the request.
View names that are not stated in the request will be deleted.
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer | Yes | The App ID. |
views | Object | Yes | An object of data of Views. |
views.{viewname} | Object | Yes | The View name of the View to add changes to. If a View name that does exist is specified, a new View with this name will be created. |
views.{viewname}.index | String | Yes | The display order of the View, in the list of views, specified with a number. The list of views will be displayed in ascending order. |
views.{viewname}.type | String | Yes | The type of View.
|
views.{viewname}.name | String | Conditional | The name of the View. The maximum character limit is 64. Required, if views.{viewname} is a new View. In this case, specify the same new View name for this parameter. |
views.{viewname}.fields | Array | Conditional | Used for List Views. The list of fields to be displayed in the list. Specify fields by their field codes. This parameter is required, if adding a new List View. |
views.{viewname}.date | String | Used for Calendar Views. The field to be used as the "Date Field" of the Calendar View. Specify a date type field by their field code. If ignored, the Created datetime field will be set. |
|
views.{viewname}.title | String | Used for Calendar views. The field to be used as the "Title Field" of the Calendar View. Specify a text type field by their fieldcode. If ignored, the Record number field will be set. |
|
views.{viewname}.html | String | Used for Custom Views. The HTML code to set for the Custom View. |
|
views.{viewname}.pager | Boolean | The pagination settings. Specify one of the following:
|
|
views.{viewname}.device | String | The scope of where the view is displayed. If this parameter is not specified, the default is DESKTOP. If view settings are updated without specifying this parameter, this parameter does not change.
|
|
views.{viewname}.filterCond | String | The filter condition in a query format. For more data on query formats refer to the following document: Query String |
|
views.{viewname}.sort | String | The sort order in a query format. For more data on query formats refer to the following document: Query String |
|
revision | Integer | Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. |
Sample Request
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
revision | String | The revision number of the App settings. |
views | Object | An object containing data of the Views. |
views.{viewname}.id | String | The View ID. |
Sample Response
|
|
Limitations
- This API cannot be used to update View settings if there are multiple Views with the same name.
- If the target App contains any Custom Views, this API cannot update the views if it is authenticated with API tokens, as Kintone Administration Permissions are needed to update these settings. For more information, refer to the following article section:
Kintone Administrator