Rule Management - Casablanca

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

Operation

Modifying a Rule

URL

api/holmes-rule-mgmt/v1/rule

Method

POST

Request

Message Type

JSON String

Message

{

“ruleId": "ruleid0937261",

"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
ruleId	Y	string	the id of the rule which is being edited
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

Operation

Deleting a Rule

URL

api/holmes-rule-mgmt/v1/rule/{ruleid}

Method

DELETE

Request

Field Name	Mandatory	Data Type	Default Value	Description
ruleid	Y	string		the id of the rule which is to be deleted

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

Querying Rules

URL

api/holmes-rule-mgmt/v1/rule

Method

GET

Request

Message Type

JSON String

Message

{

“ruleid": "ruleid0937261",

"rulename": "Alarm Compression",

"enabled": 0

}

Field Name	Mandatory	Data Type	Description
ruleid	N	string	the id of the rule which is to be deleted
rulename	N	string	the name of the rule
enabled	N	integer	0 or 1 which stands for "disabled" and "enabled" respectively. Both enabled and disabled rules will be returned if it's empty.

Response

Success Code	200
Error Code	499
Message on Success	{ "correlationRules": [ { "ruleId": "ruleid098271", "ruleName": "Alarm Compression", "description": "The description of the rule.", "content": "template header\n ruleId\n package packageName...", "createTime": 1484188925231, "creator": "admin", "updateTime": 1485188925231, "modifier": "user1", "enabled": 0 } ], "totalCount": 1 }
Message on Error	{ "code": 499, "message": "The detailed error message is displayed here." }

Field Name	Description
correlationRules	an array contains all the rules which fulfill the query criteria
totalCount	the number of the rules which fulfill the query criteria
ruleId	the id of the rule
ruleName	the name of the rule
description	the description of the rule which helps the users to tell one rule from another
content	the content of the rule which should be fully in compliance with the grammatical regulations of Drools
createTime	the time when the rule is created
creator	the id of the creator of the rule
updateTime	the time of the last modification
modifier	the id of the last user who has modified the rule
enabled	0 or 1 which stands for "disabled" and "enabled" respectively
code	the error code returned from the server
message	the detailed message if any error occurs