File Gate
ファイルを書き込むためのAPIです。ファイルのバイナリデータを受け取り、アセット情報をデータベースから検索し、該当するアセット(ファイルストレージ)に書き込みます。
ファイルストレージには、アセットのdbType
がfileGateもしくはundefinedの場合にのみ書き込むことができます。
Query Parameters |
---|
assetTags array — REQUIREDアセットのタグを指定して書き込み先のアセットを指定します。アセットは必ず一意に定まるよう指定してください。assetTags, assetId, assetNoのいずれかを必ず指定してください。 |
assetId stringアセットで発行される固有のIDです。assetTags, assetId, assetNoのいずれかを必ず指定してください。 |
assetNo stringアセットで発行される固有のIDです。assetIdと異なり、assetテーブル内でインクリメントされるIDとなります。assetTags, assetId, assetNoのいずれかを必ず指定してください。 |
path string — REQUIREDファイルストレージに保存するファイルのパスです。 |
upsert booleanupsert=trueかつデータベースに既にデータが存在する場合、該当するデータの上書きを行います。 |
Header Parameters |
---|
Authorization string — REQUIREDNewtZeroのアカウントで発行されるAPIキーです。 |
Request Body ファイルをバイナリ形式で送信し、ファイルストレージに指定されたパスで保存します。 |
---|
files binary |
Responses |
---|
200 ファイルの書き込みに成功しました。 |
400 ファイルが空の場合、もしくは既にアセットにJSON形式のデータがNoSQLデータベースに保存されている場合(Asset.dbType = streamGateの場合)に発生します。 |
401 APIキーを送信していない、もしくはユーザーアカウントに指定したアセットの書き込み権限がない場合に発生します。 |
404 指定したアセットが見つかりませんでした。 |
500 ファイルのパスが無効など、ファイルストレージ側でエラーが起きた場合に発生します。 |