Skip to main content

Get Protect Roles API (可选API)

MethodAPI描述
GET/{context}/{docId}/protect-roles获取文档保护角色列表

功能说明: 返回由 docId 指定的文档的全量保护角色列表(不按当前用户过滤)。按角色授权功能中,作者为段落/区域绑定角色时可选取的角色即来自该接口。角色管理(增删改)由三方负责。

例子:

GET http://172.16.52.223/v2/context/DOC-123/protect-roles

返回:

[
{
"id": "r-001", //必须有
"name": "法务审核" //必须有
},
{
"id": "r-002", //必须有
"name": "部门编辑" //必须有
}
]

注意:

  1. 响应为直接的 JSON 数组,不要用 { "data": [...] } 之类的对象包装。

  2. id 为角色唯一标识,trim 后必须非空,空 id 的条目会被丢弃;name 缺失时回落为 id。文档中台会按 id 去重(保留首个出现的条目)。

  3. 该接口无缓存,每次实时调用。

  4. meta 接口返回的 protectRole.id 必须能在本接口返回的列表中找到,否则被视为「失效角色」,该用户无法编辑对应区域。