kintone API ドキュメント

一覧の設定を変更する

目次

一覧の設定を変更する

アプリの一覧の設定を変更します。

この API は、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、この API を実行した後に アプリ設定を運用環境へ反映する API を実行してください。

URL

通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/views.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app/views.json

HTTP メソッド

PUT

必要なアクセス権

表形式またはカレンダー形式の場合
  • アプリ管理権限
カスタマイズ形式の場合
  • kintone システム管理権限

リクエスト

パラメーター
パラメーター名 指定する値 必須 説明
app 数値 必須 アプリ ID
views オブジェクト 必須 一覧の設定の一覧
一覧を追加、更新するときは、既存の一覧を views に指定してください。
指定しないとその一覧は削除されます。
views.一覧名 オブジェクト 必須 各一覧の設定
  • 一覧を追加するとき：
    追加する一覧名を 一覧名 に指定します。
  • 一覧を変更するとき：
    更新前の一覧名を 一覧名 に指定します。
  • 一覧を削除するとき：
    削除する一覧名のプロパティを指定しません。
プロセス管理が有効の場合は、一覧名 に「（作業者が自分）」を指定してください。
views.一覧名.index 文字列 必須 一覧の表示順
指定した数字の昇順に、一覧が並べ替えられます。
views.一覧名.type 文字列 必須 一覧の表示形式
  • LIST：表形式
  • CALENDAR：カレンダー形式
  • CUSTOM：カスタマイズ形式
views.一覧名.name 文字列 条件必須 変更後の一覧の名前
64 文字以内で指定します。
新しい一覧を追加する場合は必須で、一覧名 と同じ値を指定します。
views.一覧名.fields 配列 条件必須 表示するフィールドのフィールドコードの一覧
表示する各フィールドのフィールドコードを指定します。
views.一覧名.type が「LIST」の場合は必須です。
views.一覧名.date 文字列 省略可 日付として使用するフィールドのフィールドコード
views.一覧名.type が「LIST」の場合に指定します。
省略すると、更新日時フィールドが設定されます。
views.一覧名.title 文字列 省略可 タイトルとして使用するフィールドのフィールドコード
views.一覧名.type が「LIST」の場合に指定します。
省略すると、レコード番号フィールドが設定されます。
views.一覧名.html 文字列 省略可 カスタマイズに使用する HTML の内容
views.一覧名.type が「CUSTOM」の場合に指定します。
views.一覧名.pager 真偽値 省略可 ページネーションを表示するかどうか
  • true：表示する
  • false：表示しない
views.一覧名.type が「CUSTOM」の場合に指定します。
省略すると「true」が設定されます。
views.一覧名.device 文字列 省略可 一覧を表示する範囲
  • DESKTOP：PC版のみで表示する
  • ANY：PC版とモバイル版で表示する
views.一覧名.type が「CUSTOM」の場合に指定します。
省略すると、追加の場合は「DESKTOP」が設定され、変更の場合は変更されません。
views.一覧名.filterCond 文字列 省略可 レコードの絞り込み条件
クエリ形式で指定します。クエリ形式は、 クエリの書き方 を参照してください。
views.一覧名.sort 文字列 省略可 レコードのソート条件
クエリ形式で指定します。クエリ形式は、 クエリの書き方 を参照してください。
revision 数値または文字列 省略可 期待しているリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、一覧の設定は変更されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{
  "app": 18,
  "views": {
    "一覧1": {
      "index": "0",
      "type": "LIST",
      "name": "一覧1",
      "fields": ["レコード番号", "文字列__1行_"],
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc"
    },
    "(作業者が自分)": {
      "index": "3",
      "type": "LIST"
    },
    "カレンダー": {
      "index": "1",
      "type": "CALENDAR",
      "name": "カレンダー1",
      "date": "作成日時",
      "title": "文字列__1行_",
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc"
    },
    "カスタマイズ": {
      "index": "2",
      "type": "CUSTOM",
      "html": "カスタマイズされた一覧のHTML更新",
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "sort": "レコード番号 asc",
      "device": "ANY"
    }
  }
}

レスポンス

プロパティ
プロパティ名 型 説明
views オブジェクト 一覧の情報
views.一覧名.id 文字列 ビュー ID
revision 文字列 アプリの設定を変更したあとのリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "views": {
    "カレンダー": {
      "id": "1320"
    },
    "一覧1": {
      "id": "1321"
    },
    "カスタマイズ": {
      "id": "1322"
    }
  },
  "revision": 2
}

サンプルコード

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/views.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": kintone.app.getId(),
    "views": {
      "一覧1": {
        "index": "0",
        "type": "LIST",
        "name": "一覧1",
        "fields": [
          "レコード番号",
          "文字列__1行_"
        ],
        "filterCond": "更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"",
        "sort": "レコード番号 asc"
      },
      "(作業者が自分)": {
        "index": "3",
        "type": "LIST",
        "filterCond": "作成者 in (LOGINUSER())"
      },
      "カレンダー": {
        "index": "1",
        "type": "CALENDAR",
        "name": "カレンダー1",
        "date": "作成日時",
        "title": "文字列__1行_",
        "filterCond": "更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"",
        "sort": "レコード番号 asc"
      },
      "カスタマイズ": {
        "index": "2",
        "type": "CUSTOM",
        "html": "カスタマイズされた一覧のHTML更新",
        "filterCond": "更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"",
        "sort": "レコード番号 asc"
      }
    }
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

const body = {
  app: kintone.app.getId(),
  views: {
    一覧1: {
      index: '0',
      type: 'LIST',
      name: '一覧1',
      fields: [
        'レコード番号',
        '文字列__1行_'
      ],
      filterCond: '更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"',
      sort: 'レコード番号 asc'
    },
    '(作業者が自分)': {
      index: '3',
      type: 'LIST',
      filterCond: '作成者 in (LOGINUSER())'
    },
    カレンダー: {
      index: '1',
      type: 'CALENDAR',
      name: 'カレンダー1',
      date: '作成日時',
      title: '文字列__1行_',
      filterCond: '更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"',
      sort: 'レコード番号 asc'
    },
    カスタマイズ: {
      index: '2',
      type: 'CUSTOM',
      html: 'カスタマイズされた一覧のHTML更新',
      filterCond: '更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"',
      sort: 'レコード番号 asc'
    }
  }
};

await kintone.api(kintone.api.url('/k/v1/preview/app/views.json', true), 'PUT', body);

制限事項

  • 同じ名前の一覧が存在する場合には、設定を変更できません。
  • 表示形式が「カスタマイズ形式」の一覧を含むアプリを変更する場合には、API トークンを使用できません。