Skip to main content
Version: 1.5.0

BML Resource Management

BmlRestfulApi class

update owner

Interface address:/api/rest_j/v1/bml/changeOwner

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Update owner

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
newOwnerOld OwnerfalseStringString
oldOwnerNew OwnerfalseStringString
resourceIdResourceIdfalseStringString

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
}

Copy resources to other users

Interface address:/api/rest_j/v1/bml/copyResourceToAnotherUser

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Copy resources to specified user

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
anotherUserspecified userfalseStringString
resourceIdResourceIdfalseStringString

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 resource

Interface address:/api/rest_j/v1/bml/deleteResource

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete version

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdtrueStringString

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 multiple resources

Interface address:/api/rest_j/v1/bml/deleteResources

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete multiple resources

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdsCollection of resource IDs, delete multiple resourcestrueListList

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 version

Interface address:/api/rest_j/v1/bml/deleteVersion

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete version

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdtrueStringString
versionversiontrueStringString

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
}

Download resources

Interface address:/api/rest_j/v1/bml/download

Request method: GET

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

Response data type: */*

Interface description:

Get the resources corresponding to download through the two parameters of resourceId and version

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdqueryfalsestring
versionResource version, if not specified, defaults to latestqueryfalsestring

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
}

Get Basic

Interface address:/api/rest_j/v1/bml/getBasic

Request method: GET

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

Response data type: */*

Interface description:

Get Basic

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdquerytruestring

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
}

Get resource information

Interface address:/api/rest_j/v1/bml/getResourceInfo

Request method: GET

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

Response data type: */*

Interface description:

Get resource information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdqueryfalsestring

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
}

Get resource information

Interface address:/api/rest_j/v1/bml/getResources

Request method: GET

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

Response data type: */*

Interface description:

Get resource information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
currentPagepage numberqueryfalsestring
pageSizepage sizequeryfalsestring
systemsystemqueryfalsestring

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
}

Get version information

Interface address: /api/rest_j/v1/bml/getVersions

Request method: GET

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

Response data type: */*

Interface description:

Get bml version information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
currentPagepage numberqueryfalsestring
pageSizepage sizequeryfalsestring
resourceIdResource IDqueryfalsestring

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
}

rollback version

Interface address:/api/rest_j/v1/bml/rollbackVersion

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Rollback version

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
resourceIdResourceIdfalseStringString
versionRollback versionfalseStringString

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
}

update resource

Interface address:/api/rest_j/v1/bml/updateVersion

Request method: POST

Request data type: multipart/form-data

Response data type: */*

Interface description:

Users update resource files through http

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
filefilefileformDatatrueref
resourceIdresourceIdquerytruestring

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
}

upload resources

Interface address:/api/rest_j/v1/bml/upload

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Upload resources

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
filefileformDatatruearrayfile
expireTimeexpireTimequeryfalsestring
expireTypeexpireTypequeryfalsestring
isExpireisExpirequeryfalsestring
maxVersionmaxVersionqueryfalseinteger(int32)
resourceHeaderresourceHeaderqueryfalsestring
systemsystemqueryfalsestring

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
}