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

Create SQL Response

Create SQL Response

Use the POST method to create an SQL response in RulePoint.

POST Request in JSON Format

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

POST Body in JSON Format

{ "name": "hotstockresponder_response", "type": "responses", "responseType": "SqlResponder", "responder": { "rel": "responder", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "title": "hotstockresponder", "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151" }, "config": { "sql": "insert into hot_stocks(symbol, price) values('INFA', 38.90)", "params": null } }

POST Response in JSON Format

Returns the SQL response object and response code. Returns the error object if an error occurs.
{ "id": "11780430-b441-4a03-9733-b2c429d15c45", "name": "hotstockresponder_response", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45", "title": "hotstockresponder_response", "id": "11780430-b441-4a03-9733-b2c429d15c45" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/11780430-b441-4a03-9733-b2c429d15c45/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-08-20T17:19:15+05:30", "createDate": "2013-08-20T17:19:15+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "SqlResponder", "responseTypeDisplayName": "SQL Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "title": "hotstockresponder", "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151" }, "multithreaded": false, "config": { "sql": "insert into hot_stocks(symbol, price) values('INFA', 38.90)", "params": null } }
Response Code: 201 Created

POST Request in XML Format

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

POST Body in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <name>hotstockresponder_response</name> <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> </response>

POST 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"?> <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>
Response Code : 201 Created

0 COMMENTS

We’d like to hear from you!