Sharing a File
Function
Share a file.
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Authorization |
Yes |
String |
Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}. |
X-Traceid |
No |
String |
Service trace ID, which contains 58 bits. |
X-User-Id |
Yes |
String |
User ID, which is used for app authentication. |
X-Date |
Yes |
String |
Date, which is used for app authentication. |
Host |
Yes |
String |
Address, which is used for app authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
scope |
Yes |
Integer |
Sharing scope. 1: users who receive the link (only for whitelisted users); 2: only enterprise users; 3: specified enterprise users. |
deptIds |
No |
Array of strings |
Department ID list. |
groupIds |
No |
Array of strings |
List of user group IDs. |
userIds |
No |
Array of strings |
User ID list. |
fileIds |
Yes |
Array of strings |
File ID list. |
containerId |
Yes |
String |
Space ID. |
permission |
No |
SharePermission object |
Sharing permission (supported in the future). |
extractCode |
No |
String |
Access code. |
expireTime |
No |
String |
Expiration time. |
comment |
No |
String |
Sharing message. |
validDays |
Yes |
Integer |
Sharing validity period. Value range: 1 to 365 days. |
expiredType |
No |
String |
Invalidation type. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
code |
String |
Response code. |
msg |
String |
Response information. |
shareLink |
shareLink object |
Sharing link information. |
Example Requests
POST /koodrive/ose/v1/share Authorization:Bearer+10f88**********4791e9ff { "scope": 0, "deptIds": [ "string" ], "groupIds": [ "string" ], "userIds": [ "string" ], "fileIds": [ "string" ], "containerId": "string", "permission": { "preview": true, "edit": true, "download": true }, "extractCode": "string", "expireTime": "2024-06-03T01:54:57.288Z", "comment": "string", "validDays": 0 }
Example Responses
Status code: 200
OK
{ "shareLink" : { "shareId" : "1537770199275722240", "shortUrl" : "1537770199275722241", "linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/cloudfile/#/sharelink/i/1537770199275722241", "extractCode" : "", "comment" : "", "expireTime" : "2024-10-29T09:14:52.948Z" }, "code" : 0, "msg" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot