Obtain Sharing Details

Function

Obtain sharing details.

URI

GET /koodrive/ose/v1/share/received/{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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
shareLink	ShareWithMeLinkDetail object	Information about the link shared with you.

**Table 4** ShareWithMeLinkDetail
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing short code.
linkUrl	String	Sharing link.
shareTime	String	Time when the file is shared.
ownerId	String	Sharer ID.
ownerName	String	Sharer name.
displayName	String	Display name.
permission	SharePermission object	Sharing permission (supported in the future).
expireTime	String	Expiration time.
status	Integer	Sharing status. 0: determined based on the expiration time. 1: The file has been deleted. 2: expired.
comment	String	Sharing message.

**Table 5** SharePermission
Parameter	Type	Description
preview	Boolean	Preview permission.
edit	Boolean	Editing permission.
download	Boolean	Download permission.

Example Requests

GET /koodrive/ose/v1/share/received/{shareId}

Authorization:Bearer+10f88*************5a544791e9ff

Example Responses

Status code: 200

{
  "code" : "string",
  "msg" : "string",
  "shareLink" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "string",
    "ownerId" : "string",
    "ownerName" : "string",
    "displayName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:18:51.520Z",
    "status" : 0,
    "comment" : "string"
  }
}