獲取清單設置

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 的使用者設置為顯示語言的語言
    如果語言設置為"遵循 Web 瀏覽器設置",則要檢索的語言取決於是否存在"Accept-Language"標頭。
    • 帶標頭:「Accept-Language」標頭中指定的語言
    • 無標頭:在通用管理的「 區域設置 (External link) 」中設置 cybozu.com 語言
  • 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": 1,
  "lang": "ja"
}

回應

財產
屬性名稱 說明
views 物件 配置清單
views.一覧名 字串 每個清單的設置
views.一覧名.type 字串 清單格式
  • LIST:表格格式
  • CALENDAR :行事曆格式
  • CUSTOME:自訂
views.一覧名.builtinType 字串 一覧名 僅當"(worker is me)"時輸出的屬性
返回"ASSIGNEE"。
啟用行程管理功能時,會自動創建"(Worker)"清單。
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": "カレンダー",
      "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": 1
    "lang": "ja"
  }'
使用 發送kintone REST API請求的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);

限制

  • 如果存在同名清單,則無法檢索設置。