GET/sharedrives/{sharedriveId}/trash-files

Gets a list of trashed files in a collaborative drive.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/sharedrives/{sharedriveId}/trash-files

Path Parameters

ParameterTypeDescription
sharedriveId string 

Collaborative drive ID


required
example : @2101000000000008 

Query Parameters

ParameterTypeDescription
orderBy string 

Sort method. Use a blank space (%20) to separate "sort by" and "sort order." Example) createdTime%20desc

  • Sort by
    • Files: createdTime, modifiedTime, accessedTime, fileExtension, fileName, filePath, fileSize, fileType, protect
    • Trashed files: deletedTime, fileSize, fileType, fileName, originalPath
  • Sort order
    • asc: Ascending order
    • desc: Descending order

example : createdTime%20desc 
count integer 

Number of items to get


default : 20
minimum : 1
maximum : 200
example : 20
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
allowReserved : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
trashFiles array (TrashFile) 

Trashed file information

 
responseMetaData object (responseMetaData) 

Response metadata

 

TrashFile

PropertyTypeDescription
deletedTime string 

Deletion date


readOnly : true 
deleteUser string 

Deleted by


readOnly : true 
fileName string 

File name


readOnly : true 
fileSize integer 

File size


format : int64
readOnly : true 
fileType string 

File type

  • AUDIO: Audio file
  • DOC: Document file
  • ETC: Etc. file
  • EXE: Executable file
  • FOLDER: Folder
  • IMAGE: Image file
  • VIDEO: Video file
  • ZIP: Zip file

Allowed values : AUDIO, DOC, ETC, EXE, FOLDER, IMAGE, VIDEO, ZIP 
originalPath string 

Original path


readOnly : true 
resourceLocation integer 

Resource location code


format : int32
readOnly : true 
trashFileId string 

Trashed file ID


readOnly : true 
modifiedTime string 

Update date


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


readOnly : true 

Response Example

example

1{2  "trashFiles": [3    {4      "trashFileId": "MTQ1MDMwMDJ8MTQ1Mjk0NDU1Mjk3NnxGfDA",5      "fileName": "works.txt",6      "resourceLocation": 24101,7      "fileSize": 1048576,8      "fileType": "DOC",9      "originalPath": "/worksFolder/",10      "modifiedTime": "2021-08-14T11:06:39.39+09:00",11      "deletedTime": "2021-08-14T11:06:40.40+09:00",12      "deleteUser": "userf7da-f82c-4284-13e7-030f3b4c756x"13    },14    {15      "trashFileId": "MTEwMDAyNTA0NjQ1ODQ5fDM0NzI0NzM3OTg1ODg1NDgzNjB8Rnww",16      "fileName": "DeletedFolder",17      "resourceLocation": 24101,18      "fileSize": 0,19      "fileType": "FOLDER",20      "originalPath": "/",21      "modifiedTime": "2021-08-14T11:06:39.39+09:00",22      "deletedTime": "2021-08-14T11:06:40.40+09:00",23      "deleteUser": "userf7da-f82c-4284-13e7-030f3b4c756x"24    }25  ],26  "responseMetaData": {27    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="28  }29}