Table of Contents

Search

  1. Preface
  2. RulePoint Interfaces
  3. RulePoint Services
  4. Custom Service API
  5. Java Adapter for REST API
  6. RulePoint REST API
  7. Sample XML and JSON Requests and Responses
  8. RulePoint Pluggable Authentication Module
  9. HTTP Request and Response Attributes

Developer Guide

Developer Guide

Retrieve Rules

Retrieve Rules

Use the GET method to retrieve a rule in RulePoint.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves rules in a RulePoint application:
GET http://localhost:8080/rulepoint/api/projects/1/rules Accept: application/json Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in JSON Format

Returns the rule object and response code. Returns the error object if an error occurs.
{ "total": 3, "count": 3, "items": [ { "id": "f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "name": "sqlrtamrule", "valid": true, "self": { "rel": "self", "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "title": "sqlrtamrule", "id": "f8573cc2-e263-47f8-8ae3-9de8b58c7b44" }, "actions": [ { "rel": "update", "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createTemplate", "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "type": "POST", "title": "Create Template" } ], "acl": { "rel": "acl", "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "rules", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-08-19T11:15:11+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "drqlStatement": "when sqltopic with wsanalytic() as wsa != '1' then rtam_response with subject=\"${sqltopic.symbol} alert\", body=\"cxall returns ${wsa}\"", "drqlStatementEditable": null, "topics": [ { "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab", "title": "sqltopic", "objectType": "topics", "id": "13dcf0cf-4d29-434a-98ae-99dff34367ab" } ], "responses": [ { "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc", "title": "rtam_response", "objectType": "responses", "id": "a2e64636-5206-46da-abe9-4c9bb8b592bc" } ], "analytics": [ { "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156", "title": "wsanalytic", "objectType": "analytics", "id": "42d49371-55ee-45b4-bfff-46f35de9e156" } ], "multithreaded": true, "ruleType": "advanced", "drqlStatementFormatted": "when sqltopic with wsanalytic() as wsa != '1' then rtam_response with subject="${sqltopic.symbol} alert", body="cxall returns ${wsa}"" }, { "id": "a5046814-e355-4103-b885-71e2ac82ec4c", "name": "sqlrule", "valid": true, "self": { "rel": "self", "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c", "title": "sqlrule", "id": "a5046814-e355-4103-b885-71e2ac82ec4c" }, "actions": [ { "rel": "update", "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createTemplate", "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c", "type": "POST", "title": "Create Template" } ], "acl": { "rel": "acl", "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "rules", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-08-19T11:01:38+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "drqlStatement": "when 1 sqltopic then wsresponder_response", "drqlStatementEditable": null, "topics": [ { "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab", "title": "sqltopic", "objectType": "topics", "id": "13dcf0cf-4d29-434a-98ae-99dff34367ab" } ], "responses": [ { "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0", "title": "wsresponder_response", "objectType": "responses", "id": "f1fbf054-6124-4111-a69e-abe30586deb0" } ], "multithreaded": true, "ruleType": "advanced", "drqlStatementFormatted": "when 1 sqltopic then wsresponder_response" }, { "id": "9e212e7e-96e9-43f6-9725-57b3e3da4e23", "name": "filrule", "valid": true, "self": { "rel": "self", "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "title": "filrule", "id": "9e212e7e-96e9-43f6-9725-57b3e3da4e23" }, "actions": [ { "rel": "update", "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createTemplate", "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "type": "POST", "title": "Create Template" } ], "acl": { "rel": "acl", "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "rules", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-07-30T10:11:58+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "drqlStatement": "when 6 sqltopic with systimeanalytic() as mysystime then fileout_response with contents = \"Read 6 events at ${mysystime}\"", "drqlStatementEditable": null, "topics": [ { "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab", "title": "sqltopic", "objectType": "topics", "id": "13dcf0cf-4d29-434a-98ae-99dff34367ab" } ], "responses": [ { "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696", "title": "fileout_response", "objectType": "responses", "id": "8322f00d-6191-4932-a447-a090e03b5696" } ], "analytics": [ { "href": "api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175", "title": "systimeanalytic", "objectType": "analytics", "id": "d6a16480-2cd6-45bd-99a2-dd347def6175" } ], "multithreaded": true, "ruleType": "advanced", "drqlStatementFormatted": "when 6 sqltopic with systimeanalytic() as mysystime then fileout_response with contents = "Read 6 events at ${mysystime}"" } ] }
Response Code: 200 OK

GET Request in XML Format

Generate a GET request. For example, the following GET request retrieves rules in a RulePoint application:
GET http://localhost:8080/rulepoint/api/projects/1/rules Accept: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in XML Format

Returns the rule object and response code. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <artifacts> <links/> <valid>false</valid> <count>1</count> <items> <rule> <acl> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/deploy</href> <rel>deploy</rel> <title>Deploy</title> <type>POST</type> </action> <action> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44</href> <rel>createTemplate</rel> <title>Create Template</title> <type>POST</type> </action> </actions> <id>f8573cc2-e263-47f8-8ae3-9de8b58c7b44</id> <links/> <name>sqlrtamrule</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44</href> <id>f8573cc2-e263-47f8-8ae3-9de8b58c7b44</id> <rel>self</rel> <title>sqlrtamrule</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>rules</type> <analytics> <analytic> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156</href> <id>42d49371-55ee-45b4-bfff-46f35de9e156</id> <objectType>analytics</objectType> <title>wsanalytic</title> </analytic> </analytics> <drqlStatement>when sqltopic with wsanalytic() as wsa != '1' then rtam_response with subject="${sqltopic.symbol} alert", body="cxall returns ${wsa}"</drqlStatement> <drqlStatementFormatted>when sqltopic with wsanalytic() as wsa != '1' then rtam_response with subject="${sqltopic.symbol} alert", body="cxall returns ${wsa}"</drqlStatementFormatted> <multithreaded>true</multithreaded> <responses> <response> <href>api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc</href> <id>a2e64636-5206-46da-abe9-4c9bb8b592bc</id> <objectType>responses</objectType> <title>rtam_response</title> </response> </responses> <ruleType>advanced</ruleType> <topics> <href>api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab</href> <id>13dcf0cf-4d29-434a-98ae-99dff34367ab</id> <objectType>topics</objectType> <title>sqltopic</title> </topics> </rule> </items> <total>1</total> </artifacts>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!