アプリの一覧の設定を変更します。
この API は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、この API を実行した後に、アプリ設定の運用環境への反映 API を実行してください。
API を実行する際には、既存の一覧の設定もリクエストパラメータに指定してください。
指定しなかった場合、その一覧は削除されます。
URI
https://{subdomain}.cybozu.com/k/v1/preview/app/views.json
ゲストスペースのアプリの場合:https://{subdomain}.cybozu.com/k/guest/(スペースのID)/v1/preview/app/views.json
HTTP メソッド
PUT
必要なアクセス権
表形式またはカレンダー形式の場合
- アプリ管理権限
カスタマイズ形式の場合
- kintone システム管理権限
※この API の実行には、表示形式が「カスタマイズ形式」の一覧を含むアプリの場合のみ、API トークンは使用できません。
リクエストパラメータ
指定するパラメータの一覧です。
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値 | 必須 | アプリの ID を指定します。 |
views | オブジェクト | 必須 | 一覧の設定を表すオブジェクトです。複数の一覧を指定します。 一覧の設定を追加、更新するときは、既存の一覧の設定を「views」に指定する必要があります。 指定しなかった場合はその一覧が削除されます。 |
views.(一覧名) | オブジェクト | 必須 | 各一覧の設定を表すオブジェクトです。「(一覧名)」には更新前の一覧名を指定します。 存在しない一覧を「(一覧名)」に指定した場合は、新規の一覧として追加します。 |
views.(一覧名).index | 文字列 | 必須 | 一覧の表示順を数字で指定します。指定した数字の昇順に、一覧が並びます。 |
views.(一覧名).type | 文字列 | 必須 | 一覧の表示形式を指定します。
|
views.(一覧名).name | 文字列 | 条件必須 | 一覧の名前を、64 文字以内で指定します。新しい一覧を追加する場合は必須となり、「views(一覧名)」のキー名と同じ値を指定します。 |
views.(一覧名).fields | 配列 | 条件必須 | 表形式の一覧で、表示する各フィールドのコードを指定します。 新しい一覧を追加する場合は必須です。 すでに追加されている一覧の場合、省略すると変更されません。 |
views.(一覧名).date | 文字列 | カレンダー形式の一覧で、日付として使用するフィールドのフィールドコードを指定します。 次のいずれかに当てはまる場合、値を省略すると更新日時フィールドが指定されます。
|
|
views.(一覧名).title | 文字列 | カレンダー形式の一覧で、タイトルとして使用するフィールドのフィールドコードを指定します。 次のいずれかに当てはまる場合、値を省略するとレコード番号フィールドが指定されます。
|
|
views.(一覧名).html | 文字列 | カスタマイズ形式の一覧で、カスタマイズに使用する HTML の内容を指定します。 省略した場合は、空文字になります。 |
|
views.(一覧名).pager | 真偽値 | カスタマイズ形式の一覧で、ページネーションを表示するかどうかを指定します。
一覧の設定を追加または更新する場合、空の文字列または空白のみの文字列を指定すると、false が設定されます。 |
|
views.(一覧名).device |
文字列 | カスタマイズ形式の一覧で出力されます。一覧を表示する範囲です。 一覧の設定を追加する場合、省略すると DESKTOP が設定されます。 一覧の設定を更新する場合、省略しても設定された値は変更されません。
|
|
views.(一覧名).filterCond | 文字列 | レコードの絞り込み条件をクエリ形式で指定します。 クエリ形式については、次のページを参照してください。 レコードの一括取得(クエリで条件を指定) 省略すると、絞り込みの設定は変更されません。 一覧の設定を追加する場合、省略すると「すべてのレコード」になります。 |
|
views.(一覧名).sort | 文字列 | レコードのソート条件をクエリ形式で指定します。 ソート条件は5つまで指定できます。 クエリ形式については、次のページを参照してください。 レコードの一括取得(クエリで条件を指定) 省略した場合は、ソート条件は変更されません。 一覧の設定を追加する場合、省略すると「レコード番号」の「降順」でソートされます。 |
|
revision | 数値 | アプリの設定を変更する前のリビジョン番号を指定します。 指定したリビジョンが最新ではない場合、リクエストはエラーになります。 省略、または「-1」を指定すると、リビジョンはチェックされません。 |
リクエストの例
ヘッダ
PUT /k/v1/preview/app/views.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンス
パラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
revision | 文字列 | アプリの設定を変更したあとのリビジョン番号です。 |
views | オブジェクト | 一覧の情報を表すオブジェクトです。 |
views.(一覧名).id | 文字列 | ビューの ID です。 |
レスポンスの例
JavaScript サンプル
kintone REST API リクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
制限事項
アプリ内で、リクエストで指定した一覧と同じ名前の一覧が存在する場合、この API で設定を変更することができません。
このPUTで内容を更新すると、一覧がすべて更新されるため、
https://developer.cybozu.io/hc/ja/articles/204529784
こちらで取得したviewsを変更や追加しないと、作成した一覧が消えてしまいます。
ご注意ください。