Skip to content

网络硬盘PC端接口

VersionUpdate TimeStatusAuthorDescription
1.02022/5/20创建yihong创建后端接口文档

文件收藏接口

取消收藏文件或者文件夹

URL: https://demo.youshengyun.com/storage/vue/fileNodeCollect/cancelCollect

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 取消收藏文件或者文件夹

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeCollect/cancelCollect?fileId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

收藏文件或者文件夹

URL: https://demo.youshengyun.com/storage/vue/fileNodeCollect/setCollect

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 收藏文件或者文件夹

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeCollect/setCollect?fileId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

取消文件夹密码

URL: https://demo.youshengyun.com/storage/vue/fileNode/cancelFolderPassword

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 取消文件夹密码

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/cancelFolderPassword?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&userId=&fileStoreId=&userName=&orgId=&name=&fileSuffix=&filePassword=&parentId=&linkPassword=&id=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

验证文件夹密码

URL: https://demo.youshengyun.com/storage/vue/fileNode/checkFolderPassword

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 验证文件夹密码

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/checkFolderPassword?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&listType=&name=&linkPassword=&id=&filePassword=&userName=&orgId=&fileStoreId=&fileSuffix=&userId=&parentId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

文件夹解密

URL: https://demo.youshengyun.com/storage/vue/fileNode/decryptPassword

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 文件夹解密

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/decryptPassword?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&orgId=&linkPassword=&listType=&fileStoreId=&userName=&id=&filePassword=&parentId=&name=&fileSuffix=&userId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
datastring操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

下载单个或者多个文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/downloadFile

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 下载单个或者多个文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
positionIdstringfalseNo comments found.-
idsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/downloadFile?positionId=&ids=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

清空回收站

URL: https://demo.youshengyun.com/storage/vue/fileNode/emptyRecycleBin

Type: DELETE

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 清空回收站

Request-example:

bash
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNode/emptyRecycleBin

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取收藏列表

URL: https://demo.youshengyun.com/storage/vue/fileNode/getCollectList

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取收藏列表

Request-headers:

HeaderTypeRequiredDescriptionSince
positionIdstringtrueNo comments found.-

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
searchNamestringfalseNo comments found.-
listTypestringfalseNo comments found.-
orderPropenumfalseNo comments found.
[Enum values:
FILE_NAME()
FILE_SIZE()
UPDATE_TIME()
CREATE_TIME()
]
-
orderAscbooleanfalseNo comments found.-

Request-example:

bash
curl -X GET -k -H 'positionId' -i https://demo.youshengyun.com/storage/vue/fileNode/getCollectList?orderProp=FILE_NAME&orderAsc=true&id=&searchName=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─subFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-
└─recursiveToRootFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "subFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ],
    "recursiveToRootFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ]
  }
}

获取公共文件下载记录

URL: https://demo.youshengyun.com/storage/vue/fileNode/getDownloadRecord

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取公共文件下载记录

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileIdstringfalseNo comments found.-
pageint32falseNo comments found.-
rowsint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getDownloadRecord?page=0&rows=0&fileId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─mapKeyobjectA map key.-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "mapKey": {
          "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取txt文件的内容

URL: https://demo.youshengyun.com/storage/vue/fileNode/getFileText

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取txt文件的内容

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileStoreIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getFileText?fileStoreId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取我的回收站的文件列表

URL: https://demo.youshengyun.com/storage/vue/fileNode/deletedList

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取我的回收站的文件列表

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/deletedList

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-
└─parentIdstringNo comments found.-
└─orgIdstringNo comments found.-
└─namestringNo comments found.-
└─listTypestringNo comments found.-
└─fileTypeint32No comments found.-
└─fileSizestringNo comments found.-
└─previewUrlstringNo comments found.-
└─fileUrlstringNo comments found.-
└─fileStoreIdstringNo comments found.-
└─fileSuffixstringNo comments found.-
└─encryptionbooleanNo comments found.-
└─filePasswordstringNo comments found.-
└─linkPasswordstringNo comments found.-
└─tabIndexint32No comments found.-
└─userIdstringNo comments found.-
└─userNamestringNo comments found.-
└─collectbooleanNo comments found.-
└─ownerbooleanNo comments found.-
└─collectRoutestringNo comments found.-
└─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "parentId": "",
      "orgId": "",
      "name": "",
      "listType": "",
      "fileType": 0,
      "fileSize": "",
      "previewUrl": "",
      "fileUrl": "",
      "fileStoreId": "",
      "fileSuffix": "",
      "encryption": true,
      "filePassword": "",
      "linkPassword": "",
      "tabIndex": 0,
      "userId": "",
      "userName": "",
      "collect": true,
      "owner": true,
      "collectRoute": "",
      "parentFileNode": {
        "$ref": "..."
      }
    }
  ]
}

