Engine Plugin API

EnginePluginRestful class

Interface address:/api/rest_j/v1/engineplugin/refresh

Request method: GET

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

Response data type: */*

Interface description:

Refresh a single resource

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
ecTypetypequeryfalsestring
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:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

Interface address:/api/rest_j/v1/engineplugin/refreshAll

Request method: GET

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

Response data type: */*

Interface description:

Refresh all ec resources

Request Parameters:

No

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

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

Sample Response:

  1. {
  2. "data": {},
  3. "message": "",
  4. "method": "",
  5. "status": 0
  6. }

Interface address: /api/rest_j/v1/engineplugin/rollBack

Request method:POST

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

Response data type:*/*

Interface Description:

Roll back the material version of the current engine plugin

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
engineConnBmlResourceEngineConnBmlResource entitybodytrueEngineConnBmlResource

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {}
  6. }

Interface address:/api/rest_j/v1/engineplugin/getVersionList

Request method: GET

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

Response data type:*/*

Interface Description:

Get all versions of the engine plugin in the material management system

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
bmlResourceIdengine material resource idbodytrueEngineConnBmlResource
ecTypeengine namebodyfalseString
versionengine versionbodyfalseString

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {}
  6. }

Interface address:/api/rest_j/v1/engineplugin/getTypeList

Request method: GET

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

Response data type:*/*

Interface Description:

Get all types of engine names

Request parameters

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "typeList": [
  7. "hive",
  8. "io_file",
  9. "jdbc",
  10. "open look",
  11. "python",
  12. "shell",
  13. "spark"
  14. ]
  15. }
  16. }

Interface address: /api/rest_j/v1/engineplugin/getTypeVersionList/{type}

Request method: GET

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

Response data type:*/*

Interface Description:

Get all types of engine names

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
typetype name of the enginepathtrueString

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "queryList": [
  7. "v4"
  8. ]
  9. }
  10. }

Interface address:/api/rest_j/v1/engineplugin/updateEnginePluginBML

Request method: POST

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

Response data type:*/*

Interface Description:

Update specific engine plugins

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
fileengine material filebodytrueMultipartFile
ecTypeengine type namebodytrueString
versionengine versionbodytrueString

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "mess": "upload file success"
  7. }
  8. }

Interface address: /api/rest_j/v1/engineplugin/list

Request method: GET

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

Response data type:*/*

Interface Description:

Request all engine plugin information

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
currentPagecurrent pagequreytrueinteger(int32)
ecTypeengine type namequreyfalseString
versionengine versionqureyfalseString
pageSizepage sizequreytrueinteger(int32)

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "totalPage": 17,
  7. "queryList": [
  8. {
  9. "id": 239,
  10. "engineConnType": "python",
  11. "version": "python2",
  12. "fileName": "lib.zip",
  13. "lastModified": 1661950452000,
  14. "fileSize": 6093507,
  15. "bmlResourceId": "8edb8e88-fc75-4ce3-a330-3ece9ec533cb",
  16. "bmlResourceVersion": "v000001",
  17. "createTime": "2022-08-31 20:56:59",
  18. "lastUpdateTime": "2022-08-31 20:56:59"
  19. },
  20. {
  21. "id": 238,
  22. "engineConnType": "python",
  23. "version": "python2",
  24. "fileName": "conf.zip",
  25. "lastModified": 1661950450000,
  26. "fileSize": 43841,
  27. "bmlResourceId": "a46beb9b-7368-4900-a2a6-241f1ec49002",
  28. "bmlResourceVersion": "v000001",
  29. "createTime": "2022-08-31 20:56:54",
  30. "lastUpdateTime": "2022-08-31 20:56:54"
  31. }
  32. ]
  33. }
  34. }

Interface address:/api/rest_j/v1/engineplugin/uploadEnginePluginBML

Request method: POST

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

Response data type:*/*

Interface Description:

Upload a new engine plugin

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
fileengine material file compression packagebodytrueMultipartFile

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadatasetobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {
  2. "method": null,
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "mess": "upload file success"
  7. }
  8. }

Interface address:/api/rest_j/v1/engineplugin/deleteEnginePluginBML

Request method: GET

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

Response data type:*/*

Interface Description:

Delete the specified engine plugin

Request parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
ecTypeengine type namequreytrueString
versionengine versionqureyfalseString

Response Status:

status codedescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
datadata setobject
messagedescriptionstring
methodrequest urlstring
statusstatusinteger(int32)integer(int32)

Response Example:

  1. {"method":null,"status":0,"message":"OK","data":{"msg":"delete successfully"}}