kintone API文件

獲取清單設置

information

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

目錄

獲取清單設置

連結已複製

獲取應用清單的設置。

URL

連結已複製

獲取正式環境的設置時，URL 與獲取測試環境的設置時不同。

如果要獲取正式環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/app/views.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/views.json
獲取操作測試環境的設置
常規應用程式
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 方法

連結已複製

GET

所需存取權限

連結已複製

如果要獲取正式環境的設置

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

  • 應用程式中記錄的查看權限
  • 應用程式中新增記錄的權限
獲取操作測試環境的設置
  • 應用程式管理權限

請求

連結已複製

參數
參數名稱 類型 必須 說明
app 數值 必須 應用ID
lang 字串 可省略 要選取的名稱的語言
如果為欄位或選項的名稱設置了多語言對應，請指定。
多語言對應 (External link)
  • ja：日文
  • en：英語
  • zh：中文
  • user：執行 API 的使用者設置為顯示語言的語言
    如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言取決於是否存在「Accept-Language」標頭。
    • 帶標題：帶標頭：「Accept-Language」標頭中指定的語言
    • 無標頭：在通用管理的地區設定中設置 cybozu.com 語言
      地區設定 (External link)
  • default：預設
如果省略，則獲取預設名稱。
範例請求（如果要在網址中包含參數 ）
URL

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

標頭
1
2
3

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

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

要求範例（如果要在要求內文中包含參數）
URL

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

回應

連結已複製

屬性
屬性名稱 類型 說明
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 字串 應用設置的修訂號
應答範例
 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"
}

示例代碼

連結已複製

使用 curl 的請求
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()，請參閱以下頁面。
發送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);

限制

連結已複製

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