网络硬盘PC端接口
| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
| 1.0 | 2022/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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeCollect/cancelCollect?fileId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | string | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeCollect/setCollect?fileId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | string | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | string | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | string | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | string | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| positionId | string | false | No comments found. | - |
| ids | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/downloadFile?positionId=&ids=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
Response-example:
{
"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:
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNode/emptyRecycleBinResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Header | Type | Required | Description | Since |
|---|---|---|---|---|
| positionId | string | true | No comments found. | - |
Query-parameters:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| searchName | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| orderProp | enum | false | No comments found. [Enum values: FILE_NAME() FILE_SIZE() UPDATE_TIME() CREATE_TIME() ] | - |
| orderAsc | boolean | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─subFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
| └─recursiveToRootFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileId | string | false | No comments found. | - |
| page | int32 | false | No comments found. | - |
| rows | int32 | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getDownloadRecord?page=0&rows=0&fileId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─currPage | int32 | 当前页 | - |
| └─totalPages | int32 | 总页数 | - |
| └─total | int64 | 总条数 | - |
| └─rows | array | 数据项 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
| └─code | int64 | 错误代码 | - |
| └─msg | string | 调用信息 | - |
| └─success | boolean | 操作是否成功 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileStoreId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getFileText?fileStoreId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/deletedListResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/getNetParentId?id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSize | int64 | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─deleted | boolean | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
Response-example:
{
"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:
| Header | Type | Required | Description | Since |
|---|---|---|---|---|
| positionId | string | true | No comments found. | - |
Query-parameters:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| fileNodeType | enum | false | FOLDER(0) PICTURE(1) DOCUMENT(2) VIDEO(3) AUDIO(4) PAKEAGE(5) OTHERS(6) | - |
| searchName | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| orderProp | enum | false | No comments found. [Enum values: FILE_NAME() FILE_SIZE() UPDATE_TIME() CREATE_TIME() ] | - |
| orderAsc | boolean | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─subFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
| └─recursiveToRootFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/listFolder?id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/listPublicFolder?id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| ids | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNode?ids=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| fileNodeType | enum | false | FOLDER(0) PICTURE(1) DOCUMENT(2) VIDEO(3) AUDIO(4) PAKEAGE(5) OTHERS(6) | - |
| searchName | string | false | No comments found. | - |
| startTime | string | false | No comments found. | - |
| endTime | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| orderProp | enum | false | No comments found. [Enum values: FILE_NAME() FILE_SIZE() UPDATE_TIME() CREATE_TIME() ] | - |
| orderAsc | boolean | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─subFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
| └─recursiveToRootFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| ids | array | true | No comments found.,[array of string] | - |
| targetId | string | false | No comments found. | - |
Request-example:
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNode/moveResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileStoreId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/openFile?fileStoreId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| ids | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/permanently?ids=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| fileNodeType | enum | false | FOLDER(0) PICTURE(1) DOCUMENT(2) VIDEO(3) AUDIO(4) PAKEAGE(5) OTHERS(6) | - |
| searchName | string | false | No comments found. | - |
| startTime | string | false | No comments found. | - |
| endTime | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| orderProp | enum | false | No comments found. [Enum values: FILE_NAME() FILE_SIZE() UPDATE_TIME() CREATE_TIME() ] | - |
| orderAsc | boolean | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─subFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
| └─recursiveToRootFileNodeList | array | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| ids | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/restore?ids=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Header | Type | Required | Description | Since |
|---|---|---|---|---|
| positionId | string | true | No comments found. | - |
Query-parameters:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Header | Type | Required | Description | Since |
|---|---|---|---|---|
| positionId | string | true | No comments found. | - |
Query-parameters:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| file | file | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
| listType | string | false | No comments found. | - |
| fileType | int32 | false | No comments found. | - |
| fileSuffix | string | false | No comments found. | - |
| fileStoreId | string | false | No comments found. | - |
| fileSize | int64 | false | No comments found. | - |
| orgId | string | false | No comments found. | - |
| userId | string | false | No comments found. | - |
| userName | string | false | No comments found. | - |
| parentId | string | false | No comments found. | - |
| deleted | boolean | false | No comments found. | - |
| collect | boolean | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| linkPassword | string | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
| tabIndex | int32 | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| encryption | boolean | false | No comments found. | - |
| filePassword | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/setLinkPwd?encryption=true&filePassword=&id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| parentId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNode/topFolder?parentId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileNodeIds | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare?fileNodeIds=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| publicIds | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X DELETE -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/deletePublic?publicIds=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileId | string | false | No comments found. | - |
| page | int32 | false | No comments found. | - |
| rows | int32 | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/getFilePublicRecord?page=0&rows=0&fileId=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─currPage | int32 | 当前页 | - |
| └─totalPages | int32 | 总页数 | - |
| └─total | int64 | 总条数 | - |
| └─rows | array | 数据项 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
| └─code | int64 | 错误代码 | - |
| └─msg | string | 调用信息 | - |
| └─success | boolean | 操作是否成功 | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/myListResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─fileNode | object | No comments found. | - |
| └─id | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
| └─parentId | string | No comments found. | - |
| └─orgId | string | No comments found. | - |
| └─name | string | No comments found. | - |
| └─listType | string | No comments found. | - |
| └─fileType | int32 | No comments found. | - |
| └─fileSize | string | No comments found. | - |
| └─previewUrl | string | No comments found. | - |
| └─fileUrl | string | No comments found. | - |
| └─fileStoreId | string | No comments found. | - |
| └─fileSuffix | string | No comments found. | - |
| └─encryption | boolean | No comments found. | - |
| └─filePassword | string | No comments found. | - |
| └─linkPassword | string | No comments found. | - |
| └─tabIndex | int32 | No comments found. | - |
| └─userId | string | No comments found. | - |
| └─userName | string | No comments found. | - |
| └─collect | boolean | No comments found. | - |
| └─owner | boolean | No comments found. | - |
| └─collectRoute | string | No comments found. | - |
| └─parentFileNode | object | No comments found. $ref... self | - |
| └─toOrgUnitNames | string | No comments found. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileNodeIds | array | true | No comments found.,[array of string] | - |
| orgUnitIds | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/publicToResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| fileNodeIds | array | true | No comments found.,[array of string] | - |
| orgUnitIds | array | true | No comments found.,[array of string] | - |
Request-example:
curl -X POST -k -i https://demo.youshengyun.com/storage/vue/fileNodeShare/shareResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | true | No comments found. | - |
| tenantId | string | true | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/link/df/{id}/{tenantId}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| pwd | string | false | No comments found. | - |
| tenantId | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/link/checkPwd?pwd=&tenantId=&id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/checkManagerResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getOrganizationResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | 唯一标识 | - |
| └─parentId | string | 父节点ID | - |
| └─tenantId | string | 租户Id | - |
| └─createTime | string | 创建时间 | - |
| └─updateTime | string | 更新时间 | - |
| └─disabled | boolean | 是否禁用 | - |
| └─description | string | 描述 | - |
| └─customId | string | 自定义ID | - |
| └─dn | string | 域名称 | - |
| └─name | string | 名称 | - |
| └─orgType | enum | 节点类型 [Enum values: ORGANIZATION("Organization", "组织机构") DEPARTMENT("Department", "部门") GROUP("Group", "用户组") POSITION("Position", "岗位") PERSON("Person", "人员") MANAGER("Manager", "三员管理员") ] | - |
| └─properties | string | 扩展属性(json格式) | - |
| └─tabIndex | int32 | 序号 | - |
| └─guidPath | string | 由ID组成的父子关系列表,之间用逗号分隔 | - |
| └─enName | string | 英文名称 | - |
| └─organizationCode | string | 机构代码 | - |
| └─organizationType | string | 组织机构类型 | - |
| └─virtual | boolean | 机构类型,0=实体组织,1=虚拟组织 | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| name | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getTree?id=&name=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | array | 操作成功返回的数据 | - |
| └─id | string | 唯一标识 | - |
| └─parentId | string | 父节点ID | - |
| └─tenantId | string | 租户Id | - |
| └─createTime | string | 创建时间 | - |
| └─updateTime | string | 更新时间 | - |
| └─disabled | boolean | 是否禁用 | - |
| └─description | string | 描述 | - |
| └─customId | string | 自定义ID | - |
| └─dn | string | 域名称 | - |
| └─name | string | 名称 | - |
| └─orgType | enum | 节点类型 [Enum values: ORGANIZATION("Organization", "组织机构") DEPARTMENT("Department", "部门") GROUP("Group", "用户组") POSITION("Position", "岗位") PERSON("Person", "人员") MANAGER("Manager", "三员管理员") ] | - |
| └─properties | string | 扩展属性(json格式) | - |
| └─tabIndex | int32 | 序号 | - |
| └─guidPath | string | 由ID组成的父子关系列表,之间用逗号分隔 | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/org/getPositionListResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacityInfo?id=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─id | string | No comments found. | - |
| └─capacitySize | int64 | No comments found. | - |
| └─remainingLength | int64 | No comments found. | - |
| └─capacityOwnerId | string | No comments found. | - |
| └─capacityOwnerName | string | No comments found. | - |
| └─operatorId | string | No comments found. | - |
| └─operatorName | string | No comments found. | - |
| └─createTime | string | No comments found. | - |
| └─updateTime | string | No comments found. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| userName | string | false | No comments found. | - |
| page | int32 | false | No comments found. | - |
| rows | int32 | false | No comments found. | - |
Request-example:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacityList?page=0&rows=0&userName=Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─currPage | int32 | 当前页 | - |
| └─totalPages | int32 | 总页数 | - |
| └─total | int64 | 总条数 | - |
| └─rows | array | 数据项 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
| └─code | int64 | 错误代码 | - |
| └─msg | string | 调用信息 | - |
| └─success | boolean | 操作是否成功 | - |
Response-example:
{
"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:
curl -X GET -k -i https://demo.youshengyun.com/storage/vue/capacity/getCapacitySizeResponse-fields:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─mapKey | object | A map key. | - |
| └─any object | object | any object. | - |
Response-example:
{
"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:
| Parameter | Type | Required | Description | Since |
|---|---|---|---|---|
| id | string | false | No comments found. | - |
| capacitySize | int64 | false | No comments found. | - |
| remainingLength | int64 | false | No comments found. | - |
| capacityOwnerId | string | false | No comments found. | - |
| capacityOwnerName | string | false | No comments found. | - |
| operatorId | string | false | No comments found. | - |
| operatorName | string | false | No comments found. | - |
| createTime | string | false | No comments found. | - |
| updateTime | string | false | No comments found. | - |
Request-example:
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:
| Field | Type | Description | Since |
|---|---|---|---|
| success | boolean | 操作是否成功 | - |
| code | int32 | 错误代码 | - |
| msg | string | 操作描述 | - |
| data | object | 操作成功返回的数据 | - |
| └─any object | object | any object. | - |
Response-example:
{
"success": true,
"code": 0,
"msg": "",
"data": {}
}增删数据库字段 数据做同步修改
错误码列表
| Error code | Description |
|---|---|
| 0 | 操作成功 |
| 1 | 服务器内部错误,请联系开发人员 |
| 2 | 参数校验失败 |
| 3 | 对象[{}]不存在 |
| 100 | 令牌未传入 |
| 101 | 令牌已失效 |
| 102 | 校验令牌出问题了 |
| 200 | 权限不足拒绝访问 |
| 211 | 当前用户不是全局系统管理员 |
| 212 | 当前用户不是全局安全保密员 |
| 213 | 当前用户不是全局安全审计员 |
| 214 | 当前用户不是部门系统管理员 |
| 215 | 当前用户不是部门安全保密员 |
| 216 | 当前用户不是部门安全审计员 |
| 220 | 当前用户没有拥有角色[{}] |
| 221 | 当前岗位没有拥有角色[{}] |
| 222 | 当前用户不是[{}] |
| 230 | 当前用户没有被授权资源[{}] |
| 231 | 当前岗位没有被授权资源[{}] |
数据字典
http状态码字典
| Code | Type | Description |
|---|---|---|
| 200 | string | ok |
| 400 | string | Bad Request |
| 401 | string | Unauthorized |
| 403 | string | Forbidden |
| 404 | string | Not Found |
| 415 | string | Unsupported Media Type |
| 500 | string | Internal Server Error |
| 502 | string | Bad Gateway |
| 503 | string | Service Unavailable |