获取当前节点的父节点

URL: https://demo.youshengyun.com/storage/vue/fileNode/getNetParentId

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前节点的父节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getNetParentId?id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-
└─namestringNo comments found.-
└─listTypestringNo comments found.-
└─fileTypeint32No comments found.-
└─fileSuffixstringNo comments found.-
└─fileStoreIdstringNo comments found.-
└─fileSizeint64No comments found.-
└─orgIdstringNo comments found.-
└─userIdstringNo comments found.-
└─userNamestringNo comments found.-
└─parentIdstringNo comments found.-
└─deletedbooleanNo comments found.-
└─collectbooleanNo comments found.-
└─encryptionbooleanNo comments found.-
└─linkPasswordstringNo comments found.-
└─filePasswordstringNo comments found.-
└─tabIndexint32No comments found.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "updateTime": "yyyy-MM-dd HH:mm:ss",
    "name": "",
    "listType": "",
    "fileType": 0,
    "fileSuffix": "",
    "fileStoreId": "",
    "fileSize": 0,
    "orgId": "",
    "userId": "",
    "userName": "",
    "parentId": "",
    "deleted": true,
    "collect": true,
    "encryption": true,
    "linkPassword": "",
    "filePassword": "",
    "tabIndex": 0
  }
}

根据文件类型和列表类型获取文件列表

URL: https://demo.youshengyun.com/storage/vue/fileNode/list

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据文件类型和列表类型获取文件列表

Request-headers:

HeaderTypeRequiredDescriptionSince
positionIdstringtrueNo comments found.-

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
fileNodeTypeenumfalseFOLDER(0)
PICTURE(1)
DOCUMENT(2)
VIDEO(3)
AUDIO(4)
PAKEAGE(5)
OTHERS(6)
-
searchNamestringfalseNo comments found.-
listTypestringfalseNo comments found.-
orderPropenumfalseNo comments found.
[Enum values:
FILE_NAME()
FILE_SIZE()
UPDATE_TIME()
CREATE_TIME()
]
-
orderAscbooleanfalseNo comments found.-

Request-example:

bash
curl -X GET -k -H 'positionId' -i https://demo.youshengyun.com/storage/vue/fileNode/list?fileNodeType=FOLDER&orderProp=FILE_NAME&orderAsc=true&id=&searchName=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─subFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-
└─recursiveToRootFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "subFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ],
    "recursiveToRootFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ]
  }
}

加载所有文件夹

