GET/users/{userId}/drive/sharedfolders

共有されたフォルダのリストを取得する。

Authorization

oauth2

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

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/drive/sharedfolders

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{externalKey})
  • 自身 ("me")

required
example : me 

Query Parameters

ParameterTypeDescription
count integer 

取得数


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

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
allowReserved : false 
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 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
responseMetaData object (responseMetaData) 

応答のメタデータ

 
result array (object) 
 

responseMetaData

PropertyTypeDescription
nextCursor string 

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


readOnly : true 

object

PropertyTypeDescription
sharedFolderId string 

共有されたフォルダ ID


readOnly : true 
sharedFolderName string 

共有されたフォルダ名


readOnly : true 
ownerId string 

所有者 ID


readOnly : true 
ownerName string 

所有者の名前


readOnly : true 
rootFileId string 

ルートフォルダのファイル ID


readOnly : true 
createdTime string 

作成日時


format : date-time
readOnly : true 
modifiedTime string 

更新日時


format : date-time
readOnly : true 
resourceLocation integer 

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


format : int32
readOnly : true 
permissionType string 

編集権限

  • READ : 読み込み権限
  • WRITE : 書き込み権限

Allowed values : READ, WRITE 
useRevision boolean 

バージョン履歴の使用フラグ


readOnly : true 
protected boolean 

重要マーク


readOnly : true 

Response Example

example

1{2  "responseMetaData": {3    "nextCursor": "TlRnd09UQXdORjlFWHprek9Ea3lPRFUyTWpRek5nfGRlIHdhbnRzIHRvIHNoYXJl"4  },5  "sharedFolders": [6    {7      "sharedFolderId": "NTgwOTAwNF9EXzkzODkyODU2MjQzNg",8      "sharedFolderName": "share",9      "ownerId": "userf7da-f82c-4284-13e7-030f3b4c756x",10      "ownerName": "ownerName",11      "rootFileId": "NTgwOTAwNHw5Mzg5Mjg1NjI0MzZ8RHwxNzQ",12      "createdTime": "2023-07-06T16:27:28+09:00",13      "modifiedTime": "2023-07-06T16:27:28+09:00",14      "resourceLocation": 11551,15      "permissionType": "WRITE",16      "useRevision": true,17      "protected": false18    }19  ]20}