Update Views

Updates the View settings of an App.

This API updates the pre-live settings.
After using this API, use the Deploy App Settings API to deploy the settings to the live App.
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
Content-Type application/json

Permissions

  • App Management Permissions are needed.
  • 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.
  • LIST: List View
  • CALENDAR: Calendar View
  • CUSTOM: Custom 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   Used for List Views.
The list of fields to be displayed in the list.
Specify fields by their field codes.
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:
  • true: Enable (default)
  • false: Disable
views.{viewname}.filterCond String   The filter condition in a query format.
Check here for more data on query formats.
views.{viewname}.sort String   The sort order in a query format.
Check here for more data on query formats.
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

JavaScript (using kintone REST API 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

Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.