Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
OperationDeploying a Rule
URLapi/
correlation
holmes-engine-mgmt/v1/rule
MethodPUT
Request
Message TypeJSON String
Message

{

"

engineid

engineId": "aplus-d",

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

"loopControlName": "loop-control-name"

}

Field Name

Mandatory

Data Type

Default Value

Description

engineid
engineId
Y
Nstring
 

the id of the rule engine which the rule is to be deployed to
contentYstring
 

the content of the rule which should be fully in compliance with the grammatical regulations of Drools
loopControlNameYstring
closed loop control name
Response
Success Code200
Error Code499
Message on Success

 {

"

package

packageName": "package0281721",

}

Message on Error

{

"code": 499,

"message": "The detailed error message is displayed here."

}

Field Name

Description

package
packageNamethe id of the package returned from the server
codethe error code returned from the server
messagethe detailed message if any error occurs
OperationUndeploying a Rule
URLapi/
correlation
holmes-engine-mgmt/v1/rule/{
packageId
packageName}
MethodDELETE
Request
 



Parameter Name

Mandatory

Data Type

Default Value

Description

packageId
packageNameYstring
 

the
id
name of the package
Response
Success Code200
Error Code499
Message on Success

none

Message on Error

{

"code": 499,

"message": "The detailed error message is displayed here."

}

Field Name

Description

codethe error code returned from the server
messagethe detailed message if any error occurs
OperationVerifying a Rule
URLapi/
correlation
holmes-engine-mgmt/v1/rule
MethodPOST
Request
Message TypeJSON String
Message

{

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

}

Field Name

Mandatory

Data Type

Default Value

Description

contentNstring
 

the content of the rule which should be fully in compliance with the grammatical regulations of Drools
Response
Success Code200
Error Code499
Message on Success

none

Message on Error

{

"code": 499,

"message": "The detailed error message is displayed here."

}

Field Name

Description

codethe error code returned from the server
messagethe detailed message if any error occurs