| --- |
| title: BML资源管理 |
| sidebar_position: 14 |
| --- |
| ** BmlRestfulApi 类 ** |
| |
| |
| |
| ## 更新owner |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/changeOwner` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>更新owner</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |newOwner|旧Owner|false|String|String| |
| |oldOwner|新Owner|false|String|String| |
| |resourceId|资源Id|false|String|String| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 复制资源到其他用户 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/copyResourceToAnotherUser` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>复制资源到指定用户</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |anotherUser|指定用户|false|String|String| |
| |resourceId|资源Id|false|String|String| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 删除资源 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/deleteResource` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>删除版本</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|true|String|String| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 删除多个资源 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/deleteResources` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>删除多个资源</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceIds|资源Id集合,删除多个资源|true|List|List| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 删除版本 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/deleteVersion` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>删除版本</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|true|String|String| |
| |version|版本|true|String|String| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 下载资源 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/download` |
| |
| |
| **请求方式**:`GET` |
| |
| |
| **请求数据类型**:`application/x-www-form-urlencoded` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>通过resourceId 和 version两个参数获取下载对应的资源</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|query|false|string| |
| |version|资源版本,如果不指定,默认为最新|query|false|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 获取Basic |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/getBasic` |
| |
| |
| **请求方式**:`GET` |
| |
| |
| **请求数据类型**:`application/x-www-form-urlencoded` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>获取Basic</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|query|true|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 获取资源信息 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/getResourceInfo` |
| |
| |
| **请求方式**:`GET` |
| |
| |
| **请求数据类型**:`application/x-www-form-urlencoded` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>获取资源信息</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|query|false|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 获取资源信息 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/getResources` |
| |
| |
| **请求方式**:`GET` |
| |
| |
| **请求数据类型**:`application/x-www-form-urlencoded` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>获取资源信息</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |currentPage|页码|query|false|string| |
| |pageSize|页面大小|query|false|string| |
| |system|系统|query|false|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 获取版本信息 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/getVersions` |
| |
| |
| **请求方式**:`GET` |
| |
| |
| **请求数据类型**:`application/x-www-form-urlencoded` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>获取bml版本信息</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |currentPage|页码|query|false|string| |
| |pageSize|页面大小|query|false|string| |
| |resourceId|资源ID|query|false|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 回滚版本 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/rollbackVersion` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>回滚版本</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |resourceId|资源Id|false|String|String| |
| |version|回滚版本|false|String|String| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 更新资源 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/updateVersion` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`multipart/form-data` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>用户通过http的方式更新资源文件</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |file|file文件|formData|true|ref| |
| |resourceId|用户希望更新资源的resourceId|query|true|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |
| |
| ## 上传资源 |
| |
| |
| **接口地址**:`/api/rest_j/v1/bml/upload` |
| |
| |
| **请求方式**:`POST` |
| |
| |
| **请求数据类型**:`application/json` |
| |
| |
| **响应数据类型**:`*/*` |
| |
| |
| **接口描述**:<p>上传资源</p> |
| |
| |
| |
| **请求参数**: |
| |
| |
| | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | |
| | -------- | -------- | ----- | -------- | -------- | ------ | |
| |file|file|formData|true|array|file| |
| |expireTime|expireTime|query|false|string| |
| |expireType|expireType|query|false|string| |
| |isExpire|isExpire|query|false|string| |
| |maxVersion|maxVersion|query|false|integer(int32)| |
| |resourceHeader|resourceHeader|query|false|string| |
| |system|system|query|false|string| |
| |
| |
| **响应状态**: |
| |
| |
| | 状态码 | 说明 | schema | |
| | -------- | -------- | ----- | |
| |200|OK|Message| |
| |201|Created| |
| |401|Unauthorized| |
| |403|Forbidden| |
| |404|Not Found| |
| |
| |
| **响应参数**: |
| |
| |
| | 参数名称 | 参数说明 | 类型 | schema | |
| | -------- | -------- | ----- |----- | |
| |data|数据集|object| |
| |message|描述|string| |
| |method|请求url|string| |
| |status|状态|integer(int32)|integer(int32)| |
| |
| |
| **响应示例**: |
| ```javascript |
| { |
| "data": {}, |
| "message": "", |
| "method": "", |
| "status": 0 |
| } |
| ``` |
| |