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 Connection

Retrieve SQL Connection

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

GET Request in JSON Format

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

GET Response in JSON Format

{ "total": 4, "count": 4, "items": [ { "id": "2d5c8d79-b732-4fe8-ad69-3243d102ed49", "name": "sqlconnection", "valid": true, "self": { "rel": "self", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49", "title": "sqlconnection", "id": "2d5c8d79-b732-4fe8-ad69-3243d102ed49" }, "actions": [ { "rel": "update", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "connections", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-07-30T10:09:20+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "connectionType": "jdbcConnection", "connectionTypeDisplayName": "SQL Connection", "config": { "acquireRetryAttempts": "0", "acquireRetryDelay": "5000", "jdbcString": "jdbc:oracle:thin:@invr28cep46:1521:orcl", "maxIdleTime": "36000", "acquireIncrement": "1", "checkoutTimeout": "2000", "password": "cep_ci_secret", "username": "cep_ci_user", "maxPoolSize": "5", "retryCount": "3", "retryDelay": "1000", "minPoolSize": "1", "driverClass": "oracle.MyDriver", "initialPoolSize": "1", "loginTimeOut": "3" }, "sources": [ { "href": "api/projects/1/sources/daf6350b-99cb-49e7-b69a-a1ea801e32a0", "title": "invalidsrc", "objectType": "sources", "id": "daf6350b-99cb-49e7-b69a-a1ea801e32a0" }, { "href": "api/projects/1/sources/01eec793-87aa-44fe-a12d-ee3b98e0e71d", "title": "sqlsrc1", "objectType": "sources", "id": "01eec793-87aa-44fe-a12d-ee3b98e0e71d" } ], "responders": [ { "href": "api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151", "title": "sqlresponder", "objectType": "responders", "id": "8bd61211-404b-4cd4-8a84-f36a7bcdf151" } ] }, { "id": "03e9c236-1a01-40e2-9d4a-f13c893abef7", "name": "wsconn", "valid": true, "self": { "rel": "self", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7", "title": "wsconn", "id": "03e9c236-1a01-40e2-9d4a-f13c893abef7" }, "actions": [ { "rel": "update", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "connections", "lastModifiedDate": "2013-08-19T11:21:03+05:30", "createDate": "2013-08-19T09:22:55+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "connectionType": "wsConnection", "connectionTypeDisplayName": "Web Service Connection", "config": { "userNameSpace": "", "retryCount": "3", "retryDelay": "1000", "password": null, "wsdlDuration": "0", "url": "http://invr28cep46:8080/CepQeWebServices/HelloWorldService?wsdl", "loginName": "" }, "sources": [ { "href": "api/projects/1/sources/09c059f8-f304-41dd-8e1b-fa5a538a74c4", "title": "wssrc", "objectType": "sources", "id": "09c059f8-f304-41dd-8e1b-fa5a538a74c4" } ], "analytics": [ { "href": "api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156", "title": "wsanalytic", "objectType": "analytics", "id": "42d49371-55ee-45b4-bfff-46f35de9e156" } ], "responders": [ { "href": "api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c", "title": "wsresponder", "objectType": "responders", "id": "08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c" } ] }, { "id": "b53a6fc3-a885-4da9-b30e-a40e96208ee9", "name": "invalidsqlconn", "valid": true, "self": { "rel": "self", "href": "api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9", "title": "invalidsqlconn", "id": "b53a6fc3-a885-4da9-b30e-a40e96208ee9" }, "actions": [ { "rel": "update", "href": "api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "connections", "lastModifiedDate": "2013-08-13T10:38:12+05:30", "createDate": "2013-08-06T16:04:07+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "connectionType": "jdbcConnection", "connectionTypeDisplayName": "SQL Connection", "config": { "acquireRetryAttempts": "0", "acquireRetryDelay": "5000", "jdbcString": "jdbc:oracle:thin:@invr28cep46:1521:orcl", "maxIdleTime": "36000", "acquireIncrement": "1", "checkoutTimeout": "2000", "password": "cep_ci_secret", "username": "cep_ci_user", "maxPoolSize": "5", "retryCount": "3", "retryDelay": "1000", "minPoolSize": "1", "driverClass": "oracledriver", "initialPoolSize": "1", "loginTimeOut": "3" }, "sources": [ { "href": "api/projects/1/sources/ba80a9f1-f0a2-4600-986a-40ecc7a1c832", "title": "invalidsrc2", "objectType": "sources", "id": "ba80a9f1-f0a2-4600-986a-40ecc7a1c832" } ] }, { "id": "bba20936-201a-4d3c-afad-33c76fb9366b", "name": "emailcon", "valid": true, "self": { "rel": "self", "href": "api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b", "title": "emailcon", "id": "bba20936-201a-4d3c-afad-33c76fb9366b" }, "actions": [ { "rel": "update", "href": "api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "connections", "lastModifiedDate": "2013-08-07T17:49:28+05:30", "createDate": "2013-08-07T17:49:28+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "connectionType": "emailConnection", "connectionTypeDisplayName": "Email Connection", "config": { "port": "25", "username": "", "retryCount": "3", "retryDelay": "1000", "server": "ma", "password": null }, "responders": [ { "href": "api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3", "title": "emailresponder", "objectType": "responders", "id": "51ba1457-5112-4e70-99f1-fe94af5ddea3" } ] } ] }
Response Code : 200 OK

GET Request in XML Format

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

GET Response in XML Format

Returns the SQL connection 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>4</count> <items> <connection> <acl> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>2d5c8d79-b732-4fe8-ad69-3243d102ed49</id> <links/> <name>sqlconnection</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/connections/2d5c8d79-b732-4fe8-ad69-3243d102ed49</href> <id>2d5c8d79-b732-4fe8-ad69-3243d102ed49</id> <rel>self</rel> <title>sqlconnection</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>connections</type> <config> <entry> <key>acquireRetryAttempts</key> <value>0</value> </entry> <entry> <key>acquireRetryDelay</key> <value>5000</value> </entry> <entry> <key>jdbcString</key> <value>jdbc:oracle:thin:@invr28cep46:1521:orcl</value> </entry> <entry> <key>maxIdleTime</key> <value>36000</value> </entry> <entry> <key>acquireIncrement</key> <value>1</value> </entry> <entry> <key>checkoutTimeout</key> <value>2000</value> </entry> <entry> <key>password</key> <value>cep_ci_secret</value> </entry> <entry> <key>username</key> <value>cep_ci_user</value> </entry> <entry> <key>maxPoolSize</key> <value>5</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>minPoolSize</key> <value>1</value> </entry> <entry> <key>driverClass</key> <value>oracle.MyDriver</value> </entry> <entry> <key>initialPoolSize</key> <value>1</value> </entry> <entry> <key>loginTimeOut</key> <value>3</value> </entry> </config> <connectionType>jdbcConnection</connectionType> <connectionTypeDisplayName>SQL Connection</connectionTypeDisplayName> <responders> <href>api/projects/1/responders/8bd61211-404b-4cd4-8a84-f36a7bcdf151</href> <id>8bd61211-404b-4cd4-8a84-f36a7bcdf151</id> <objectType>responders</objectType> <title>sqlresponder</title> </responders> <sources> <href>api/projects/1/sources/daf6350b-99cb-49e7-b69a-a1ea801e32a0</href> <id>daf6350b-99cb-49e7-b69a-a1ea801e32a0</id> <objectType>sources</objectType> <title>invalidsrc</title> </sources> <sources> <href>api/projects/1/sources/01eec793-87aa-44fe-a12d-ee3b98e0e71d</href> <id>01eec793-87aa-44fe-a12d-ee3b98e0e71d</id> <objectType>sources</objectType> <title>sqlsrc1</title> </sources> </connection> <connection> <acl> <href>api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>03e9c236-1a01-40e2-9d4a-f13c893abef7</id> <links/> <name>wsconn</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/connections/03e9c236-1a01-40e2-9d4a-f13c893abef7</href> <id>03e9c236-1a01-40e2-9d4a-f13c893abef7</id> <rel>self</rel> <title>wsconn</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>connections</type> <analytics> <href>api/projects/1/analytics/42d49371-55ee-45b4-bfff-46f35de9e156</href> <id>42d49371-55ee-45b4-bfff-46f35de9e156</id> <objectType>analytics</objectType> <title>wsanalytic</title> </analytics> <config> <entry> <key>userNameSpace</key> <value/> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>password</key> </entry> <entry> <key>wsdlDuration</key> <value>0</value> </entry> <entry> <key>url</key> <value>http://invr28cep46:8080/CepQeWebServices/HelloWorldService?wsdl</value> </entry> <entry> <key>loginName</key> <value/> </entry> </config> <connectionType>wsConnection</connectionType> <connectionTypeDisplayName>Web Service Connection</connectionTypeDisplayName> <responders> <href>api/projects/1/responders/08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c</href> <id>08ff3fdc-85f3-4bd2-8cd8-06442d7eae0c</id> <objectType>responders</objectType> <title>wsresponder</title> </responders> <sources> <href>api/projects/1/sources/09c059f8-f304-41dd-8e1b-fa5a538a74c4</href> <id>09c059f8-f304-41dd-8e1b-fa5a538a74c4</id> <objectType>sources</objectType> <title>wssrc</title> </sources> </connection> <connection> <acl> <href>api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>b53a6fc3-a885-4da9-b30e-a40e96208ee9</id> <links/> <name>invalidsqlconn</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/connections/b53a6fc3-a885-4da9-b30e-a40e96208ee9</href> <id>b53a6fc3-a885-4da9-b30e-a40e96208ee9</id> <rel>self</rel> <title>invalidsqlconn</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>connections</type> <config> <entry> <key>acquireRetryAttempts</key> <value>0</value> </entry> <entry> <key>acquireRetryDelay</key> <value>5000</value> </entry> <entry> <key>jdbcString</key> <value>jdbc:oracle:thin:@invr28cep46:1521:orcl</value> </entry> <entry> <key>maxIdleTime</key> <value>36000</value> </entry> <entry> <key>acquireIncrement</key> <value>1</value> </entry> <entry> <key>checkoutTimeout</key> <value>2000</value> </entry> <entry> <key>password</key> <value>cep_ci_secret</value> </entry> <entry> <key>username</key> <value>cep_ci_user</value> </entry> <entry> <key>maxPoolSize</key> <value>5</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>minPoolSize</key> <value>1</value> </entry> <entry> <key>driverClass</key> <value>oracledriver</value> </entry> <entry> <key>initialPoolSize</key> <value>1</value> </entry> <entry> <key>loginTimeOut</key> <value>3</value> </entry> </config> <connectionType>jdbcConnection</connectionType> <connectionTypeDisplayName>SQL Connection</connectionTypeDisplayName> <sources> <href>api/projects/1/sources/ba80a9f1-f0a2-4600-986a-40ecc7a1c832</href> <id>ba80a9f1-f0a2-4600-986a-40ecc7a1c832</id> <objectType>sources</objectType> <title>invalidsrc2</title> </sources> </connection> <connection> <acl> <href>api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>bba20936-201a-4d3c-afad-33c76fb9366b</id> <links/> <name>emailcon</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/connections/bba20936-201a-4d3c-afad-33c76fb9366b</href> <id>bba20936-201a-4d3c-afad-33c76fb9366b</id> <rel>self</rel> <title>emailcon</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>connections</type> <config> <entry> <key>port</key> <value>25</value> </entry> <entry> <key>username</key> <value/> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>server</key> <value>ma</value> </entry> <entry> <key>password</key> </entry> </config> <connectionType>emailConnection</connectionType> <connectionTypeDisplayName>Email Connection</connectionTypeDisplayName> <responders> <href>api/projects/1/responders/51ba1457-5112-4e70-99f1-fe94af5ddea3</href> <id>51ba1457-5112-4e70-99f1-fe94af5ddea3</id> <objectType>responders</objectType> <title>emailresponder</title> </responders> </connection> </items> <total>4</total> <invalidCount>0</invalidCount> </artifacts>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!