Modifying Sharing Settings

Function

Modify sharing settings.

Authorization Information

No identity policy-based permission required for calling this API.

URI

PUT /koodrive/ose/v1/share/{shareId}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
shareId	Yes	String	Sharing ID.

Request Parameters

**Table 2** 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.
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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
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.
permission	No	SharePermission object	Sharing permission (supported in the future).
expireTime	No	String	Expiration time.
extractCode	No	String	Access code.
comment	No	String	Sharing message.
validDays	Yes	Integer	Sharing validity period, ranging from 0 to 365 days. 0 indicates no change.

**Table 4** 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 5** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
shareLink	shareLink object	Sharing link information.

**Table 6** shareLink
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing link.
extractCode	String	Access code.
createTime	String	Creation time.
updateTime	String	Modification time.
expireTime	String	Expiration time.
linkUrl	String	Sharing link.
shareTime	String	Time when the file is shared.
scope	Integer	Scope.
displayName	String	Display name.
status	Integer	Status. 0: determined based on the expiration time 1: file deleted 2: invalid 3: expired
viewCnt	String	Number of views.
downloadCnt	String	Download times.
saveCnt	String	Save times.

Example Requests

PUT /koodrive/ose/v1/share/{shareId}

{
  "deptIds" : [ "string" ],
  "groupIds" : [ "string" ],
  "userIds" : [ "string" ],
  "permission" : {
    "preview" : true,
    "edit" : true,
    "download" : true
  },
  "expireTime" : "2024-06-03T02:00:39.952Z",
  "extractCode" : "string",
  "comment" : "string",
  "validDays" : 0
}

Example Responses

Status code: 200

{
  "code" : "string",
  "msg" : "string",
  "shareLink" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "extractCode" : "string",
    "createTime" : "2024-06-03T02:00:39.953Z",
    "updateTime" : "2024-06-03T02:00:39.953Z",
    "expireTime" : "2024-06-03T02:00:39.953Z"
  }
}