獲取清單設置

連結已複製

獲取應用清單的設置。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/app/views.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/views.json
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
lang	字串	可省略	要選取的名稱的語言如果為欄位或選項的名稱設置了多語言對應，請指定。多語言對應 `ja`：日文 `en`：英語 `zh`：中文 `user`：執行 API 的使用者設置為顯示語言的語言如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言取決於是否存在「Accept-Language」標頭。帶標題：帶標頭：「Accept-Language」標頭中指定的語言無標頭：在cybozu.com通用管理的地區設定中設置的語言地區設定 `default`：預設如果省略，則獲取預設名稱。

回應屬性

連結已複製

屬性名稱	類型	說明
views	物件	設定清單
views.`清單名稱`	物件	每個清單的設置
views.`清單名稱`.type	字串	清單顯示格式 `LIST`：表格格式 `CALENDAR`：行事曆格式 `CUSTOM`：自訂
views.`清單名稱`.builtinType	字串	`清單名稱` 僅當「（我的工作）」時輸出的屬性返回「ASSIGNEE」。啟用行程管理功能時，會自動創建「（我的工作）」清單。
views.`清單名稱`.name	字串	清單名稱
views.`清單名稱`.id	字串	清單的ID
views.`清單名稱`.fields	陣列	要顯示的欄位的欄位代碼清單 `views.清單名稱.type`為「LIST」時返回。
views.`清單名稱`.date	字串	要用於顯示日期的欄位的欄位代碼 `views.清單名稱.type`為「CALENDAR」時返回。
views.`清單名稱`.title	字串	要用於顯示標題的欄位的欄位代碼 `views.清單名稱.type`為「CALENDAR」時返回。
views.`清單名稱`.html	字串	用於自訂的 HTML 內容 `views.清單名稱.type`為「CUSTOM」時返回。
views.`清單名稱`.pager	布爾值	分頁顯示 `true`：分頁顯示 `false`：不顯示 `views.清單名稱.type`為「CUSTOM」時返回。
views.`清單名稱`.device	字串	清單的顯示範圍 `DESKTOP`：只在電腦版上顯示 `ANY`：在電腦版和行動版上顯示 `views.清單名稱.type`為「CUSTOM」時返回。
views.`清單名稱`.filterCond	字串	記錄篩選條件它以查詢的形式表示。有關查詢格式的詳細資訊，請參閱以下頁面。如何編寫查詢
views.`清單名稱`.sort	字串	記錄排序它以查詢的形式表示。有關查詢格式的詳細資訊，請參閱以下頁面。如何編寫查詢
views.`清單名稱`.index	字串	清單顯示順序（升序）
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

取得正式環境的設定

連結已複製

您必須具有以下權限之一：

應用程式中記錄的查看權限
應用程式的記錄添加權限

取得操作測試環境的設定

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

https\://sample.cybozu.com/k/v1/app/views.json?app=8&lang=ja

請求標頭（在URL中包含參數的情況）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求URL（在請求主體中包含參數的情況）

1

https\://sample.cybozu.com/k/v1/app/views.json

請求標頭（在請求主體中包含參數的情況）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求主體

1
2
3
4


{
  "app": 8,
  "lang": "ja"
}

範例回應

 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
41
42
43
44


{
  "views": {
    "(執行者為自己)": {
      "type": "LIST",
      "builtinType": "ASSIGNEE",
      "name": "(執行者為自己)",
      "id": "1101",
      "fields": ["記錄號碼", "更新時間", "更新人", "單行文字方塊_0"],
      "filterCond": "執行者 in (LOGINUSER())",
      "sort": "記錄編號 asc",
      "index": "0"
    },
    "清單1": {
      "type": "LIST",
      "name": "清單1",
      "id": "1102",
      "fields": ["記錄號碼", "單行文字方塊_0"],
      "filterCond": "更新時間>\"2012-02-03T09:00:00Z\"and更新時間<\"2012-02-03T10:00:00Z\"",
      "sort": "記錄編號 asc",
      "index": "2"
    },
    "行事曆": {
      "type": "CALENDAR",
      "name": "行事曆",
      "id": "1103",
      "date": "建立時間",
      "title": "單行文字方塊_0",
      "filterCond": "更新時間>\"2012-02-03T09:00:00Z\"and更新時間<\"2012-02-03T10:00:00Z\"",
      "sort": "記錄編號 asc",
      "index": "3"
    },
    "自訂": {
      "type": "CUSTOM",
      "name": "自訂",
      "id": "1104",
      "html": "自定清單的HTML<br />",
      "filterCond": "更新時間>\"2012-02-03T09:00:00Z\"and更新時間<\"2012-02-03T10:00:00Z\"",
      "sort": "記錄編號 asc",
      "index": "1",
      "device": "ANY"
    }
  },
  "revision": "1"
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
6


const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

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

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

1
2
3
4
5
6
7


curl -X GET 'https://sample.cybozu.com/k/v1/app/views.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 8,
    "lang": "ja"
  }'

限制事項

連結已複製

如果存在同名清單，則無法獲取設置。

kintone API

kintone API文件

獲取清單設置

目錄

請求參數

回應屬性

所需存取權限

取得正式環境的設定

取得操作測試環境的設定

範例

限制事項