獲取欄位的存取權限設置

kintone API

獲取欄位的存取權限設置

連結已複製

獲取欄位的存取權限設置。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/field/acl.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/field/acl.json
URL（操作測試環境）	https://sample.cybozu.com/k/v1/preview/field/acl.json
URL（測試環境中的訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/field/acl.json
認證	密碼驗證 , API令牌認證 , 會話認證 \
Content-Type	application/json（透過查詢字串指定查詢時不需指定此項）

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用程式ID

應答屬性

連結已複製

屬性名稱	類型	說明
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`的值而異。對於「USER」：用戶的登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼 FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位如果指定訪客，則登入名前面應以「guest/」開頭。
rights[].entities[].includeSubs	布爾值	設置是否由子單位繼承 `true`：繼承 `false`：不繼承 `entity.type` 僅當為「ORGANIZATION」或在「FIELD_ENTITY」中指定組織選擇欄位時，才返回「true」。
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

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

1

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

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

1
2
3


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

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

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

1

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
}

範例回應

 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": "單行文字方塊_0",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "code": "數值_0",
      "entities": [
        {
          "accessibility": "NONE",
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "includeSubs": true
        }
      ]
    }
  ],
  "revision": "2"
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST 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);

使用curl傳送請求

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

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 API

kintone API文件

獲取欄位的存取權限設置

目錄

請求參數

應答屬性

所需存取權限

範例