URL: https://demo.youshengyun.com/storage/vue/fileNode/listFolder

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加载所有文件夹

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/listFolder?id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-
└─parentIdstringNo comments found.-
└─orgIdstringNo comments found.-
└─namestringNo comments found.-
└─listTypestringNo comments found.-
└─fileTypeint32No comments found.-
└─fileSizestringNo comments found.-
└─previewUrlstringNo comments found.-
└─fileUrlstringNo comments found.-
└─fileStoreIdstringNo comments found.-
└─fileSuffixstringNo comments found.-
└─encryptionbooleanNo comments found.-
└─filePasswordstringNo comments found.-
└─linkPasswordstringNo comments found.-
└─tabIndexint32No comments found.-
└─userIdstringNo comments found.-
└─userNamestringNo comments found.-
└─collectbooleanNo comments found.-
└─ownerbooleanNo comments found.-
└─collectRoutestringNo comments found.-
└─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "parentId": "",
      "orgId": "",
      "name": "",
      "listType": "",
      "fileType": 0,
      "fileSize": "",
      "previewUrl": "",
      "fileUrl": "",
      "fileStoreId": "",
      "fileSuffix": "",
      "encryption": true,
      "filePassword": "",
      "linkPassword": "",
      "tabIndex": 0,
      "userId": "",
      "userName": "",
      "collect": true,
      "owner": true,
      "collectRoute": "",
      "parentFileNode": {
        "$ref": "..."
      }
    }
  ]
}

加载公共文件下所有文件夹

URL: https://demo.youshengyun.com/storage/vue/fileNode/listPublicFolder

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加载公共文件下所有文件夹

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/listPublicFolder?id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-
└─parentIdstringNo comments found.-
└─orgIdstringNo comments found.-
└─namestringNo comments found.-
└─listTypestringNo comments found.-
└─fileTypeint32No comments found.-
└─fileSizestringNo comments found.-
└─previewUrlstringNo comments found.-
└─fileUrlstringNo comments found.-
└─fileStoreIdstringNo comments found.-
└─fileSuffixstringNo comments found.-
└─encryptionbooleanNo comments found.-
└─filePasswordstringNo comments found.-
└─linkPasswordstringNo comments found.-
└─tabIndexint32No comments found.-
└─userIdstringNo comments found.-
└─userNamestringNo comments found.-
└─collectbooleanNo comments found.-
└─ownerbooleanNo comments found.-
└─collectRoutestringNo comments found.-
└─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "parentId": "",
      "orgId": "",
      "name": "",
      "listType": "",
      "fileType": 0,
      "fileSize": "",
      "previewUrl": "",
      "fileUrl": "",
      "fileStoreId": "",
      "fileSuffix": "",
      "encryption": true,
      "filePassword": "",
      "linkPassword": "",
      "tabIndex": 0,
      "userId": "",
      "userName": "",
      "collect": true,
      "owner": true,
      "collectRoute": "",
      "parentFileNode": {
        "$ref": "..."
      }
    }
  ]
}

删除文件(标记删除)

URL: https://demo.youshengyun.com/storage/vue/fileNode

Type: DELETE

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除文件(标记删除)

Query-parameters:

ParameterTypeRequiredDescriptionSince
idsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNode?ids=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

加载所有公共管理文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/manageList

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加载所有公共管理文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
fileNodeTypeenumfalseFOLDER(0)
PICTURE(1)
DOCUMENT(2)
VIDEO(3)
AUDIO(4)
PAKEAGE(5)
OTHERS(6)
-
searchNamestringfalseNo comments found.-
startTimestringfalseNo comments found.-
endTimestringfalseNo comments found.-
listTypestringfalseNo comments found.-
orderPropenumfalseNo comments found.
[Enum values:
FILE_NAME()
FILE_SIZE()
UPDATE_TIME()
CREATE_TIME()
]
-
orderAscbooleanfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/manageList?fileNodeType=FOLDER&orderProp=FILE_NAME&orderAsc=true&id=&searchName=&startTime=&endTime=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─subFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-
└─recursiveToRootFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "subFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ],
    "recursiveToRootFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ]
  }
}

移动文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/move

Type: POST

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 移动文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
idsarraytrueNo comments found.,[array of string]-
targetIdstringfalseNo comments found.-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNode/move

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

打开文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/openFile

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 打开文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileStoreIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/openFile?fileStoreId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

彻底删除文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/permanently

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 彻底删除文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
idsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/permanently?ids=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

