# 添加协作者
# host: https://yach-oapi.zhiyinlou.com 正式环境
# host: https://yach-oapi-test.zhiyinlou.com 测试环境
# 概述
名称 | 值 |
---|---|
地址 | /openapi/v2/doc/collaborator/add |
请求方式 | POST |
参数 | 见【参数】 |
返回值 | 见【返回值】 |
# header
名称 | 值 |
---|---|
Content-Type | application/json |
# 参数
参数 | 参数类型 | 必须 | 说明 |
---|---|---|---|
access_token | String | 是 | 调用接口凭证 |
guid | String | 是 | 文档的guid |
collaborators | Array(Object) | 是 | 协作者对象列表 |
└ work_code | String | 否 | 要添加协作者的工号,和depart_id二选一 |
└ role | String | 是 | 协作者角色,可编辑:"editor" 可阅读:"reader" 可评论:"commentator" |
└ user_type | Int | 是 | 协作者类型,如果是用户传0,如果是部门传1,即该值为0时work_code不能为空,该值为1时depart_id不能为空 |
└ depart_id | Int | 否 | 要添加协作部门id,和work_code二选一 |
入参示例:
{
"access_token":"RHJka2NUc0VvUTBGN2RHK2pMU1VqZEp1UmprcFRtN2N3amhKb04zQ2dIS0tORlNxeHlIdE1ROSsrNXNpTUp3UlNxU0N1RURraUFBbi96ZVJ1MVIrRFhyakNUanZEVDNiZHAxRm9FYmRGck5pSVBCK2JJV21YLzZUaTlyOVlqZUo4c3VqUWg5bzBTQTE3Uml6NzlvZzZRPT0",
"guid":"pmkxQYN2X9CZWxAN",
"collaborators": [
{
"work_code":"xxxxx",
"role":"reader",
"user_type":0
},
{
"work_code":"xxxxx",
"role":"editor",
"user_type":0
},
{
"depart_id":121212,
"role":"commentator",
"user_type":1
}
]
}
返回值(响应从的 200为成功,非200为不成功)
{
"code":200,
"obj":null,
"msg":""
}