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 Responder

Retrieve SQL Responder

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

GET Request in JSON Format

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

GET Response in JSON Format

{ "total": 6, "count": 6, "items": [ { "id": "c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "name": "rtam", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "title": "rtam", "id": "c4851206-93e0-45ee-a013-3fb1d2fc5c5d" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createResponse", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/c4851206-93e0-45ee-a013-3fb1d2fc5c5d/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-08-07T17:50:59+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responderType": "RTAMResponder", "responderTypeDisplayName": "RTAM Responder", "config": { "to": "e", "body": "re", "subject": "re", "priority": "3", "channels": "", "header": "", "actions": "", "groups": "", "metadata": null }, "responses": [ { "href": "api/projects/1/responses/a2e64636-5206-46da-abe9-4c9bb8b592bc", "title": "rtam_response", "objectType": "responses", "id": "a2e64636-5206-46da-abe9-4c9bb8b592bc" } ], "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }, { "id": "08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "name": "wsresponder", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "title": "wsresponder", "id": "08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createResponse", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-19T11:10:52+05:30", "createDate": "2013-08-19T10:59:14+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responderType": "webService", "responderTypeDisplayName": "Web Service Responder", "config": { "operation": "hello", "inputParameters": "hello.name=xkjhkj", "serviceName": "HelloWorldServices" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7", "title": "wsconn", "id": "03e9c236-1a01-40e2-9d4a-f13c893abef7" }, "responses": [ { "href": "api/projects/1/responses/f1fbf054-6124-4111-a69e-abe30586deb0", "title": "wsresponder_response", "objectType": "responses", "id": "f1fbf054-6124-4111-a69e-abe30586deb0" } ], "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }, { "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151", "name": "sqlresponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "title": "sqlresponder", "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 something", "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 } }, { "id": "51ba1457-5112-4e70-99f1-fe94af5ddea3", "name": "emailresponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3", "title": "emailresponder", "id": "51ba1457-5112-4e70-99f1-fe94af5ddea3" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-07T17:49:48+05:30", "createDate": "2013-08-07T17:49:48+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "EmailResponder", "responderTypeDisplayName": "Email Responder", "config": { "to": "ad", "body": "dsw", "replyTo": "", "subject": "ds", "sentDate": null, "bcc": "", "from": "ew", "contentType": "text", "cc": "" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b", "title": "emailcon", "id": "bba20936-201a-4d3c-afad-33c76fb9366b" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }, { "id": "2a1efc67-29fc-4a57-90c8-896867802c73", "name": "another", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/2a1efc67-29fc-4a57-90c8-896867802c73", "title": "another", "id": "2a1efc67-29fc-4a57-90c8-896867802c73" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/2a1efc67-29fc-4a57-90c8-896867802c73", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/2a1efc67-29fc-4a57-90c8-896867802c73", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/2a1efc67-29fc-4a57-90c8-896867802c73", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/2a1efc67-29fc-4a57-90c8-896867802c73/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-07T16:55:39+05:30", "createDate": "2013-08-07T16:55:39+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "http", "responderTypeDisplayName": "HTTP Responder", "config": { "body": "", "username": "", "retryCount": "3", "retryDelay": "1000", "targeturl": "http://invr28cep46:8080/", "method": "GET", "parameters": null, "password": null, "mimeType": "" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }, { "id": "73876991-1dc2-47e6-ae1f-56347427a249", "name": "fileout", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249", "title": "fileout", "id": "73876991-1dc2-47e6-ae1f-56347427a249" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createResponse", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/73876991-1dc2-47e6-ae1f-56347427a249/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-07-30T10:14:46+05:30", "createDate": "2013-07-30T10:10:49+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responderType": "fileOutput", "responderTypeDisplayName": "File Responder", "config": { "contents": "nest", "filename": "best", "mode": "append" }, "responses": [ { "href": "api/projects/1/responses/8322f00d-6191-4932-a447-a090e03b5696", "title": "fileout_response", "objectType": "responses", "id": "8322f00d-6191-4932-a447-a090e03b5696" } ], "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } } ] }
Response Code : 200 OK

GET Request in XML Format

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

GET Body in XML Format

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

GET 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"?> <artifacts> <count>1</count> <items> <responder> <acl> <href>api/projects/1/responders/c4befa65-dd03-4213-96fc-3cbc71e74211/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/c4befa65-dd03-4213-96fc-3cbc71e74211</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/c4befa65-dd03-4213-96fc-3cbc71e74211</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/c4befa65-dd03-4213-96fc-3cbc71e74211</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>c4befa65-dd03-4213-96fc-3cbc71e74211</id> <name>sqlresponder</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/c4befa65-dd03-4213-96fc-3cbc71e74211</href> <id>c4befa65-dd03-4213-96fc-3cbc71e74211</id> <rel>self</rel> <title>sqlresponder</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 something</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> </responder> </items> <total>1</total> <invalidCount>1</invalidCount> </artifacts>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!