加载所有公共文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/publicList

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加载所有公共文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
fileNodeTypeenumfalseFOLDER(0)
PICTURE(1)
DOCUMENT(2)
VIDEO(3)
AUDIO(4)
PAKEAGE(5)
OTHERS(6)
-
searchNamestringfalseNo comments found.-
startTimestringfalseNo comments found.-
endTimestringfalseNo comments found.-
listTypestringfalseNo comments found.-
orderPropenumfalseNo comments found.
[Enum values:
FILE_NAME()
FILE_SIZE()
UPDATE_TIME()
CREATE_TIME()
]
-
orderAscbooleanfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/publicList?fileNodeType=FOLDER&orderProp=FILE_NAME&orderAsc=true&id=&searchName=&startTime=&endTime=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─subFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-
└─recursiveToRootFileNodeListarrayNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "subFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ],
    "recursiveToRootFileNodeList": [
      {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      }
    ]
  }
}

保存重置的密码

URL: https://demo.youshengyun.com/storage/vue/fileNode/resetFolderPassword

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存重置的密码

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/resetFolderPassword?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&name=&linkPassword=&filePassword=&id=&fileSuffix=&listType=&orgId=&userId=&userName=&parentId=&fileStoreId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

还原文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/restore

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 还原文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
idsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/restore?ids=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存文件夹信息

URL: https://demo.youshengyun.com/storage/vue/fileNode/saveFolder

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存文件夹信息

Request-headers:

HeaderTypeRequiredDescriptionSince
positionIdstringtrueNo comments found.-

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -H 'positionId' -i https://demo.youshengyun.com/storage/vue/fileNode/saveFolder?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&linkPassword=&fileSuffix=&fileStoreId=&parentId=&orgId=&userId=&filePassword=&id=&listType=&userName=&name=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

上传文件

URL: https://demo.youshengyun.com/storage/vue/fileNode/uploadFile

Type: GET

Content-Type: multipart/form-data

Description: 上传文件

Request-headers:

HeaderTypeRequiredDescriptionSince
positionIdstringtrueNo comments found.-

Query-parameters:

ParameterTypeRequiredDescriptionSince
filefilefalseNo comments found.-
parentIdstringfalseNo comments found.-
listTypestringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -H 'Content-Type: multipart/form-data' -H 'positionId' -i https://demo.youshengyun.com/storage/vue/fileNode/uploadFile?parentId=&listType=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

保存设置的文件夹密码

URL: https://demo.youshengyun.com/storage/vue/fileNode/setFolderPassword

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存设置的文件夹密码

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-
namestringfalseNo comments found.-
listTypestringfalseNo comments found.-
fileTypeint32falseNo comments found.-
fileSuffixstringfalseNo comments found.-
fileStoreIdstringfalseNo comments found.-
fileSizeint64falseNo comments found.-
orgIdstringfalseNo comments found.-
userIdstringfalseNo comments found.-
userNamestringfalseNo comments found.-
parentIdstringfalseNo comments found.-
deletedbooleanfalseNo comments found.-
collectbooleanfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
linkPasswordstringfalseNo comments found.-
filePasswordstringfalseNo comments found.-
tabIndexint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/setFolderPassword?createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&fileType=0&fileSize=0&deleted=true&collect=true&encryption=true&tabIndex=0&userName=&userId=&fileStoreId=&filePassword=&linkPassword=&parentId=&fileSuffix=&orgId=&listType=&name=&id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

设置直链文件密码

URL: https://demo.youshengyun.com/storage/vue/fileNode/setLinkPwd

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置直链文件密码

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
encryptionbooleanfalseNo comments found.-
filePasswordstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/setLinkPwd?encryption=true&filePassword=&id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取默认顶节点

URL: https://demo.youshengyun.com/storage/vue/fileNode/topFolder

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取默认顶节点

Query-parameters:

