Skip to main content
版本:1.1.1

UDF接口

UDF移交

基本信息

Path: /api/rest_j/v1/udf/handover

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfIdnumber必须
handoverUserstring必须被移交用户

UDF修改

基本信息

Path: /api/rest_j/v1/udf/update

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfUpdateVoobject必须
├─ idnumber必须
├─ udfNamestring必须不能修改
├─ udfTypenumber必须不能修改
├─ descriptionstring必须
├─ pathstring必须jar类型udf采用文件路径方式上传
├─ useFormatstring必须
├─ registerFormatstring必须
### 返回数据
名称类型是否必须默认值备注其他信息

UDF共享用户列表

基本信息

Path: /api/rest_j/v1/udf/getSharedUsers

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfIdnumber必须
### 返回数据
名称类型是否必须默认值备注其他信息
sharedUsersstring []必须

item 类型: string

├─ 非必须

UDF删除

基本信息

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

Method: POST

接口描述:

请求参数

Headers

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

路径参数

参数名称示例备注
id100udf id

Body

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

UDF新增

基本信息

Path: /api/rest_j/v1/udf/add

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfAddVoobject必须
├─ udfNamestring必须
├─ udfTypenumber必须
├─ descriptionstring必须
├─ pathstring必须jar类型udf采用文件路径方式上传
├─ sharedboolean非必须不用传
├─ useFormatstring必须
├─ expireboolean非必须不用传
├─ loadboolean必须
├─ registerFormatstring必须
├─ treeIdnumber非必须不用传
├─ sysstring必须系统:暂时均为:“IDE”
├─ clusterNamestring必须集群,暂时均为“all”
├─ directorystring必须个人函数的一级分类目录

返回数据

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

UDF查看源码

基本信息

Path: /api/rest_j/v1/udf/downloadUdf

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
methodstring必须
statusnumber必须
messagestring必须
dataobject必须
├─ contentstring必须udf内容

UDF版本发布

基本信息

Path: /api/rest_j/v1/udf/publish

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfIdnumber必须
versionstring必须发布的版本:v000005

UDF共享

基本信息

Path: /api/rest_j/v1/udf/shareUDF

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfInfoobject必须
├─ idnumber必须
├─ udfNamestring必须
├─ udfTypenumber必须
sharedUsersstring []必须被共享用户列表

item 类型: string

├─ 非必须

UDF管理页面

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

基本信息

Path: /api/rest_j/v1/udf/managerPages

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfNamestring非必须
udfTypestring必须逗号分割的字符串,如:0,1,2
createUserstring非必须
curPagenumber必须第几页
pageSizenumber必须记录个数

返回数据

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

item 类型: object

├─ idnumber必须
├─ createUserstring必须udf创建者
├─ udfNamestring必须
├─ udfTypestring必须
├─ expireboolean必须udf是否过期
├─ sharedboolean必须是否为共享udf
├─ treeIdnumber必须
├─ sysstring必须系统,例如:dss
├─ clusterNamestring必须集群,暂时为all
├─ createTimenumber必须
├─ updateTimenumber必须
├─ pathstring必须用户上一次上传的路径,作展示用
├─ registerFormatstring必须
├─ useFormatstring必须
├─ descriptionstring必须
├─ operationStatusobject必须分类
├─ canUpdateboolean必须可否编辑
├─ canShareboolean必须可否共享
├─ canPublishboolean必须可否发布
├─ canDeleteboolean必须可否删除
├─ canExpireboolean必须可否过期
├─ canHandoverboolean必须可否移交
totalPagenumber必须总页数
field_1string必须
totalnumber必须总条数

UDF过期

基本信息

Path: /api/rest_j/v1/udf/setExpire

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

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

udf文件下载到本地

基本信息

Path: /api/rest_j/v1/udf/downloadToLocal

Method: POST

接口描述:

请求参数

Headers

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

Body

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

返回数据

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

版本列表查看

基本信息

Path: /api/rest_j/v1/udf/versionList

Method: GET

接口描述:

请求参数

Query

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

返回数据

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

item 类型: object

├─ idnumber非必须
├─ udfIdnumber非必须
├─ pathstring非必须
├─ bmlResourceIdstring非必须
├─ bmlResourceVersionstring非必须
├─ isPublishedboolean非必须
├─ registerFormatstring非必须
├─ useFormatstring非必须
├─ descriptionstring非必须
├─ createTimenumber非必须
├─ expireboolean非必须
├─ createUserstring非必须

版本回退

基本信息

Path: /api/rest_j/v1/udf/rollback

Method: POST

接口描述:

请求参数

Headers

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

Body

名称类型是否必须默认值备注其他信息
udfIdnumber必须
versionstring必须回退版本

获取udf用户列表

基本信息

Path: /api/rest_j/v1/udf/allUdfUsers

Method: GET

接口描述:

请求参数

返回数据

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

item 类型: string

├─ 非必须

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

基本信息

Path: /api/rest_j/v1/udf/userDirectory

Method: GET

接口描述:

请求参数

Query

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

返回数据

名称类型是否必须默认值备注其他信息
userDirectorystring []必须分类名组成的列表

item 类型: string

├─ 非必须