获取字段的访问权限 - cybozu

获取字段的访问权限。

URI

获取正式环境的设置时所使用的URI跟获取测试环境设置时不一样。

获取正式环境的设置时

https://(子域名).cybozu.cn/k/v1/field/acl.json

来宾空间内的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/field/acl.json

获取测试环境的设置时

https://(子域名).cybozu.cn/k/v1/preview/field/acl.json

来宾空间内的应用：https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/field/acl.json

HTTP 方法

GET

必要的访问权限

应用的管理权限

请求参数

参数名称	要指定的值	必须	说明
app	数值或字符串	必须	指定应用的ID。

请求的范例

要发送的请求根据参数的发送方式不同而不同。以下是指定参数“app”时的请求范例。

URL中包含参数时

GET /k/v1/field/acl.json?app=8 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

请求正文中包含参数时
头部

GET /k/v1/field/acl.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

{
  "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	字符串	设置了访问权限的用户的代码。
rights[].entities[].includeSubs	布尔值	是否将设置继承给其下属组织。 true：继承 false：不继承
revision	字符串	应用的设定的修订号。

应答的范例

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

JavaScript 范例

使用API请求发送 kintone REST API 请求

var body = {
    "app": 1
};

kintone.api(kintone.api.url('/k/v1/field/acl', true), 'GET', body, function(resp) {
    // success
    console.log(resp);
}, function(error) {
    // error
    console.log(error);
});

使用 XMLHttpRequest 请求

var url = 'https://{subdomain}.cybozu.cn/k/v1/field/acl.json?app=1';
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send();

上一篇更改记录的访问权限

下一篇更改字段的访问权限