Skip to main content
Version: 1.5.0

BMLFS Management

BMLFsRestfulApi class

Open ScriptFromBML

Interface address:/api/rest_j/v1/filesystem/openScriptFromBML

Request method: GET

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

Response data type: */*

Interface description:

openScriptFromBML

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
fileNameFile namequerytruestring
creatorCreatorqueryfalsestring
projectNameProject namequeryfalsestring
resourceIdResourceIdqueryfalsestring
versionversionqueryfalsestring

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
}

-product-openScriptFromBML

Interface address:/api/rest_j/v1/filesystem/product/openScriptFromBML

Request method: GET

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

Response data type: */*

Interface description:

/product/openScriptFromBML

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
fileNameFile namequerytruestring
creatorCreatorqueryfalsestring
resourceIdResourceIdqueryfalsestring
versionversionqueryfalsestring

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
}

Save script from BML

Interface address:/api/rest_j/v1/filesystem/saveScriptToBML

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Save script from BML

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
creatorCreatortrueStringString
fileNameFile nametrueStringString
metadatametadatatrueStringString
projectNameProject NametrueStringString
resourceIdResource IDtrueStringString
scriptContentContenttrueStringString
SaveScriptToBMLjsonbodytrueSaveScriptToBMLSaveScriptToBML

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
}