ParameterTypeRequiredDescriptionSince
parentIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/topFolder?parentId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-
└─parentIdstringNo comments found.-
└─orgIdstringNo comments found.-
└─namestringNo comments found.-
└─listTypestringNo comments found.-
└─fileTypeint32No comments found.-
└─fileSizestringNo comments found.-
└─previewUrlstringNo comments found.-
└─fileUrlstringNo comments found.-
└─fileStoreIdstringNo comments found.-
└─fileSuffixstringNo comments found.-
└─encryptionbooleanNo comments found.-
└─filePasswordstringNo comments found.-
└─linkPasswordstringNo comments found.-
└─tabIndexint32No comments found.-
└─userIdstringNo comments found.-
└─userNamestringNo comments found.-
└─collectbooleanNo comments found.-
└─ownerbooleanNo comments found.-
└─collectRoutestringNo comments found.-
└─parentFileNodeobjectNo comments found. $ref... self-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "parentId": "",
      "orgId": "",
      "name": "",
      "listType": "",
      "fileType": 0,
      "fileSize": "",
      "previewUrl": "",
      "fileUrl": "",
      "fileStoreId": "",
      "fileSuffix": "",
      "encryption": true,
      "filePassword": "",
      "linkPassword": "",
      "tabIndex": 0,
      "userId": "",
      "userName": "",
      "collect": true,
      "owner": true,
      "collectRoute": "",
      "parentFileNode": {
        "$ref": "..."
      }
    }
  ]
}

文件共享接口

取消分享

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare

Type: DELETE

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 取消分享

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileNodeIdsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare?fileNodeIds=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除公开人员

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare/deletePublic

Type: DELETE

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除公开人员

Query-parameters:

ParameterTypeRequiredDescriptionSince
publicIdsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/deletePublic?publicIds=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取文件公开记录列表

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare/getFilePublicRecord

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取文件公开记录列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileIdstringfalseNo comments found.-
pageint32falseNo comments found.-
rowsint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/getFilePublicRecord?page=0&rows=0&fileId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─mapKeyobjectA map key.-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "mapKey": {
          "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取我的分享列表

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare/myList

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取我的分享列表

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/myList

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─fileNodeobjectNo comments found.-
     └─idstringNo comments found.-
     └─createTimestringNo comments found.-
     └─updateTimestringNo comments found.-
     └─parentIdstringNo comments found.-
     └─orgIdstringNo comments found.-
     └─namestringNo comments found.-
     └─listTypestringNo comments found.-
     └─fileTypeint32No comments found.-
     └─fileSizestringNo comments found.-
     └─previewUrlstringNo comments found.-
     └─fileUrlstringNo comments found.-
     └─fileStoreIdstringNo comments found.-
     └─fileSuffixstringNo comments found.-
     └─encryptionbooleanNo comments found.-
     └─filePasswordstringNo comments found.-
     └─linkPasswordstringNo comments found.-
     └─tabIndexint32No comments found.-
     └─userIdstringNo comments found.-
     └─userNamestringNo comments found.-
     └─collectbooleanNo comments found.-
     └─ownerbooleanNo comments found.-
     └─collectRoutestringNo comments found.-
     └─parentFileNodeobjectNo comments found. $ref... self-
└─toOrgUnitNamesstringNo comments found.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "fileNode": {
        "id": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "parentId": "",
        "orgId": "",
        "name": "",
        "listType": "",
        "fileType": 0,
        "fileSize": "",
        "previewUrl": "",
        "fileUrl": "",
        "fileStoreId": "",
        "fileSuffix": "",
        "encryption": true,
        "filePassword": "",
        "linkPassword": "",
        "tabIndex": 0,
        "userId": "",
        "userName": "",
        "collect": true,
        "owner": true,
        "collectRoute": "",
        "parentFileNode": {
          "$ref": "..."
        }
      },
      "toOrgUnitNames": ""
    }
  ]
}

公开文件

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare/publicTo

Type: POST

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 公开文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileNodeIdsarraytrueNo comments found.,[array of string]-
orgUnitIdsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/publicTo

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

