4 "description" : "This page shows all the APIs available in the Holmes rule management module.",
6 "title" : "API Descriptions for Holmes Rule Management",
7 "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin",
9 "name" : "Guangrong Fu",
10 "email" : "fu.guangrong@zte.com.cn"
13 "name" : "Apache 2.0",
14 "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
17 "basePath" : "/api/holmes-rule-mgmt/v1/",
19 "name" : "Health Check"
21 "name" : "Holmes Rule Management"
26 "tags" : [ "Health Check" ],
27 "summary" : "Interface for the health check of the rule management module for Holmes",
29 "operationId" : "healthCheck",
30 "produces" : [ "text/plain" ],
33 "description" : "successful operation",
43 "tags" : [ "Holmes Rule Management" ],
44 "summary" : "Query rules using certain criteria.",
46 "operationId" : "getCorrelationRules",
47 "produces" : [ "application/json" ],
49 "name" : "queryrequest",
51 "description" : "A JSON string used as a query parameter, which comprises \"ruleId\"(optional), \"ruleName\"(optional), \"creator\"(optional), \"modifier\"(optional) and \"enabled\"(optional). E.g. {\"ruleId\":\"rule_1484727187317\"}",
57 "description" : "successful operation",
59 "$ref" : "#/definitions/RuleQueryListResponse"
65 "tags" : [ "Holmes Rule Management" ],
66 "summary" : "Update an existing rule; deploy it to the Drools engine if it is enabled.",
68 "operationId" : "updateCorrelationRule",
69 "produces" : [ "application/json" ],
73 "description" : "The request entity of the HTTP call, which comprises \"ruleId\"(required), \"content\"(required), \"enabled\"(required) and \"description\"(optional)",
76 "$ref" : "#/definitions/RuleUpdateRequest"
81 "description" : "successful operation",
83 "$ref" : "#/definitions/RuleAddAndUpdateResponse"
89 "tags" : [ "Holmes Rule Management" ],
90 "summary" : "Save a rule into the database; deploy it to the Drools engine if it is enabled.",
92 "operationId" : "addCorrelationRule",
93 "produces" : [ "application/json" ],
97 "description" : "The request entity of the HTTP call, which comprises \"ruleName\"(required), \"loopControlName\"(required), \"content\"(required), \"enabled\"(required) and \"description\"(optional)",
100 "$ref" : "#/definitions/RuleCreateRequest"
105 "description" : "successful operation",
107 "$ref" : "#/definitions/RuleAddAndUpdateResponse"
115 "tags" : [ "Holmes Rule Management" ],
116 "summary" : "Remove a rule from Holmes.",
118 "operationId" : "deleteCorrelationRule",
119 "produces" : [ "application/json" ],
128 "description" : "successful operation",
138 "RuleAddAndUpdateResponse" : {
146 "RuleCreateRequest" : {
162 "loopControlName" : {
167 "RuleQueryListResponse" : {
170 "correlationRules" : {
173 "$ref" : "#/definitions/RuleResult4API"
209 "format" : "date-time"
213 "format" : "date-time"
215 "loopControlName" : {
220 "RuleUpdateRequest" : {
236 "loopControlName" : {