GET/sharedrives/{sharedriveId}/trash-files

共有ドライブのゴミ箱のファイルリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

file
file.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
sharedriveId string 

共有ドライブ ID (URL エンコードする)


required
example : @2101000000000008 

Query Parameters

ParameterTypeDescription
orderBy string 

ソート対象や順番は空白 (%20) で区分
ex) createdTime%20desc

  • ソート対象
    • ファイル : createdTime, modifiedTime, accessedTime, fileExtension, fileName, filePath, fileSize, fileType, protect
    • ゴミ箱のファイル : deletedTime, fileSize, fileType, fileName, originalPath
  • 順番
    • asc : 昇順
    • desc : 降順

example : createdTime%20desc 
count integer 

取得数


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

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
allowReserved : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
trashFiles array (TrashFile) 

ゴミ箱のファイル情報

 
responseMetaData object (responseMetaData) 

応答のメタデータ

 

TrashFile

PropertyTypeDescription
deletedTime string 

削除日時


readOnly : true 
deleteUser string 

削除ユーザーのユーザー ID (userId)


readOnly : true 
fileName string 

ファイル名


readOnly : true 
fileSize integer 

ファイルサイズ


format : int64
readOnly : true 
fileType string 

ファイルタイプ

  • AUDIO : オーディオファイル
  • DOC : 文書ファイル
  • ETC : その他のファイル
  • EXE : 実行ファイル
  • FOLDER : フォルダ
  • IMAGE : 画像ファイル
  • VIDEO : 動画ファイル
  • ZIP : 圧縮ファイル

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

削除前のパス


readOnly : true 
resourceLocation integer 

リソースロケーションコード


format : int32
readOnly : true 
trashFileId string 

削除ファイル ID


readOnly : true 
modifiedTime string 

更新日時


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値


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}