分享文件

URL: https://demo.youshengyun.com/storage/vue/fileNodeShare/share

Type: POST

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 分享文件

Query-parameters:

ParameterTypeRequiredDescriptionSince
fileNodeIdsarraytrueNo comments found.,[array of string]-
orgUnitIdsarraytrueNo comments found.,[array of string]-

Request-example:

bash
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/share

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

文件直链接口

文件直链下载

URL: https://demo.youshengyun.com/storage/link/df/{id}/{tenantId}

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 文件直链下载

Path-parameters:

ParameterTypeRequiredDescriptionSince
idstringtrueNo comments found.-
tenantIdstringtrueNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/link/df/{id}/{tenantId}

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

文件直链密码验证

URL: https://demo.youshengyun.com/storage/link/checkPwd

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 文件直链密码验证

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
pwdstringfalseNo comments found.-
tenantIdstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/link/checkPwd?pwd=&tenantId=&id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

文件空间管理接口

文件直链接口

文件列表及文件操作接口

文件共享处理接口

组织架构、权限接口

验证当前人的管理权限

URL: https://demo.youshengyun.com/storage/vue/org/checkManager

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 验证当前人的管理权限

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/checkManager

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

获取当前租户的组织架构

URL: https://demo.youshengyun.com/storage/vue/org/getOrganization

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前租户的组织架构

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getOrganization

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring唯一标识-
└─parentIdstring父节点ID-
└─tenantIdstring租户Id-
└─createTimestring创建时间-
└─updateTimestring更新时间-
└─disabledboolean是否禁用-
└─descriptionstring描述-
└─customIdstring自定义ID-
└─dnstring域名称-
└─namestring名称-
└─orgTypeenum节点类型
[Enum values:
ORGANIZATION("Organization", "组织机构")
DEPARTMENT("Department", "部门")
GROUP("Group", "用户组")
POSITION("Position", "岗位")
PERSON("Person", "人员")
MANAGER("Manager", "三员管理员")
]
-
└─propertiesstring扩展属性(json格式)-
└─tabIndexint32序号-
└─guidPathstring由ID组成的父子关系列表,之间用逗号分隔-
└─enNamestring英文名称-
└─organizationCodestring机构代码-
└─organizationTypestring组织机构类型-
└─virtualboolean机构类型,0=实体组织,1=虚拟组织-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "tenantId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "disabled": true,
      "description": "",
      "customId": "",
      "dn": "",
      "name": "",
      "orgType": "ORGANIZATION",
      "properties": "",
      "tabIndex": 0,
      "guidPath": "",
      "enName": "",
      "organizationCode": "",
      "organizationType": "",
      "virtual": true
    }
  ]
}

根据id或name获取组织架构树

URL: https://demo.youshengyun.com/storage/vue/org/getTree

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id或name获取组织架构树

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
namestringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getTree?id=&name=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataarray操作成功返回的数据-
└─idstring唯一标识-
└─parentIdstring父节点ID-
└─tenantIdstring租户Id-
└─createTimestring创建时间-
└─updateTimestring更新时间-
└─disabledboolean是否禁用-
└─descriptionstring描述-
└─customIdstring自定义ID-
└─dnstring域名称-
└─namestring名称-
└─orgTypeenum节点类型
[Enum values:
ORGANIZATION("Organization", "组织机构")
DEPARTMENT("Department", "部门")
GROUP("Group", "用户组")
POSITION("Position", "岗位")
PERSON("Person", "人员")
MANAGER("Manager", "三员管理员")
]
-
└─propertiesstring扩展属性(json格式)-
└─tabIndexint32序号-
└─guidPathstring由ID组成的父子关系列表,之间用逗号分隔-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "tenantId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "disabled": true,
      "description": "",
      "customId": "",
      "dn": "",
      "name": "",
      "orgType": "ORGANIZATION",
      "properties": "",
      "tabIndex": 0,
      "guidPath": ""
    }
  ]
}

