Skip to main content
版本:1.5.0

UDF操作管理

UDFApi 类

新增

接口地址:/api/rest_j/v1/udf/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

新增

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
clusterNameclusterNamefalseStringString
createTime创建时间falseDateDate
createUser创建者falseStringString
description描述falseStringString
directory分类,个人函数一级目录falseStringString
isExpire是否失效falseBooleanBoolean
isLoad是否负载falseBooleanBoolean
isShared是否共享falseBooleanBoolean
path仅存储用户上一次上传的路径 作提示用falseStringString
registerFormat注册执行地址falseStringString
syssysfalseStringString
treeIdtreeIdfalseLongLong
udfNameudfNamefalseStringString
udfTypeudfTypefalseIntegerInteger
updateTime更新时间falseDateDate
useFormat使用格式falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

udf树形菜单

接口地址:/api/rest_j/v1/udf/all

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

获取udf树形菜单详细信息

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
path请求路径falseStringString
jsonStringjsonStringqueryfalsestring

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

获取udf用户列表

接口地址:/api/rest_j/v1/udf/allUdfUsers

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取udf用户列表

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
jsonjsonbodytrueJsonNodeJsonNode

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

证实

接口地址:/api/rest_j/v1/udf/authenticate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

证明…是真实的

请求参数:

暂无

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

删除

接口地址:/api/rest_j/v1/udf/delete/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

删除

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
ididpathfalseinteger(int64)

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

udf文件下载到本地

接口地址:/api/rest_j/v1/udf/downloadToLocal

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

根据版本参数下载UDF文件到本地

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseinteger
versionversionfalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

UDF查看源码

接口地址:/api/rest_j/v1/udf/downloadUdf

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF查看源码

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseinteger
versionversionfalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

UDF共享用户列表

接口地址:/api/rest_j/v1/udf/getSharedUsers

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF共享用户列表

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseinteger

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

UDF移交

接口地址:/api/rest_j/v1/udf/handover

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF移交

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
handoverUser切换用户falseStringString
udfIdudfIdfalseinteger

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

是否负载

接口地址:/api/rest_j/v1/udf/isload

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

是否负载

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
isLoad是否负载queryfalseboolean
udfIdudfIdqueryfalseinteger(int64)

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

函数列表

接口地址:/api/rest_j/v1/udf/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

获取函数列表

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
ListUDFjsonbodytrueListUDFListUDF
category类别falseStringString
treeId树形菜单IdfalseStringString
type函数类型,比如expire,self,share等类型falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

基本信息

接口地址:/api/rest_j/v1/udf/managerPages

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

基本信息

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
curPage页码falseIntegerInteger
pageSize页面大小falseIntegerInteger
udfNameudf名称falseStringString
udfTypeudf类型falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

出版

接口地址:/api/rest_j/v1/udf/publish

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF版本发布

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseinteger
versionversionfalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

回退版本

接口地址:/api/rest_j/v1/udf/rollback

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

回退版本

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseinteger
versionversionfalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

设置过期

接口地址:/api/rest_j/v1/udf/setExpire

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

设置过期

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdfalseLongLong

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

UDF共享

接口地址:/api/rest_j/v1/udf/shareUDF

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF共享

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
sharedUserssharedUsersfalseListList
udfInfoudfInfofalseUDFInfoUDFInfo

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

tree新增

接口地址:/api/rest_j/v1/udf/tree/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

tree新增

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
categorycategoryfalseStringString
childrenschildrensfalseListList
clusterNameclusterNamefalseStringString
createTimecreateTimefalseDateDate
descriptiondescriptionfalseStringString
ididfalseLongLong
namenamefalseStringString
parentparentfalseLongLong
udfInfosudfInfosfalseListList
updateTimeupdateTimefalseDateDate
userNameuserNamefalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

tree删除

接口地址:/api/rest_j/v1/udf/tree/delete/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

tree删除

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
ididpathfalseinteger(int64)

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

tree更新

接口地址:/api/rest_j/v1/udf/tree/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

tree更新

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
categorycategoryfalseStringString
childrenschildrensfalseListList
clusterNameclusterNamefalseStringString
createTimecreateTimefalseDateDate
descriptiondescriptionfalseStringString
ididfalseLongLong
namenamefalseStringString
parentparentfalseLongLong
udfInfosudfInfosfalseListList
updateTimeupdateTimefalseDateDate
userNameuserNamefalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

更新

接口地址:/api/rest_j/v1/udf/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

UDF修改

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
description描述falseStringString
ididfalseLongLong
isLoad是否负载falseBooleanBoolean
path仅存储用户上一次上传的路径 作提示用falseStringString
registerFormat注册执行地址falseStringString
udfNameudfNamefalseStringString
udfTypeudfTypefalseIntegerInteger
useFormat使用格式falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

获取用户目录

接口地址:/api/rest_j/v1/udf/userDirectory

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

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

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
category获取指定集合类型用户目录,如类型为UDF即获取该类型下的用户目录queryfalsestring

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

版本列表

接口地址:/api/rest_j/v1/udf/versionList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

版本列表查看

请求参数:

参数名称参数说明是否必须请求类型数据类型schema
udfIdudfIdqueryfalseinteger(int64)

响应状态:

状态码说明schema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
data数据集object
message描述string
method请求urlstring
status状态integer(int32)integer(int32)

响应示例:

{
"data": {},
"message": "",
"method": "",
"status": 0
}