Skip to main content
Version: 1.5.0

UDF Operations Management

UDFApi class

new

Interface address:/api/rest_j/v1/udf/add

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Added

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
clusterNameclusterNamefalseStringString
createTimeCreateTimefalseDateDate
createUserCreatorfalseStringString
descriptionDescriptionfalseStringString
directoryCategory, personal function first-level directoryfalseStringString
isExpireis invalidfalseBooleanBoolean
isLoadWhether to loadfalseBooleanBoolean
isSharedSharedfalseBooleanBoolean
pathOnly store the last uploaded path of the user for promptingfalseStringString
registerFormatregister execution addressfalseStringString
syssysfalseStringString
treeIdtreeIdfalseLongLong
udfNameudfNamefalseStringString
udfTypeudfTypefalseIntegerInteger
updateTimeUpdate timefalseDateDate
useFormatUse FormatfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

udf tree menu

Interface address:/api/rest_j/v1/udf/all

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Get detailed information of udf tree menu

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
pathRequest PathfalseStringString
jsonStringjsonStringfalsestringstring

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

Get udf user list

Interface address:/api/rest_j/v1/udf/allUdfUsers

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get udf user list

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

confirmed

Interface address: /api/rest_j/v1/udf/authenticate

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Prove...is real

Request Parameters:

No

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

delete

Interface address:/api/rest_j/v1/udf/delete/{id}

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
ididfalseintegerinteger(int64)

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

udf file download to local

Interface address:/api/rest_j/v1/udf/downloadToLocal

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Download UDF file to local according to version parameters

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

UDF View source code

Interface address:/api/rest_j/v1/udf/downloadUdf

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

UDF view source code

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

delete

Interface address:/api/rest_j/v1/udf/delete/{id}

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
ididfalseintegerinteger(int64)

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

udf file download to local

Interface address:/api/rest_j/v1/udf/downloadToLocal

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Download UDF file to local according to version parameters

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

UDF View source code

Interface address:/api/rest_j/v1/udf/downloadUdf

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

UDF view source code

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

Publish

Interface address:/api/rest_j/v1/udf/publish

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

UDF version released

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

fallback version

Interface address:/api/rest_j/v1/udf/rollback

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Back to version

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseinteger
versionversionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

set expiration

Interface address:/api/rest_j/v1/udf/setExpire

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Setting expired

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseLongLong

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

UDF sharing

Interface address: /api/rest_j/v1/udf/shareUDF

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

UDF sharing

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
sharedUserssharedUsersfalseListList
udfInfoudfInfofalseUDFInfoUDFInfo

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

tree new

Interface address:/api/rest_j/v1/udf/tree/add

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

tree added

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
categorycategoryfalseStringString
childrenschildrensfalseListList
clusterNameclusterNamefalseStringString
createTimecreateTimefalseDateDate
descriptiondescriptionfalseStringString
ididfalseLongLong
namenamefalseStringString
parentparentfalseLongLong
udfInfosudfInfosfalseListList
updateTimeupdateTimefalseDateDate
userNameuserNamefalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

tree delete

Interface address:/api/rest_j/v1/udf/tree/delete/{id}

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

tree delete

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
ididfalseintegerinteger(int64)

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

tree update

Interface address:/api/rest_j/v1/udf/tree/update

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

tree update

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
categorycategoryfalseStringString
childrenschildrensfalseListList
clusterNameclusterNamefalseStringString
createTimecreateTimefalseDateDate
descriptiondescriptionfalseStringString
ididfalseLongLong
namenamefalseStringString
parentparentfalseLongLong
udfInfosudfInfosfalseListList
updateTimeupdateTimefalseDateDate
userNameuserNamefalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

renew

Interface address:/api/rest_j/v1/udf/update

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

UDF modification

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
descriptionDescriptionfalseStringString
ididfalseLongLong
isLoadWhether to loadfalseBooleanBoolean
pathOnly store the last uploaded path of the user for promptingfalseStringString
registerFormatregister execution addressfalseStringString
udfNameudfNamefalseStringString
udfTypeudfTypefalseIntegerInteger
useFormatUse FormatfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

Get user directory

Interface address: /api/rest_j/v1/udf/userDirectory

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get the first-level classification of the user's personal function

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
categoryGet the user directory of the specified collection type, if the type is UDF, get the user directory under this typefalsestringstring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

version list

Interface address:/api/rest_j/v1/udf/versionList

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

View version list

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
udfIdudfIdfalseintegerinteger(int64)

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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