Updated on 2024-07-30 GMT+08:00

Obtaining Sharing Information

Function

Obtain sharing information.

URI

GET /koodrive/ose/v1/share/userInfo

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

shortUrl

Yes

String

Sharing short code.

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.

link

CommonShareLink object

Public information of the access link.

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/userInfo?shortUrl=String

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

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "link" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "shareTime" : "2024-06-03T02:20:24.274Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:20:24.274Z",
    "status" : 0
  }
}

Status Codes

Status Code

Description

200

OK