Sharing a File

Function

Share a file.

URI

POST /koodrive/ose/v1/share

Request Parameters

**Table 1** Request header 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.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
scope	Yes	Integer	Sharing scope. 1: all users who receive the link; 2: enterprise users only; 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.

**Table 3** SharePermission
Parameter	Mandatory	Type	Description
preview	No	Boolean	Preview permission.
edit	No	Boolean	Editing permission.
download	No	Boolean	Download permission.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
shareLink	shareLink object	Sharing link information.

**Table 5** shareLink
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing short code.
linkUrl	String	Sharing link.
extractCode	String	Access code.
comment	String	Message.
createTime	String	Creation time.
expireTime	String	Expiration time.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	Error object

**Table 7** Error
Parameter	Type	Description
errorData	errorData object	Extended data returned to visitors when an exception occurs.
errorDetail	Array of ErrorMsg objects	Error chain.
code	Integer	HTTP status code.
description	String	HTTP status information.

**Table 8** errorData
Parameter	Type	Description
conflictFileId	String	Conflicting file ID.

**Table 9** ErrorMsg
Parameter	Type	Description
domain	String	Domain.
reason	String	Error cause.
errorCode	String	Internal system error code. For details, see the error code specifications.
description	String	Error message.
errorPos	String	Error position type.
errorParam	String	Error position.

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

{
  "data" : {
    "taskId" : "1428103989525998336"
  },
  "code" : 0,
  "msg" : "OK"
}

Status code: 400

{
  "error" : {
    "errorData" : {
      "conflictFileId" : "string"
    },
    "errorDetail" : [ {
      "domain" : "string",
      "reason" : "string",
      "errorCode" : "string",
      "description" : "string",
      "errorPos" : "string",
      "errorParam" : "string"
    } ],
    "code" : 0,
    "description" : "string"
  }
}