Listing Files Shared with You

Function

List shared files.

URI

POST /koodrive/ose/v1/share/files

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
shortUrl	Yes	String	Sharing short code.
parentFolder	No	String	Parent directory ID.
pageSize	No	Integer	Number of records to be returned on each page. Default and maximum value: 100. It is possible that partial or empty result pages are returned before the end of the result list has been reached.
pageCursor	No	String	Current page cursor, which is obtained from nextCursor of the previous response.
sortType	No	Integer	Sorting type. 1: by file name; 2: by file size; 4: by modification time (default).
sortDirection	No	Integer	Sorting order. 1: ascending; 2: descending (default).
kdstoken	No	String	Temporary token for sharing.
refreshCount	No	Boolean	Whether this API call is counted as a file view.
fileName	No	String	File name.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response information.
nextCursor	String	Pagination cursor. If the cursor does not exist, the last record has been returned.
link	CommonShareLink object	Public information of the access link.
files	Array of ShareFile objects	List of shared files.

**Table 4** CommonShareLink
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing short code.
shareTime	String	Time when the file is shared.
ownerId	String	Sharer ID.
ownerName	String	Sharer 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.

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

**Table 6** ShareFile
Parameter	Type	Description
id	String	*File ID.
fileName	String	*File name, which contains up to 160 bytes.
fileType	String	File type, which is input externally.
mimeType	String	*Content type.
parentFolder	Array of strings	List of parent directory IDs. Currently, only the first ID is used.
fileSuffix	String	File name extension, which is the last character string of fullFileExtension.
size	Integer	File size.
containers	Array of strings	Space ID.
createdTime	String	File creation time.
editedTime	String	File modification time.

Example Requests

POST /koodrive/ose/v1/share/files

{
  "shortUrl" : "string",
  "parentFolder" : "string",
  "pageSize" : 0,
  "pageCursor" : "string",
  "sortType" : 0,
  "sortDirection" : 0,
  "kdstoken" : "string",
  "refreshCount" : true,
  "fileName" : "string"
}

Example Responses

Status code: 200

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "link" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "shareTime" : "2024-06-03T02:23:40.607Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:23:40.607Z",
    "status" : 0
  },
  "files" : [ {
    "id" : "string",
    "fileName" : "string",
    "fileType" : "string",
    "mimeType" : "string",
    "parentFolder" : [ "string" ],
    "fileSuffix" : "string",
    "size" : 0,
    "containers" : [ "string" ],
    "createdTime" : "2024-06-03T02:23:40.607Z",
    "editedTime" : "2024-06-03T02:23:40.607Z"
  } ]
}