Copied.
Listing My Shares
Function
List files shared by you. One sharing record occupies one line. When multiple files are shared, a folder with the first file name is displayed. When a single file is shared, the file information is displayed.
Authorization Information
No identity policy-based permission required for calling this API.
URI
GET /koodrive/ose/v1/share
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| 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. Default value: 0. |
| sortType | No | Integer | Sorting type. 4: by sharing time (default). |
| sortDirection | No | Integer | Sorting order. 1: ascending; 2: descending (default). |
| displayName | No | String | Fuzzy match by display name is supported. |
| imageProcess | No | String | Image operation, which can be used to specify the thumbnail size. |
| usage | No | String | Thumbnail format of a document or video. Range: minThumbnail, midThumbnail, largeThumbnail, or superLargeThumbnail. |
Request 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. |
Response Parameters
Status code: 200
| 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. |
| shareLinks | Array of ShareByMeLink objects | Sharing link list. |
| Parameter | Type | Description |
|---|---|---|
| shareId | String | Sharing ID. |
| shortUrl | String | Sharing short code. |
| linkUrl | String | Sharing link. |
| shareTime | String | Time when the file is shared. |
| scope | Integer | Sharing scope. 1: users who receive the link (only for whitelisted users); 2: only enterprise users; 3: specified enterprise users. |
| files | Array of ShareFileInfo objects | List of shared files. |
| displayName | String | Display name. |
| 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. |
| viewCnt | Integer | Number of views. |
| downloadCnt | Integer | Number of download times (supported in the future). |
| saveCnt | Integer | Number of dump times (supported in the future). |
| containerId | String | ID of the space to which the shared file belongs. |
| containerName | String | Space to which the shared file belongs. |
| Parameter | Type | Description |
|---|---|---|
| id | String | *File ID. |
| fileName | String | *File name, which contains up to 250 bytes. |
| fileType | String | File type. |
| mimeType | String | *Content type. |
| size | Integer | File size. |
| 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. |
| containers | Array of strings | Space ID. |
| downloadLinks | Array of downloadLinks objects | Download link. |
| recycled | Boolean | Whether the file is in the recycle bin. |
Example Requests
GET /koodrive/ose/v1/share?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName= Authorization:Bearer+10f88*************5a544791e9ff
Example Responses
Status code: 200
OK
{
"code" : "string",
"msg" : "string",
"nextCursor" : "string",
"shareLinks" : [ {
"shareId" : "string",
"shortUrl" : "string",
"linkUrl" : "string",
"shareTime" : "2024-06-03T01:58:35.419Z",
"scope" : 0,
"files" : [ {
"id" : "string",
"fileName" : "string",
"fileType" : "string",
"mimeType" : "string",
"size" : 0,
"parentFolder" : [ "string" ],
"fileSuffix" : "string",
"containers" : [ "string" ]
} ],
"displayName" : "string",
"permission" : {
"preview" : true,
"edit" : true,
"download" : true
},
"extractCode" : "string",
"expireTime" : "2024-06-03T01:58:35.419Z",
"status" : 0,
"comment" : "string",
"viewCnt" : 0,
"downloadCnt" : 0,
"saveCnt" : 0,
"containerId" : "string",
"containerName" : "string"
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot