文件系统

FsRestfulApi 类

接口地址:/api/rest_j/v1/filesystem/createNewDir

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

创建新的Dir

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path路径trueStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/createNewFile

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

创建新的文件

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path路径trueStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/deleteDirOrFile

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

删除dir文件或者文件

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址trueStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/download

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

下载

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
charset字符集trueStringString
path地址trueStringString
jsonjsonbodytrue

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/fileInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

文件信息

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址querytruestring
pageSize页面大小queryfalseref

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/formate

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

resultsets转换成Excel

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
encoding编码querytruestring
escapeQuotesescapeQuotesquerytruestring
fieldDelimiter字段分隔符querytruestring
hasHeader哈希值querytrueboolean
quote引用querytruestring
path地址queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/getDirFileTrees

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取udf函数列表

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path请求路径querytruestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "method": "/api/filesystem/getDirFileTrees",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "dirFileTrees": {
  7. "name": "",
  8. "path": "",
  9. "properties": null,
  10. "children": [{
  11. "name": "",
  12. "path": "",
  13. "properties": {
  14. "size": "",
  15. "modifytime": ""
  16. },
  17. "children": ,
  18. "isLeaf": ,
  19. "parentPath": ""
  20. }],
  21. "isLeaf": ,
  22. "parentPath":
  23. }
  24. }
  25. }

接口地址:/api/rest_j/v1/filesystem/getUserRootPath

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取根路径

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
pathType文件类型queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/isExist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

是否存在

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址querytruestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/openFile

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

打开文件

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址querytruestring
charset字符集queryfalsestring
page页码queryfalseref
pageSize页面大小queryfalseref

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "method": "/api/filesystem/openFile",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "metadata": [{
  7. "columnName": "_c0",
  8. "comment": "NULL",
  9. "dataType": ""
  10. }],
  11. "totalPage": ,
  12. "totalLine": ,
  13. "page": ,
  14. "type": "",
  15. "fileContent": [
  16. [""]
  17. ]
  18. }
  19. }

接口地址:/api/rest_j/v1/filesystem/openLog

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

打开日志记录

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址queryfalsestring
proxyUser代理用户queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "method": "/api/filesystem/openLog",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "log": ["", ""]
  7. }
  8. }

接口地址:/api/rest_j/v1/filesystem/rename

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

重新给文件命名

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
newDest新名称falseStringString
oldDest旧名称falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/resultsetToExcel

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

结果集转换成Excel

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
autoFormat是否自动queryfalseboolean
charset结果集queryfalsestring
csvSeperatorcsv分隔栏queryfalsestring
limit限度queryfalseref
nullValue空值queryfalsestring
outputFileName输出文件名称queryfalsestring
outputFileType输出文件类型queryfalsestring
path地址queryfalsestring
quoteRetouchEnable是否引用修饰queryfalseboolean
sheetNamesheet名称queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/resultsetsToExcel

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

resultsets转换成Excel

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
autoFormat是否自动querytrueboolean
limit限度querytrueref
nullValue空值querytruestring
outputFileName输出文件名称querytruestring
path地址queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/saveScript

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

保存脚本

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path地址trueStringString
SaveScriptjsonbodytrueSaveScriptSaveScript
charset字符集falseStringString
params页面大小falseObjectObject
scriptContent页码falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

接口地址:/api/rest_j/v1/filesystem/upload

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

上传文件,可传多个文件

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
file文件formDatafalseref
path地址queryfalsestring

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }