kintone Customization Gallery

獲取欄位的許可權設置

information

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

目錄

獲取欄位的許可權設置

連結已複製

獲取欄位的許可權設置。

URL

連結已複製

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

如果要獲取生產環境的設置
常規應用
https://sample.cybozu.com/k/v1/field/acl.json
建立訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/field/acl.json
獲取操作測試環境的設置
常規應用
https://sample.cybozu.com/k/v1/preview/field/acl.json
建立訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/field/acl.json

HTTP 方法

連結已複製

GET

所需許可權

連結已複製

  • 應用程式管理

請求

連結已複製

參數
參數名稱 型 必須 說明
app 數位或字串 必須 應用ID
範例請求（如果在網址中包含參數 ）
URL

https://sample.cybozu.com/k/v1/field/acl.json?app=1

頁眉
1
2
3

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

關於請求頭，請參見 kintone REST API的通用規範 。

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

https://sample.cybozu.com/k/v1/field/acl.json

頁眉
1
2
3
4

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

關於請求頭，請參見 kintone REST API的通用規範 。

身體
1
2
3

{
  "app": 1
}

回應

連結已複製

財產
屬性名稱 型 說明
rights 陣列 存取權限清單
rights[].code 字串 用於設置訪問許可權的域代碼
rights[].entities 陣列 可以為其設置許可權的訪問許可權清單
設置按從高優先順序到最低的順序排列。
rights[].entities[].accessibility 字串 您可以對欄位執行哪些操作
  • READ：僅流覽
  • WRITE：查看和編輯
  • NONE：無法查看或編輯
rights[].entities[].entity 物件 設置許可權的內容
rights[].entities[].entity.type 字串 訪問許可權的類型
  • USER：使用者
  • GROUP：群組
  • ORGANIZATION：組織
  • FIELD_ENTITY：在添加表單欄位中指定的欄位
rights[].entities[].entity.code 字串 要為其設置許可權的代碼
entity.type 這取決於的值。
  • 對於"使用者"：用戶的登錄名
  • 對於"GROUP"：組代碼
  • 對於"ORGANIZATION"：組織代碼
  • 對於FIELD_ENTITY：在添加表單欄位中指定的欄位的欄位代碼
如果指定來賓使用者，則登錄名前面應以「guest/」開頭。
rights[].entities[].includeSubs 布爾值 設置是否由子單位繼承
  • true：繼承
  • false：不繼承
entity.type 僅當為"ORGANIZATION"或在"FIELD_ENTITY"中指定組織選擇欄位時，才返回"true"。
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

{
  "rights": [
    {
      "code": "字串",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "code": "數值",
      "entities": [
        {
          "accessibility": "NONE",
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "includeSubs": true
        }
      ]
    }
  ],
  "revision": "2"
}

示例代碼

連結已複製

使用 curl 的請求
1
2
3
4
5
6

curl -X GET 'https://sample.cybozu.com/k/v1/field/acl.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1
  }'
發送kintone REST API請求 使用API 發送請求
1
2
3
4
5

const body = {
  app: kintone.app.getId()
};

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