POST/users/{userId}/drive/files

マイドライブのルートフォルダにファイルをアップロードするためのアップロード URL を生成する。
生成された URL にファイルをアップロードする。

API を利用したコンテンツのアップロード方法は ファイルアップロード / ダウンロード を確認してください。

Authorization

oauth2

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

Scope

file

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/drive/files

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
fileName string 

ファイル名


required
minLength : 1
maxLength : 200 
modifiedTime string 

ファイル更新日時


minLength : 1
format : date-time 
fileSize integer 

ファイルサイズ


required
maximum : 10737418240
format : int64 
overwrite boolean 

ファイル上書きの可否


default : false 
suffixOnDuplicate boolean 

ファイル名への番号の自動追加。
ファイルをアップロードするフォルダに、名前が重複するファイルやフォルダが存在した場合に、ファイル名の後ろに自動的に番号を付与する。


default : false 
resume boolean 

アップロードの再開。
ファイルのアップロードに失敗した場合に失敗箇所から再開するには、resumeに true を指定してファイルアップロード API を呼び出してアップロード URL を取得する。


default : false 

Request Example

example

1{2  "fileName": "works.txt",3  "modifiedTime": "2019-08-24T14:15:22Z",4  "fileSize": 100,5  "overwrite": false,6  "resume": false,7  "suffixOnDuplicate": false8}

example(resume)

1{2  "fileName": "works.txt",3  "modifiedTime": "2019-08-24T14:15:22Z",4  "fileSize": 100,5  "overwrite": false,6  "resume": true,7  "suffixOnDuplicate": false8}

Response

HTTP 200

OK

PropertyTypeDescription
uploadUrl string 

ファイルのアップロード先の URL


required 
offset integer 

オフセット値 resume:true を指定してファイルのアップロード API を呼び出し、アップロードを途中から再開するために使用する値。
ファイルのアップロードを再開しない場合には 0 が返される。 ファイルのアップロードを再開するには、ファイル アップロード URL を呼び出す際に、Content-Range ヘッダに offset 値を渡す。
例) fileSize が 1000 で、offset が 100 の場合
Content-Range=100-999/1000


format : int64 

Response Example

example

1{2  "uploadUrl": "https://apis-storage.worksmobile.com/k1/drive/r/24101/160521/160521/100001500064253/3472589353794602761?param=ewogICJwYXJlbnRLZXkiIDogInJvb3QiLAogICJmaWxlTmFtZSIgOiAi7ZWc6riALnR4dCIsCiAgImZpbGVTaXplIiA6IDMsCiAgIm1vZGlmaWVkVGltZSIgOiAiMjAxOS0wOC0yNFQxNDoxNToyMloiLAogICJhZGRvbktleSIgOiBudWxsCn0&writeMode=none&auth=OPEN",3  "offset": 04}

example(resume)

1{2  "uploadUrl": "https://apis-storage.worksmobile.com/k1/drive/r/24101/160521/160521/100001500064253/3472589353794602761?param=ewogICJwYXJlbnRLZXkiIDogInJvb3QiLAogICJmaWxlTmFtZSIgOiAi7ZWc6riALnR4dCIsCiAgImZpbGVTaXplIiA6IDMsCiAgIm1vZGlmaWVkVGltZSIgOiAiMjAxOS0wOC0yNFQxNDoxNToyMloiLAogICJhZGRvbktleSIgOiBudWxsCn0&writeMode=resume&rangeStartOffset=100&auth=OPEN",3  "offset": 1004}