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 Analytics

Retrieve Analytics

Use the GET method to retrieve an analytic in RulePoint.

GET Request in JSON Format

To retrieve an analytic in a RulePoint application, generate the following GET request:
GET http://localhost:8080/rulepoint/api/projects/1/analytics Accept: application/json Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in JSON Format

{ "total": 2, "count": 2, "items": [ { "id": "42d49371-55ee-45b4-bfff-46f35de9e156", "name": "wsanalytic", "valid": true, "self": { "rel": "self", "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156", "title": "wsanalytic", "id": "42d49371-55ee-45b4-bfff-46f35de9e156" }, "actions": [ { "rel": "update", "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "analytics", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-08-19T11:12:30+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "connection": { "rel": "connection", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7", "title": "wsconn", "id": "03e9c236-1a01-40e2-9d4a-f13c893abef7" }, "analyticType": "webService", "analyticTypeDisplayName": "Webservice Analytic", "config": { "operation": "hello", "evaluationRequired": "true", "parameterList": "hello.name=bhui", "xpathExpr": "//return", "serviceName": "HelloWorldServices", "cacheDuration": "0" }, "rules": [ { "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "title": "sqlrtamrule", "objectType": "rules", "id": "f8573cc2-e263-47f8-8ae3-9de8b58c7b44" } ], "booleanAnalytic": false }, { "id": "d6a16480-2cd6-45bd-99a2-dd347def6175", "name": "systimeanalytic", "valid": true, "self": { "rel": "self", "href": "api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175", "title": "systimeanalytic", "id": "d6a16480-2cd6-45bd-99a2-dd347def6175" }, "actions": [ { "rel": "update", "href": "api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "analytics", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-07-30T10:10:21+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "analyticType": "systimeanalytic", "analyticTypeDisplayName": "System Time Analytic", "config": { "evaluationRequired": "false", "cacheDuration": "0" }, "rules": [ { "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "title": "filrule", "objectType": "rules", "id": "9e212e7e-96e9-43f6-9725-57b3e3da4e23" } ], "booleanAnalytic": true } ] }
Response Code: 200 OK

GET Request in XML Format

GET http://localhost:8080/rulepoint/api/projects/1/analytics Accept: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in XML Format

Returns the analytic 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>2</count> <items> <analytic> <acl> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>42d49371-55ee-45b4-bfff-46f35de9e156</id> <links/> <name>wsanalytic</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156</href> <id>42d49371-55ee-45b4-bfff-46f35de9e156</id> <rel>self</rel> <title>wsanalytic</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>analytics</type> <analyticType>webService</analyticType> <analyticTypeDisplayName>Webservice Analytic</analyticTypeDisplayName> <booleanAnalytic>false</booleanAnalytic> <config> <entry> <key>operation</key> <value>hello</value> </entry> <entry> <key>evaluationRequired</key> <value>true</value> </entry> <entry> <key>parameterList</key> <value>hello.name=bhui</value> </entry> <entry> <key>xpathExpr</key> <value>//return</value> </entry> <entry> <key>serviceName</key> <value>HelloWorldServices</value> </entry> <entry> <key>cacheDuration</key> <value>0</value> </entry> </config> <connection> <href>api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7</href> <id>03e9c236-1a01-40e2-9d4a-f13c893abef7</id> <rel>connection</rel> <title>wsconn</title> </connection> <rules> <rule> <href>api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44</href> <id>f8573cc2-e263-47f8-8ae3-9de8b58c7b44</id> <objectType>rules</objectType> <title>sqlrtamrule</title> </rule> </rules> </analytic> <analytic> <acl> <href>api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>d6a16480-2cd6-45bd-99a2-dd347def6175</id> <links/> <name>systimeanalytic</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/analytics/d6a16480-2cd6-45bd-99a2-dd347def6175</href> <id>d6a16480-2cd6-45bd-99a2-dd347def6175</id> <rel>self</rel> <title>systimeanalytic</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>analytics</type> <analyticType>systimeanalytic</analyticType> <analyticTypeDisplayName>System Time Analytic</analyticTypeDisplayName> <booleanAnalytic>true</booleanAnalytic> <config> <entry> <key>evaluationRequired</key> <value>false</value> </entry> <entry> <key>cacheDuration</key> <value>0</value> </entry> </config> <rules> <rule> <href>api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23</href> <id>9e212e7e-96e9-43f6-9725-57b3e3da4e23</id> <objectType>rules</objectType> <title>filrule</title> </rule> </rules> </analytic> </items> <total>2</total> </artifacts>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!