Skip to main content
Version: 1.3.0

BM Project Operation Management

BmlProjectRestful class

Attachment resource item

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

Request mode:POST

Request data type:application/json

Response data type:*/*

Interface description:

Attachment resource item

Request parameters:

parameter nameparameter descriptionrequest typemust bedata typeschema
projectNameproject namestringfalsestring
resourceidresource namestringfalsestring

Response status:

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

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusintegerinteger

Response example:

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

Create BML project

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

Request mode:POST

Request data type:application/json

Response data type:*/*

Interface description:

Create BML project

Request parameters:

parameter nameparameter descriptionrequest typemust bedata typeschema
accessusersaccess usersstringfalsestring
editusersedit userstringfalsestring
projectNameproject namestringfalsestring

Response status:

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

Response parameters:

Parameter nameparameter descriptiontypeschema
Datadatasetobject
Messagedescriptionstring
Methodrequest urlstring
Statusstatusintegerinteger

Response example:

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

Download shared resources

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

Request mode:GET

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

Response data type:*/*

Interface description:

Download shared resources

Request parameters:

Parameter nameparameter descriptionrequest typemust bedata typeschema
Resourceidresource IDqueryfalsestring
Versionversionqueryfalsestring

Response status:

Status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusintegerinteger

Response example:

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

Project information

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

Request mode:GET

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

Response data type:*/*

Interface description:

Project information

Request parameters:

Parameter nameparameter descriptionrequest typemust bedata typeschema
ProjectNameproject namequeryfalsestring

Response status:

Status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

Parameter nameparameter descriptiontypeschema
Datadatasetobject
Messagedescriptionstring
Methodrequest urlstring
Statusstatusintegerinteger

Response example:

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

Update project user

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

Request mode:POST

Request data type:application/json

Response data type:*/*

Interface description:

Update project users

Request parameters:

parameter nameparameter descriptionwhether it is requiredrequest typedata typeschema
accessusersaccess usersfalsestringstring
editusersedit userfalsestringstring
projectNameproject namefalsestringstring

Response status:

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

Response parameters:

Parameter nameparameter descriptiontypeschema
Datadatasetobject
Messagedescriptionstring
Methodrequest urlstring
Statusstatusintegerinteger

Response example:

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

Update shared resources

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

Request mode:POST

Request data type:multipart/form-data

Response data type:*/*

Interface description:

Update shared resources

Request parameters:

parameter nameparameter descriptionrequest typemust bedata typeschema
filefileformdatafalseref
resourceidresource IDqueryfalsestring

Response status:

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

Response parameters:

Parameter nameparameter descriptiontypeschema
Datadatasetobject
Messagedescriptionstring
Methodrequest urlstring
Statusstatusintegerinteger

Response example:

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

Upload shared resources

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

Request mode:POST

Request data type:application/json

Response data type:*/*

Interface description:

Upload shared resources

Request parameters:

parameter nameparameter descriptionrequest typemust bedata typeschema
expireTimeexpiration timequeryfalsestring
expiretypefailure typequeryfalsestring
filefile setformdatafalseref
isexpireinvalidqueryfalsestring
maxversionMAV versionqueryfalseref
projectNameproject namequeryfalsestring
resourceheaderresource headerqueryfalsestring
systemsystemqueryfalsestring

Response status:

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

Response parameters:

Parameter nameparameter descriptiontypeschema
Datadatasetobject
Messagedescriptionstring
Methodrequest urlstring
Statusstatusintegerinteger

Response example:

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