GET/sharedrives/{sharedriveId}/files

共有ドライブのルートフォルダのファイルリストを取得する。

Authorization

oauth2

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

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/sharedrives/{sharedriveId}/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
files array (File) 

ファイル情報

 
responseMetaData object (responseMetaData) 

応答のメタデータ

 

File

PropertyTypeDescription
accessedTime string 

アクセス日時


readOnly : true 
createdTime string 

作成日時


readOnly : true 
fileId string 

ファイル ID


readOnly : true 
parentFileId string 

親ファイル ID


readOnly : true 
fileName string 

ファイル名


readOnly : true 
fileSize integer 

ファイルサイズ


format : int64
readOnly : true 
filePath string 

ファイルパス


readOnly : true 
fileType string 

ファイルタイプ

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

Allowed values : AUDIO, DOC, ETC, EXE, FOLDER, IMAGE, VIDEO, ZIP 
hasPermission boolean 

アクセス権限有りフラグ


readOnly : true 
permissionRootFileId string 

アクセス権限ルートファイル ID


readOnly : true
nullable : true 
shared boolean 

共有状態


readOnly : true
nullable : false 
shareRootFileId string 

共有したフォルダのルートフォルダ ID


readOnly : true
nullable : true 
resourceLocation integer 

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


format : int32
readOnly : true 
statuses array (ENUM_FileStatus) 

ファイルステータス

  • LOCKED : ロック中
  • MALWARE : マルウェア検出
  • PROTECTED : 重要マーク中
  • UPLOAD : アップロード中
 
modifiedTime string 

更新日時


readOnly : true 

ENUM_FileStatus

PropertyTypeDescription
ENUM_FileStatus string 

ファイルステータス

  • LOCKED : ロックされたファイル
  • MALWARE : マルウェアファイル
  • PROTECTED : 重要表示されたファイル
  • UPLOAD : アップロード中

Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 

responseMetaData

PropertyTypeDescription
nextCursor string 

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


readOnly : true 

Response Example

example

1{2  "files": [3    {4      "fileId": "QDIxMDAwMDAwMDAwMTcwfDExODE1MDg3MzQ0NzJ8RHww",5      "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",6      "resourceLocation": 24101,7      "fileSize": 10,8      "fileName": "works.txt",9      "filePath": "/ShareDriveName/works.txt",10      "fileType": "DOC",11      "createdTime": "2020-11-13T18:20:05.05+09:00",12      "modifiedTime": "2021-04-05T21:14:05.05+09:00",13      "accessedTime": "2021-04-05T21:14:05.05+09:00",14      "statuses": [],15      "hasPermission": false,16      "permissionRootFileId": null17    },18    {19      "fileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",20      "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",21      "resourceLocation": 24101,22      "fileSize": 0,23      "fileName": "worksFolder",24      "filePath": "/ShareDriveName/worksFolder/",25      "fileType": "FOLDER",26      "createdTime": "2020-11-13T18:20:05.05+09:00",27      "modifiedTime": "2021-04-05T21:14:05.05+09:00",28      "accessedTime": "2021-04-05T21:14:05.05+09:00",29      "statuses": [],30      "hasPermission": false,31      "permissionRootFileId": null32    }33  ],34  "responseMetaData": {35    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="36  }37}