获取个人所有岗位

URL: https://demo.youshengyun.com/storage/vue/org/getPositionList

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取个人所有岗位

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getPositionList

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

文件存储空间接口

获取存储信息

URL: https://demo.youshengyun.com/storage/vue/capacity/getCapacityInfo

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取存储信息

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacityInfo?id=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─idstringNo comments found.-
└─capacitySizeint64No comments found.-
└─remainingLengthint64No comments found.-
└─capacityOwnerIdstringNo comments found.-
└─capacityOwnerNamestringNo comments found.-
└─operatorIdstringNo comments found.-
└─operatorNamestringNo comments found.-
└─createTimestringNo comments found.-
└─updateTimestringNo comments found.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "capacitySize": 0,
    "remainingLength": 0,
    "capacityOwnerId": "",
    "capacityOwnerName": "",
    "operatorId": "",
    "operatorName": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "updateTime": "yyyy-MM-dd HH:mm:ss"
  }
}

获取存储空间列表

URL: https://demo.youshengyun.com/storage/vue/capacity/getCapacityList

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取存储空间列表

Query-parameters:

ParameterTypeRequiredDescriptionSince
userNamestringfalseNo comments found.-
pageint32falseNo comments found.-
rowsint32falseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacityList?page=0&rows=0&userName=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─currPageint32当前页-
└─totalPagesint32总页数-
└─totalint64总条数-
└─rowsarray数据项-
     └─mapKeyobjectA map key.-
          └─any objectobjectany object.-
└─codeint64错误代码-
└─msgstring调用信息-
└─successboolean操作是否成功-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "mapKey": {
          "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取存储长度

URL: https://demo.youshengyun.com/storage/vue/capacity/getCapacitySize

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取存储长度

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacitySize

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─mapKeyobjectA map key.-
     └─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

更新存储空间值

URL: https://demo.youshengyun.com/storage/vue/capacity/updateCapacity

Type: GET

Author: yihong

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新存储空间值

Query-parameters:

ParameterTypeRequiredDescriptionSince
idstringfalseNo comments found.-
capacitySizeint64falseNo comments found.-
remainingLengthint64falseNo comments found.-
capacityOwnerIdstringfalseNo comments found.-
capacityOwnerNamestringfalseNo comments found.-
operatorIdstringfalseNo comments found.-
operatorNamestringfalseNo comments found.-
createTimestringfalseNo comments found.-
updateTimestringfalseNo comments found.-

Request-example:

bash
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/updateCapacity?capacitySize=0&remainingLength=0&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&capacityOwnerId=&operatorName=&id=&capacityOwnerName=&operatorId=

Response-fields:

FieldTypeDescriptionSince
successboolean操作是否成功-
codeint32错误代码-
msgstring操作描述-
dataobject操作成功返回的数据-
└─any objectobjectany object.-

Response-example:

json
{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

增删数据库字段 数据做同步修改

错误码列表

Error codeDescription
0操作成功
1服务器内部错误,请联系开发人员
2参数校验失败
3对象[{}]不存在
100令牌未传入
101令牌已失效
102校验令牌出问题了
200权限不足拒绝访问
211当前用户不是全局系统管理员
212当前用户不是全局安全保密员
213当前用户不是全局安全审计员
214当前用户不是部门系统管理员
215当前用户不是部门安全保密员
216当前用户不是部门安全审计员
220当前用户没有拥有角色[{}]
221当前岗位没有拥有角色[{}]
222当前用户不是[{}]
230当前用户没有被授权资源[{}]
231当前岗位没有被授权资源[{}]

数据字典

http状态码字典

CodeTypeDescription
200stringok
400stringBad Request
401stringUnauthorized
403stringForbidden
404stringNot Found
415stringUnsupported Media Type
500stringInternal Server Error
502stringBad Gateway
503stringService Unavailable

Released under the GPL-3.0 License.