變更應用程式的設定

information

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

目錄

變更應用程式的設定

打開應用程式的設定進行變更。

此 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.一覧名 物件 必須 每個清單的設置
  • 新增清單
    指定要添加到的清單的名稱 一覧名
  • 變更清單時:
    在更新到 一覧名 之前指定清單的名稱。
  • 移除清單時:
    不指定要刪除的清單名稱的屬性。
如果啟用了進程管理,請一覧名 為 指定 (Worker is me},
views.一覧名.index 字串 必須 清單順序
該清單按指定的數位升序排序。
views.一覧名.type 字串 必須 清單格式
  • LIST:表格格式
  • CALENDAR :行事曆格式
  • CUSTOME:自訂
views.一覧名.name 字串 條件必填項 新清單的名稱。
最多指定 64 個字元。
如果要添加新清單,則為必填項,請指定一覧名 與 相同的值。
views.一覧名.fields 陣列 條件必填項 要顯示的欄位的欄位代碼清單
指定要顯示的每個欄位的欄位代碼。
views.一覧名.type 如果為"LIST",則為必填項。
views.一覧名.date 字串 自選 要用作日期的欄位的域代碼
views.一覧名.type 是"日曆"。
如果省略,則設置修改後的日期和時間欄位。
views.一覧名.title 字串 自選 要用作標題的欄位的域代碼
views.一覧名.type 是"日曆"。
如果省略,則設置記錄編號欄位。
views.一覧名.html 字串 自選 用於自訂的 HTML 內容
views.一覧名.type 是"CUSTOM"。
views.一覧名.pager 布爾值 自選 分頁顯示
  • true:顯示
  • false:不顯示
views.一覧名.type 是"CUSTOM"。
如果省略,則設置為「true」。
views.一覧名.device 字串 自選 清單的顯示範圍
  • DESKTOP:只在電腦版上顯示
  • ANY:在電腦版和行動版上顯示
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": 4,
  "views": {
    "清單": {
      "index": "0",
      "type": "LIST",
      "name": "清單",
      "fields": ["記錄編號" "string__1line_"],
      "filterCond": "更新時間 > \"2012-02-03T09:00:00Z\" and 更新時間 < \"2012-02-03T10:00:00Z\"",
      "sort": "記錄編號 asc"
    },
    "(我的工作)": {
      "index": "3",
      "type": "LIST"
    },
    "行事曆": {
      "index": "1",
      "type": "CALENDAR",
      "name": "行事曆",
      "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"
    },
    "清單": {
      "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": {
      "清單": {
        "index": "0",
        "type": "LIST",
        "name": "清單",
        "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": "行事曆",
        "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 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: {
    清單: {
      index: '4',
      type: 'LIST',
      name: '清單',
      fields: [
        '記錄號碼',
        '單行文字方塊',
      ],
      filterCond: '更新時間 > "2012-02-03T09:00:00Z" and 更新時間 < "2012-02-03T10:00:00Z"',
      sort: '記錄編號 ASC'
    },
    '(我的工作)': {
      index: '4',
      type: 'LIST',
      filterCond: '建立者 in (LOGINUSER())'
    },
    行事曆: {
      index: '4',
      type: 'CALENDAR',
      name: '行事曆',
      date: '建立時間',
      title: '單行文字方塊',
      filterCond: '更新時間 > "2012-02-03T09:00:00Z" and 更新時間 < "2012-02-03T10:00:00Z"',
      sort: '記錄編號 ASC'
    },
    自訂: {
      index: '4',
      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 令牌。