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

Object IDs

Object IDs

All requests require an object ID. To find the object ID that you need, you can use the related GET request.
For example, to get a specific topic ID, do a GET on /topics, which lists all the topics in the project. Iterate over the list of topics that is returned by the previous rest call to get the ID of the topic by the given name.
GET http://localhost:8080/rulepoint/api/projects/1/topics Request Headers: Accept: application/json Cookie: JSESSIONID=FCE43E371AD49777802233A87654A076 Response Headers: Content-Type: application/json Date: Wed, 07 Aug 2013 05:37:18 GMT
{ "total": 3, "count": 3, "items": [ { "id": "13dcf0cf-4d29-434a-98ae-99dff34367ab", "name": "sqltopic", "valid": true, "self": { "rel": "self", "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab", "title": "sqltopic", "id": "13dcf0cf-4d29-434a-98ae-99dff34367ab" }, "actions": [ { "rel": "update", "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab", "type": "PUT", "title": "Edit" } ], "acl": { "rel": "acl", "href": "api/projects/1/topics/13dcf0cf-4d29-434a-98ae-99dff34367ab/acl", "title": "acl" }, "links": {}, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "topics", "lastModifiedDate": "2013-08-06T16:05:01+05:30", "createDate": "2013-07-30T10:08:21+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DEPLOYED", "force": false, "expiresIn": 600000, "responderAccess": "ALL_PROPERTIES", "properties": [], "rules": [ { "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "title": "filrule", "objectType": "rules", "id": "9e212e7e-96e9-43f6-9725-57b3e3da4e23" } ], "sources": [ { "href": "api/projects/1/sources/daf6350b-99cb-49e7-b69a-a1ea801e32a0", "title": "invalidsrc", "objectType": "sources", "id": "daf6350b-99cb-49e7-b69a-a1ea801e32a0" }, { "href": "api/projects/1/sources/01eec793-87aa-44fe-a12d-ee3b98e0e71d", "title": "sqlsrc1", "objectType": "sources", "id": "01eec793-87aa-44fe-a12d-ee3b98e0e71d" }, { "href": "api/projects/1/sources/ba80a9f1-f0a2-4600-986a-40ecc7a1c832", "title": "invalidsrc2", "objectType": "sources", "id": "ba80a9f1-f0a2-4600-986a-40ecc7a1c832" } ], "responders": [], "templates": [] }, { "id": "8ad3c733-5e7e-4908-b449-951edfbb9e2b", "name": "rsstopic", "valid": true, "self": { "rel": "self", "href": "api/projects/1/topics/8ad3c733-5e7e-4908-b449-951edfbb9e2b", "title": "rsstopic", "id": "8ad3c733-5e7e-4908-b449-951edfbb9e2b" }, "actions": [ { "rel": "update", "href": "api/projects/1/topics/8ad3c733-5e7e-4908-b449-951edfbb9e2b", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/topics/8ad3c733-5e7e-4908-b449-951edfbb9e2b", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/topics/8ad3c733-5e7e-4908-b449-951edfbb9e2b/acl", "title": "acl" }, "links": {}, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "topics", "lastModifiedDate": "2013-08-05T10:15:23+05:30", "createDate": "2013-08-05T10:08:44+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "expiresIn": 600000, "responderAccess": "ALL_PROPERTIES", "properties": [], "rules": [], "sources": [ { "href": "api/projects/1/sources/d5114508-ddd1-4d9a-ba2e-2a338325b9ed", "title": "rss_src", "objectType": "sources", "id": "d5114508-ddd1-4d9a-ba2e-2a338325b9ed" } ], "responders": [], "templates": [] }, { "id": "5d704d59-e1d4-452c-9663-6eb1890ff159", "name": "system_markers", "valid": true, "self": { "rel": "self", "href": "api/projects/1/topics/5d704d59-e1d4-452c-9663-6eb1890ff159", "title": "system_markers", "id": "5d704d59-e1d4-452c-9663-6eb1890ff159" }, "actions": [], "acl": { "rel": "acl", "href": "api/projects/1/topics/5d704d59-e1d4-452c-9663-6eb1890ff159/acl", "title": "acl" }, "links": {}, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "topics", "lastModifiedDate": "2013-07-30T06:38:20+05:30", "createDate": "2013-07-30T06:38:20+05:30", "createdBy": "Administrator", "predefined": true, "deployable": true, "deployState": "DRAFT", "force": false, "expiresIn": 36000, "responderAccess": "NAMED_PROPERTIES", "properties": [ { "name": "begin_time", "description": "Time (since epoch in milliseconds) when marker begin is produced by engine", "status": "ACTIVE", "order": 0 }, { "name": "end_time", "description": "Time (since epoch in milliseconds) when marker end is produced by engine", "status": "ACTIVE", "order": 1 }, { "name": "engine_name", "description": "Name of the engine that produce the marker begin end events", "status": "ACTIVE", "order": 2 }, { "name": "event_count", "description": "Value of event count is string form of integer", "status": "ACTIVE", "order": 3 }, { "name": "hit_ratio", "description": "Ratio of number of events in marker boundary that participated in activations and EVENTS_COUNT", "status": "ACTIVE", "order": 4 }, { "name": "marker_name", "description": "marker_name", "status": "ACTIVE", "order": 5 }, { "name": "marker_type", "description": "value is either begin or end", "status": "ACTIVE", "order": 6 }, { "name": "rule_activation_count", "description": "Total number of activations in which event within marker boundary participated", "status": "ACTIVE", "order": 7 }, { "name": "rules_processed", "description": "Comma separated list of all rules that processed events received in the marker boundary", "status": "ACTIVE", "order": 8 }, { "name": "source_list", "description": "Comma separated list of sources that produced marker events", "status": "ACTIVE", "order": 9 }, { "name": "total_processing_time", "description": "Total processing time (in milliseconds) of all events in the marker boundary", "status": "ACTIVE", "order": 10 } ], "rules": [], "sources": [], "responders": [], "templates": [] } ] }

0 COMMENTS

We’d like to hear from you!