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 SQL Response

Retrieve SQL Response

Use the GET method to retrieve an SQL response in RulePoint.

GET Request in JSON Format

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

GET Response in JSON Format

{ "total": 3, "count": 3, "items": [ { "id": "a2e64636-5206-46da-abe9-4c9bb8b592bc", "name": "rtam_response", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc", "title": "rtam_response", "id": "a2e64636-5206-46da-abe9-4c9bb8b592bc" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-08-19T11:12:55+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "RTAMResponder", "responseTypeDisplayName": "RTAM Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "title": "rtam", "id": "c4851206-93e0-45ee-a013-3fb1d2fc5c5d" }, "multithreaded": false, "rules": [ { "href": "api/projects/1/rules/f8573cc2-e263-47f8-8ae3-9de8b58c7b44", "title": "sqlrtamrule", "objectType": "rules", "id": "f8573cc2-e263-47f8-8ae3-9de8b58c7b44" } ], "config": { "to": "Administrator", "body": "re", "subject": "re", "priority": "3", "channels": "", "header": "", "actions": "", "groups": "", "metadata": null } }, { "id": "f1fbf054-6124-4111-a69e-abe30586deb0", "name": "wsresponder_response", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0", "title": "wsresponder_response", "id": "f1fbf054-6124-4111-a69e-abe30586deb0" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-08-19T11:00:58+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "webService", "responseTypeDisplayName": "Web Service Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "title": "wsresponder", "id": "08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c" }, "multithreaded": false, "rules": [ { "href": "api/projects/1/rules/a5046814-e355-4103-b885-71e2ac82ec4c", "title": "sqlrule", "objectType": "rules", "id": "a5046814-e355-4103-b885-71e2ac82ec4c" } ], "config": { "operation": "hello", "inputParameters": "hello.name=x; =901", "serviceName": "HelloWorldServices" } }, { "id": "8322f00d-6191-4932-a447-a090e03b5696", "name": "fileout_response", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696", "title": "fileout_response", "id": "8322f00d-6191-4932-a447-a090e03b5696" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-07-30T10:10:59+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "fileOutput", "responseTypeDisplayName": "File Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249", "title": "fileout", "id": "73876991-1dc2-47e6-ae1f-56347427a249" }, "multithreaded": false, "rules": [ { "href": "api/projects/1/rules/9e212e7e-96e9-43f6-9725-57b3e3da4e23", "title": "filrule", "objectType": "rules", "id": "9e212e7e-96e9-43f6-9725-57b3e3da4e23" } ], "config": { "contents": "nest", "filename": "best", "mode": "append" } } ] }
Response Code: 200 OK

GET Request in XML Format

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

GET Response in XML Format

Returns the SQL response object and response code. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <artifacts> <count>1</count> <items> <response> <acl> <href>api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>11780430-b441-4a03-9733-b2c429d15c45</id> <links/> <name>hotstockresponder_response</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45</href> <id>11780430-b441-4a03-9733-b2c429d15c45</id> <rel>self</rel> <title>hotstockresponder_response</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>responses</type> <config> <entry> <key>sql</key> <value>insert into hot_stocks(symbol, price) values('INFA', 38.90)</value> </entry> <entry> <key>params</key> </entry> </config> <multithreaded>false</multithreaded> <responder> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <id>8bd61211-404b-4cd4-8a84-f36a7bcdf151</id> <rel>responder</rel> <title>hotstockresponder</title> </responder> <responseType>SqlResponder</responseType> <responseTypeDisplayName>SQL Responder</responseTypeDisplayName> <rules /> <templates /> </response> </items> <total>1</total> <invalidCount>0</invalidCount> </artifacts>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!