獲取記錄的存取權限設置

information

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

目錄

獲取記錄的存取權限設置

獲取記錄的存取權限設置。

URL

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

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

HTTP 方法

GET

所需存取權限

  • 應用程式管理

請求

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

https://sample.cybozu.com/k/v1/record/acl.json?app=1&lang=ja

標頭
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

關於請求標頭,請參見 kintone REST API的通用規範

範例要求(如果要在要求內文中包含參數)
URL

https://sample.cybozu.com/k/v1/record/acl.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"
}

回應

屬性
屬性名稱 類型 說明
rights 陣列 存取權限清單
設置按從高優先順序到最低的順序排列。
rights[].filterCond 字串 記錄的條件
它以查詢的形式表示。有關查詢格式,請參閱 如何編寫查詢
rights[].entities 陣列 可以為其設置許可權的訪問許可權清單
設置按從高優先順序到最低的順序排列。
rights[].entities[].entity 物件 設置存取權限的內容
rights[].entities[].entity.type 字串 訪問許可權的類型
  • USER:使用者
  • GROUP:群組
  • ORGANIZATION:組織
  • FIELD_ENTITY:在“選擇表單中的欄位“中指定的欄位
rights[].entities[].entity.code 字串 要為其設置許可權的代碼
這取決於entity.type值。
  • 對於“USER:用戶的登入名稱
  • 對於“GROUP”:群組代碼
  • 對於“ORGANIZATION”:組織代碼
  • 對於FIELD_ENTITY:在選擇表單中的欄位中指定的欄位的欄位代碼
rights[].entities[].viewable 布爾值 是否可以查看記錄
  • true: 可以查看
  • false:不可見
rights[].entities[].editable 布爾值 是否可以編輯記錄
  • true:可編輯
  • false:無法編輯
rights[].entities[].deletable 布爾值 是否可以刪除記錄
  • true:可以刪除
  • false:無法刪除
rights[].entities[].includeSubs 布爾值 是否要將設置繼承到子單位
  • true:繼承
  • false:不繼承
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
{
  "rights": [
    {
      "filterCond": "更新時間 > \"2012-02-03T09:00:00Z\" and 更新時間 < \"2012-02-03T10:00:00Z\"",
      "entities": [
        {
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "viewable": false,
          "editable": false,
          "deletable": false,
          "includeSubs": true
        },
        {
          "entity": {
            "type": "FIELD_ENTITY",
            "code": "更新人"
          },
          "viewable": true,
          "editable": true,
          "deletable": true,
          "includeSubs": false
        }
      ]
    }
  ],
  "revision": "2"
}

示例代碼

使用 curl 的請求
1
2
3
4
5
6
7
curl -X GET 'https://sample.cybozu.com/k/v1/record/acl.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/record/acl.json', true), 'GET', body);