1. 设置文档的权限
设置文档权限,key为{key}的文档的权限。
请求方式:PUT
请求地址:/bosdocumentservice/{appKey}/documents/gacl/{key}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
key | string | doc-01 | 是 | 文档 document key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 是 | 业务事务编码 |
Body:
application/json:
{
"gacl": [
{
"flags": "",
"principal": "users/test",
"permissions": "r"
},
{
"flags": "",
"principal": "users/test2",
"permissions": "rwd"
},
{
"flags": "",
"principal": "users/admin",
"permissions": "rwdc"
}
]
}
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://bosgw.bimwinner.com/bosdocumentservice/h5e4ff8257dc4e86a8042097f67d2718/documents/xxxx"
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | GACL_NA | 应用未开启gacl授权模式 | NULL | 当应用未启用gacl数据级权限控制时 |
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 无法找到文件夹 |
200 | ENTITY_CONTROLPER | 缺少实体对象{bosclass/key}的控制权限 | NULL | 当前用户如果无该文件夹的授权权限时 |
200 | JSON_FORMAT_WRONG | Json格式错误 | NULL | 当传入Body格式错误时 |
200 | OBJECT_REQUIREDFIELD | XXX属性必填 | NULL | 当必填字段缺失时 |
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当principal指定的用户或角色不存在时 |
200 | ENTITYKEY_FORMAT | 实体对象{bosclass/key}格式错误 | NULL | 当principal格式错误时 |
200 | ENTITY_CONTROLPE | 缺少实体对象{entity/key}的控制权限 | NULL | 当前用户无该实体的c控制权限时 |
200 | ENTITY_PERMISSION | 不可删除当前用户对{bosclass/key}的最后一个控制权限 | NULL | 当前用户对该实体仅有一个c控制权限 |
1.5. 注意事项:
1、 每个文档必须拥有一个用户可以对其进行授权操作。
2、 增加权限时,要求必须确保上层各级目录有读取权限,如没有,则需增加授权。
3、 用户必须有该文档的授权权限。
4、历史版本文档、当前文档及历史版本文档关联的文件的权限同当前文档权限。