開発者向けサポート

/files/{path}

システムで使用するファイル管理を行います。

必要権限

  • system

提供メソッド

GET

サンプル
リクエスト
GET files/WEB%2dINF/upload/test%2ecsv.json
（ファイルの内容を取得する場合、{path}にディレクトリを指定することはできません。ファイルの一覧を取得する場合、{path}にはディレクトリを指定してください）
レスポンス
ファイルの内容
リクエスト文説明
クエリーパラメータ

list
trueを指定すると、ファイルの一覧を返します。pathの部分にディレクトリを指定する必要があります。
filter
list=trueの場合に指定可能です。一覧で返すファイルを絞るためのフィルタとなる正規表現を指定してください。正規表現にマッチするファイルの一覧を返します。
content_type
ファイルの内容を返す場合のContent-Typeを指定します。未指定の場合、application/octet-stream;charset=UTF-8を使用します。
isGetAll
指定したpath配下のファイル一覧を全て取得します。未指定の場合はパス直下の情報のみ取得します。使用する際はpathHierarchyと合わせて使用してください。
pathHierarchy
何階層まで取得するか選択できます。使用する際はisGetAllと合わせて使用してください。

応答値説明
ボディー文字列

list未指定の場合
指定されたファイルのバイナリデータを返します。
list=trueの場合
以下の項目を持つJSONオブジェクトのリストを返します。
  • name: ファイル名
  • isDirectory: ディレクトリの場合true、ファイルの場合false

POST

サンプル
リクエスト
POST files/WEB%2dINF/upload/test%2ecsv.json?operation=copy
（{path}にディレクトリを指定することはできません）
{"destination":"upload/backup/test_bk.csv"}
レスポンス
200 OK
リクエスト文説明
クエリーパラメータ

operation
create、create_binary、create_zip、copy、moveが指定できます。
createを指定した場合、ファイルの作成を行い、リクエストで受け取ったデータを書き込みます。同名ファイルが既に存在していた場合、エラーとなります。
create_binaryを指定した場合、ファイルの作成を行い、リクエストで受け取ったデータを書き込みます。書き込むデータはjsonではなくバイナリデータとして送信してください。同名ファイルが既に存在していた場合、エラーとなります。
create_zipを指定した場合、フォルダをZIPで圧縮し、圧縮対象のフォルダと同じディレクトリに配置します。同名のZIPファイルが既に存在していた場合、エラーとなります。
copyを指定した場合、ファイルのコピーを行います。
moveを指定した場合、ファイルの移動、ファイル名の変更を行います。
copyを指定した場合も、moveを指定した場合も親ディレクトリが存在していない場合、作成します。また、宛先のパスが既に存在している場合、エラーとなります（上書きはしません）。
charset
テキストデータを出力する際の文字コード。未指定の場合UTF-8を使用します。

ボディー文字列

リクエストパラメータ operation=createの場合:
ファイルに書き込むデータ（テキストデータのみサポート）。メガバイトに達するデータについては動作保証していません。
リクエストパラメータ operation=create_zipの場合:
  • zipFileName:圧縮後のZIPファイル名を指定します。
リクエストパラメータ operation=copyの場合:
  • destination:コピー先を指定します（ルートからのパス（ファイル名含む）を指定してください）。
リクエストパラメータ operation=moveの場合:
移動元と移動先のディレクトリが同じ場合、ファイル名の変更を行います。
  • destination:移動先を指定します（ルートからのパス（ファイル名含む）を指定してください）。

応答値説明

DELETE

サンプル
リクエスト
DELETE files/WEB%2dINF/upload/test%2ecsv.json
（{path}にディレクトリを指定することはできません）
レスポンス
200 OK
リクエスト文説明
応答値説明

ここを見た方は他にもこんなページを見ています。