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 Responder

Create SQL Responder

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

POST Request in JSON Format

To create an SQL responder in a RulePoint application, generate the following POST request:
POST http://localhost:8080/rulepoint/api/projects/1/responders Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

POST Body in JSON Format

Returns the SQL responder object and response code 201 OK. Returns the error object if an error occurs.
{ "name": "mysqlresponder", "type": "responders", "responderType": "SqlResponder", "responderTypeDisplayName": "SQL Responder", "config": { "sql": "insert into hot_stocks(symbol, price) values('INFA', 38.90)", "params": null }, "connection": { "rel": "connection", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49", "title": "sqlconnection", "id": "2d5c8d79-b732-4fe8-ad69-3243d102ed49" } }

POST Response in JSON Format

{ "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151", "name": "mysqlresponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "title": "mysqlresponder", "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-13T12:15:01+05:30", "createDate": "2013-08-13T12:15:01+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "SqlResponder", "responderTypeDisplayName": "SQL Responder", "config": { "sql": "insert into hot_stock(symbol, price) values ('INFA', 38.90)", "params": null }, "connection": { "rel": "connection", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49", "title": "sqlconnection", "id": "2d5c8d79-b732-4fe8-ad69-3243d102ed49" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }
Response Code : 201 Created

POST Request in XML Format

POST http://localhost:8080/rulepoint/api/projects/1/responders 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"?> <responder> <name>mysqlresponder</name> <type>responders</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> <connection> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49</href> <id>2d5c8d79-b732-4fe8-ad69-3243d102ed49</id> <rel>connection</rel> <title>sqlconnection</title> </connection> <responderType>SqlResponder</responderType> </responder>

POST Response in XML Format

Returns the SQL responder object and response code. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <responder> <acl> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>8bd61211-404b-4cd4-8a84-f36a7bcdf151</id> <links/> <name>mysqlresponder</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <id>8bd61211-404b-4cd4-8a84-f36a7bcdf151</id> <rel>self</rel> <title>mysqlresponder</title> </self> <valid>false</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <dtError>There are no responses associated with this Responder</dtError> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>responders</type> <config> <entry> <key>sql</key> <value>insert into hot_stock(symbol, price) values ('INFA', 38.90)</value> </entry> <entry> <key>params</key> </entry> </config> <connection> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49</href> <id>2d5c8d79-b732-4fe8-ad69-3243d102ed49</id> <rel>connection</rel> <title>sqlconnection</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>SqlResponder</responderType> <responderTypeDisplayName>SQL Responder</responderTypeDisplayName> <responses /> <topics /> </responder>
Response Code : 201 Created

0 COMMENTS

We’d like to hear from you!