Set the permission roles of sharing participants
| Properties | Values |
|---|---|
| HTTP method | POST |
| Interface path | /nd/api/file/set_participant_role |
| Category | Share API |
Interface description
Interface path: /nd/api/file/set_participant_role
HTTP method: POST
HTTP method: POST
POST request body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id |
string |
Yes | File ID |
babelshare_id |
string |
Yes | Use users[].babelshareId from Get all sharing participants, preserving its string type. Do not substitute participantId, an employee ID or an email address. |
role_id |
int |
Yes | Take roles[].id from Get sharing permission types, preserving its JSON integer type. For the selected sample role with id: 10, pass 10. Do not pass permission, a role name or an array index. |
Scroll horizontally to view all columns
First query sharing participants using file_id and select the target record's babelshareId. Then select the role to assign from the sharing-role list's id values. Pass them as babelshare_id and role_id, respectively. The participant's users[].roleId describes their current role.
Example request (the participant identifier is illustrative; replace the file ID):
{
"file_id": "<FILE_ID>",
"babelshare_id": "1001",
"role_id": 10
}Return field description
{"code":0,"success":true}Call instructions
- Before calling, you need to complete Get token or the corresponding login-free authentication, and carry
Authorization: Bearer <access_token>in the request header. - If there are differences in parameters and return fields due to deployment versions, the actual private cloud API documents and joint debugging results should prevail.
- Category: Sharing API.