Engine Management - Guilin

Operation

Deploying a Rule

URL

api/holmes-engine-mgmt/v1/rule

Method

PUT

Request

Message Type

JSON String

Message

{

"engineId": "aplus-d",

"content": "template header\n ruleId\n package packageName...",

"loopControlName": "loop-control-name"

}

Field Name	Mandatory	Data Type	Description
engineId	N	string	the id of the rule engine which the rule is to be deployed to
content	Y	string	the content of the rule which should be fully in compliance with the grammatical regulations of Drools
loopControlName	Y	string	closed loop control name

Response

Success Code	200
Error Code	499
Message on Success	{ "packageName": "package0281721", }
Message on Error	{ "code": 499, "message": "The detailed error message is displayed here." }

Field Name	Description
packageName	the id of the package returned from the server
code	the error code returned from the server
message	the detailed message if any error occurs

Operation

Undeploying a Rule

URL

api/holmes-engine-mgmt/v1/rule/{packageName}

Method

DELETE

Request

Parameter Name	Mandatory	Data Type	Default Value	Description
packageName	Y	string		the name of the package

Response

Success Code	200
Error Code	499
Message on Success	none
Message on Error	{ "code": 499, "message": "The detailed error message is displayed here." }

Field Name	Description
code	the error code returned from the server
message	the detailed message if any error occurs

Operation

Verifying a Rule

URL

api/holmes-engine-mgmt/v1/rule

Method

POST

Request

Message Type

JSON String

Message

{

"content": "template header\n ruleId\n package packageName..."

}

Field Name	Mandatory	Data Type	Default Value	Description
content	N	string		the content of the rule which should be fully in compliance with the grammatical regulations of Drools

Response

Success Code	200
Error Code	499
Message on Success	none
Message on Error	{ "code": 499, "message": "The detailed error message is displayed here." }

Field Name	Description
code	the error code returned from the server
message	the detailed message if any error occurs