UDF接口

UDF移交

基本信息

Path： /api/rest_j/v1/udf/handover

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须
handoverUser string 必须 被移交用户

UDF修改

基本信息

Path： /api/rest_j/v1/udf/update

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfUpdateVo object 必须
├─ id number 必须
├─ udfName string 必须 不能修改
├─ udfType number 必须 不能修改
├─ description string 必须
├─ path string 必须 jar类型udf采用文件路径方式上传
├─ useFormat string 必须
├─ registerFormat string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

UDF共享用户列表

基本信息

Path： /api/rest_j/v1/udf/getSharedUsers

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
sharedUsers string [] 必须 item 类型: string
├─ 非必须

UDF删除

基本信息

Path： /api/rest_j/v1/udf/delete/{id}

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

路径参数

参数名称 示例 备注
id 100 udf id

Body

名称 类型 是否必须 默认值 备注 其他信息

UDF新增

基本信息

Path： /api/rest_j/v1/udf/add

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfAddVo object 必须
├─ udfName string 必须
├─ udfType number 必须
├─ description string 必须
├─ path string 必须 jar类型udf采用文件路径方式上传
├─ shared boolean 非必须 不用传
├─ useFormat string 必须
├─ expire boolean 非必须 不用传
├─ load boolean 必须
├─ registerFormat string 必须
├─ treeId number 非必须 不用传
├─ sys string 必须 系统：暂时均为：“IDE”
├─ clusterName string 必须 集群，暂时均为“all”
├─ directory string 必须 个人函数的一级分类目录

返回数据

名称 类型 是否必须 默认值 备注 其他信息

UDF查看源码

基本信息

Path： /api/rest_j/v1/udf/downloadUdf

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须
version string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
method string 必须
status number 必须
message string 必须
data object 必须
├─ content string 必须 udf内容

UDF版本发布

基本信息

Path： /api/rest_j/v1/udf/publish

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须
version string 必须 发布的版本：v000005

UDF共享

基本信息

Path： /api/rest_j/v1/udf/shareUDF

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfInfo object 必须
├─ id number 必须
├─ udfName string 必须
├─ udfType number 必须
sharedUsers string [] 必须 被共享用户列表 item 类型: string
├─ 非必须

UDF管理页面

注：只能看到用户自己创建的udf

基本信息

Path： /api/rest_j/v1/udf/managerPages

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfName string 非必须
udfType string 必须 逗号分割的字符串，如：0,1,2
createUser string 非必须
curPage number 必须 第几页
pageSize number 必须 记录个数

返回数据

名称 类型 是否必须 默认值 备注 其他信息
infoList object [] 必须 item 类型: object
├─ id number 必须
├─ createUser string 必须 udf创建者
├─ udfName string 必须
├─ udfType string 必须
├─ expire boolean 必须 udf是否过期
├─ shared boolean 必须 是否为共享udf
├─ treeId number 必须
├─ sys string 必须 系统，例如：dss
├─ clusterName string 必须 集群，暂时为all
├─ createTime number 必须
├─ updateTime number 必须
├─ path string 必须 用户上一次上传的路径，作展示用
├─ registerFormat string 必须
├─ useFormat string 必须
├─ description string 必须
├─ operationStatus object 必须 分类
├─ canUpdate boolean 必须 可否编辑
├─ canShare boolean 必须 可否共享
├─ canPublish boolean 必须 可否发布
├─ canDelete boolean 必须 可否删除
├─ canExpire boolean 必须 可否过期
├─ canHandover boolean 必须 可否移交
totalPage number 必须 总页数
field_1 string 必须
total number 必须 总条数

UDF过期

基本信息

Path： /api/rest_j/v1/udf/setExpire

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

udf文件下载到本地

基本信息

Path： /api/rest_j/v1/udf/downloadToLocal

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须
version string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

版本列表查看

基本信息

Path： /api/rest_j/v1/udf/versionList

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
udfId 是 100

返回数据

名称 类型 是否必须 默认值 备注 其他信息
versionList object [] 非必须 item 类型: object
├─ id number 非必须
├─ udfId number 非必须
├─ path string 非必须
├─ bmlResourceId string 非必须
├─ bmlResourceVersion string 非必须
├─ isPublished boolean 非必须
├─ registerFormat string 非必须
├─ useFormat string 非必须
├─ description string 非必须
├─ createTime number 非必须
├─ expire boolean 非必须
├─ createUser string 非必须

版本回退

基本信息

Path： /api/rest_j/v1/udf/rollback

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
udfId number 必须
version string 必须 回退版本

获取udf用户列表

基本信息

Path： /api/rest_j/v1/udf/allUdfUsers

Method： GET

接口描述：

请求参数

返回数据

名称 类型 是否必须 默认值 备注 其他信息
udfUsers string [] 必须 item 类型: string
├─ 非必须

获取用户个人函数的一级分类

基本信息

Path： /api/rest_j/v1/udf/userDirectory

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
category 是 udf 必须是”udf”或”function”，分别代表获取udf函数的一级分类和方法函数的一级分类

返回数据

名称 类型 是否必须 默认值 备注 其他信息
userDirectory string [] 必须 分类名组成的列表 item 类型: string
├─ 非必须