Page History

Operation	Creating a Rule
URL	api/

correlation

holmes-rule-

mgt

mgmt/v1/rule

Method

PUT

Request

Message Type

JSON String

Message

{

"

rulename

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	Default Value	Description

rulename

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

ruleId": "ruleid0281721"

}

Message on Error

{

"code": 499,

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

}

Field Name	Description

ruleid

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/

correlation

holmes-rule-

mgt

mgmt/v1/rule

Method

POST

Request

Message Type	JSON String
Message	{

“ruleid

“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	Default Value	Description

ruleid

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

ruleId": "ruleid0281721"

}

Message on Error

{

"code": 499,

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

}

Field Name	Description

ruleid

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/

correlation

holmes-rule-

mgt

Request
mgmt/v1/rule/{ruleid}
Method	DELETE

Message Type

JSON String

Message

{

“ruleid": "ruleid0937261"

}

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/

correlation

holmes-rule-

mgt

mgmt/v1/rule

Method

GET

Request

Message Type

JSON String

Message

{

“ruleid": "ruleid0937261",

"rulename": "Alarm Compression",

"enabled": 0

}

Field Name	Mandatory	Data Type	Default Value	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

{

"

rules

correlationRules": [

{

"

ruleid

ruleId": "ruleid098271",

"

rulename

ruleName": "Alarm Compression",

"description": "The description of the rule.",

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

"

createtime

createTime": 1484188925231,

"creator": "admin",

"

updatetime

updateTime": 1485188925231,

"modifier": "user1",

"enabled": 0

}

],

"

totalcount

totalCount": 1

}

Message on Error

{

"code": 499,

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

}

Field Name	Description

rules

correlationRules

an array contains all the rules which fulfill the query criteria

totalcount

totalCount

the number of the rules which fulfill the query criteria

ruleid

ruleId

the id of the rule

rulename

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

createTime	the time when the rule is created
creator	the id of the creator of the rule

updatetime

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

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version Current

Key