Offered APIs

The rule management module provides the following APIs.

• Rule Creation

• Rule Update

• Rule Query

• Rule Deletion

• Health Check

Health Check

GET /healthcheck

Interface for the health check of the rule management module for Holmes

• Description:

• Produces: [‘text/plain’]

Responses

200 - successful operation

Holmes Rule Management

GET /rule

Query rules using certain criteria.

• Description:

• Produces: [‘application/json’]

Parameters

Name	Position	Description	Type
queryrequest	query	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”}	string

Responses

200 - successful operation

POST /rule

Update an existing rule; deploy it to the Drools engine if it is enabled.

• Description:

• Produces: [‘application/json’]

Parameters

Name	Position	Description	Type
body	body	The request entity of the HTTP call, which comprises “ruleid”(required), “content”(required), “enabled”(required) and “description”(optional)

Responses

200 - successful operation

PUT /rule

Save a rule into the database; deploy it to the Drools engine if it is enabled.

• Description:

• Produces: [‘application/json’]

Parameters

Name	Position	Description	Type
body	body	The request entity of the HTTP call, which comprises “rulename”(required), “loopcontrolname”(required), “content”(required), “enabled”(required) and “description”(optional)

Responses

200 - successful operation

DELETE /rule/{ruleid}

Remove a rule from Holmes.

• Description:

• Produces: [‘application/json’]

Parameters

Name	Position	Description	Type
ruleid	path		string

Responses

200 - successful operation