kintone API文件

變更清單的設置

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

變更清單的設置

連結已複製

變更應用程序清單的設置。

此 API 可變更測試環境中的應用。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用設置反映到正式環境的API。
將應用設置傳播到正式環境API

URL

連結已複製

常規應用程式
https://sample.cybozu.com/k/v1/preview/app/views.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_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為「CALENDAR」時，需要指定。
如果省略，則默認為更新時間欄位。
views.清單名稱.title 字串 可省略 要用於顯示標題的欄位的欄位代碼
views.清單名稱.type為「CALENDAR」時，需要指定。
如果省略，則默認記錄編號欄位。
views.清單名稱.html 字串 可省略 用於自訂的 HTML 內容
views.清單名稱.type為「CALENDAR」時，需要指定。
views.清單名稱.pager 布爾值 可省略 分頁顯示
  • true：顯示
  • false：不顯示
views.清單名稱.type為「CUSTOM」時，需要指定。
如果省略，則設置為「true」。
views.清單名稱.device 字串 可省略 清單的顯示範圍
  • DESKTOP：只在電腦版上顯示
  • ANY：在電腦版和行動裝置版上顯示
views.清單名稱.type為「CALENDAR」時，需要指定。
如果省略，添加清單時將默認設置「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": ["記錄編號", "單行文字方塊"],
      "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": "單行文字方塊",
      "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": 1,
    "views": {
      "一覧1": {
        "index": "0",
        "type": "LIST",
        "name": "一覧1",
        "fields": [
          "記錄號碼",
          "單行文字方塊"
        ],
        "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": "單行文字方塊",
        "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.api()請求使用

有關詳細的kintone.api()，請參閱以下頁面。
發送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
35
36
37
38
39

const body = {
  app: kintone.app.getId(),
  views: {
    一覧1: {
      index: '0',
      type: 'LIST',
      name: '一覧1',
      fields: [
        '記錄號碼',
        '單行文字方塊'
      ],
      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: '單行文字方塊',
      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 權杖。