Page Comparison

Operation

Creating a Rule

URL

api/holmes-rule-mgmt/v1/rule

Method

PUT

Request

Message Type

JSON String

Message

{

"rulename": "Alarm Compression",

"loopcontrolname": "Control Loop Name",

"description": "This is the description of the rule.",

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

"enabled": 0

}

Field Name	Mandatory	Data Type	Description
rulename	Y	string	the name of the rule
loopcontrolname	Y	string	the control loop name which is generated by CLAMP.
description	N	string	the description of the rule which helps the users to tell one rule from another
content	Y	string	the content of the rule which should be fully in compliance with the grammatical regulations of Drools
enabled	Y	integer	0 or 1 which stands for "disabled" and "enabled" respectively

Response

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

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