Get all sharing participants | BabelBird Enterprise Drive Docs

Properties	Values
HTTP methods	`GET`
Interface path	`/nd/api/share/share_participants`
Category	Share API

Interface description

Interface path: /nd/api/share/share_participants

HTTP method: GET

HTTP method: GET

URL parameters

Parameter	Type	Required	Description
`file_id`	`string`	Yes	File ID

Scroll horizontally to view all columns

Return field description

users is an array of sharing-participant records. When setting a participant's role, use the target record's babelshareId as babelshare_id, not participantId. The following fields and types come from the supplied non-empty sample; they do not establish identical non-null fields for every participant type.

Field	Sample type	Description
`babelshareId`	`string`	Sharing-participant record identifier; used as `babelshare_id` by Set permission roles for sharing participants.
`participantId`	`string`	Participant identifier, distinct from `babelshareId`.
`participantName`	`string`	Participant display name.
`babelId`	`string`	User employee-ID field.
`participantType`	`int`	Participant-type code; the sample uses `0`. The complete enum is not supplied.
`permission`	`int`	Permission value, not a role ID.
`roleId`	`int`	The participant's current role ID.
`roleName`	`string`	The participant's current role name.
`email`	`string`	Email address.
`registered`	`int`	Registration-related flag; the sample uses `1`.
`guest`	`int`	Guest-related flag; the sample uses `0`.
`belongToEnterprise`	`null`	The supplied value is `null`; the non-null type and structure are not supplied.
`needReview`	`int`	Review-related flag; the sample uses `0`.
`reviewResult`	`int`	Review-result code; the sample uses `-1`. The complete enum is not supplied.

Scroll horizontally to view all columns

The following retains the existing success-response envelope and adds one participant. Identifiers, name, employee ID and email have been replaced with example values:

{
  "code": 0,
  "users": [
    {
      "babelshareId": "1001",
      "participantId": "2001",
      "participantName": "示例成员",
      "babelId": "member-example",
      "participantType": 0,
      "permission": 3647,
      "roleId": 12,
      "roleName": "编辑",
      "email": "user@example.com",
      "registered": 1,
      "guest": 0,
      "belongToEnterprise": null,
      "needReview": 0,
      "reviewResult": -1
    }
  ],
  "success": true
}

To set a role, pass the selected record's babelshareId as the single string parameter babelshare_id. To remove sharing participants, put the target records' babelshareId values into the babelshare_ids array. Neither operation substitutes participantId for the sharing-record identifier.

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.