GET/users/{userId}/drive/sharedfolders/{sharedFolderId}

共有されたフォルダのフォルダプロパティを取得する。

Authorization

oauth2

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

Scope

file
file.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : me 
sharedFolderId string 

共有されたフォルダ ID


required
example : MTIzNDVfRF8xMjM0NQ 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

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  "sharedFolderId": "NTgwOTAwNF9EXzkzODkyODU2MjQzNg",3  "sharedFolderName": "share",4  "ownerId": "userf7da-f82c-4284-13e7-030f3b4c756x",5  "ownerName": "ownerName",6  "rootFileId": "NTgwOTAwNHw5Mzg5Mjg1NjI0MzZ8RHwxNzQ",7  "createdTime": "2023-07-06T16:27:28+09:00",8  "modifiedTime": "2023-07-06T16:27:28+09:00",9  "resourceLocation": 11551,10  "permissionType": "WRITE",11  "useRevision": true,12  "protected": false13}

HTTP 403

Access is denied: no permission.

HTTP 404

Shared folder or permission does not exist.