變更清單的設置

連結已複製

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

HTTP 方法	PUT
URL	https://sample.cybozu.com/k/v1/preview/app/views.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/views.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json

請求參數

連結已複製

參數名稱	指定值	必須	說明
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`為「CALENDAR」時，需要指定。如果省略，則設置為「true」。
views.`清單名稱`.device	字串	可省略	顯示清單的環境 `DESKTOP`：只在電腦版上顯示 `ANY`：在電腦版和行動裝置版上顯示 `views.清單名稱.type`為「CALENDAR」時，需要指定。如果省略，添加清單時將默認設置「DESKTOP」，變更清單設置時，將不做任何變更。
views.`清單名稱`.filterCond	字串	可省略	記錄篩選條件以查詢格式指定。有關查詢格式的詳細資訊，請參閱以下頁面。如何編寫查詢
views.`清單名稱`.sort	字串	可省略	記錄排序以查詢格式指定。有關查詢格式的詳細資訊，請參閱以下頁面。如何編寫查詢
revision	數值或字串	可省略	預期修訂號與實際修訂號不匹配時，則會發生錯誤，並且清單中的設置不會變更。如果指定值「-1」或未指定值，則不會驗證修訂號。

應答屬性

連結已複製

屬性名稱	類型	說明
views	物件	清單的資訊
views.`清單名稱`.id	字串	清單ID
revision	字串	變更應用程式設置后的修訂號

所需存取權限

連結已複製

表格或行事曆格式時

連結已複製

應用程式管理權限

自訂格式時

連結已複製

kintone系統管理權限

範例

連結已複製

請求範例

請求標頭

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"
    }
  }
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "views": {
    "行事曆": {
      "id": "1320"
    },
    "清單1": {
      "id": "1321"
    },
    "自訂": {
      "id": "1322"
    }
  },
  "revision": 2
}

範例程式碼

使用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);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行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
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"
      }
    }
  }'

補充

連結已複製

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

限制事項

連結已複製

如果存在同名清單，則無法變更設置。
如果要修改包含「自訂格式」清單的應用程式，則不能使用API權杖。

kintone API

kintone API文件

變更清單的設置

目錄

請求參數

應答屬性

所需存取權限

表格或行事曆格式時

自訂格式時

範例

補充

限制事項