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

Update SQL Connection

Update SQL Connection

Use the PUT method to update an SQL connection in RulePoint.

PUT Request in JSON Format

Generate a PUT request. For example, the following PUT request updates an SQL connection in a RulePoint application:
PUT http://localhost:8080/rulepoint/api/projects/3/connections/1d559d37-2c6e-48c0-8623-c571339c1e99 Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in JSON Format

Returns the SQL connection object and response code 200 OK. Returns the error object if an error occurs.
{ "name": "DBConnection", "type": "connections", "description": "A SQL Connection", "connectionType": "jdbcConnection", "config": { "driverClass": "oracle.jdbc.OracleDriver", "jdbcString": "jdbc:oracle:thin:@invr28cep46:1521:ORCL", "username": "cep_ci_user", "password": "cep_ci_secret", "initialPoolSize": "5", "acquireIncrement": "1", "maxPoolSize": "10", "minPoolSize": "2", "loginTimeOut": "5000", "retryCount": "3", "retryDelay": "1000", "maxIdleTime": "36000", "acquireRetryAttempts": "0", "acquireRetryDelay": "5000", "checkoutTimeout": "2000" } }

PUT Response in JSON Format

{ "id": "1d559d37-2c6e-48c0-8623-c571339c1e99", "name": "DBConnection", "valid": true, "self": { "rel": "self", "href": "api/projects/4/connections/1d559d37-2c6e-48c0-8623-c571339c1e99", "title": "DBConnection", "id": "1d559d37-2c6e-48c0-8623-c571339c1e99" }, "actions": [ { "rel": "update", "href": "api/projects/4/connections/1d559d37-2c6e-48c0-8623-c571339c1e99", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/4/connections/1d559d37-2c6e-48c0-8623-c571339c1e99", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/4/connections/1d559d37-2c6e-48c0-8623-c571339c1e99/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/4", "title": "RT_TestProject1", "id": "4" }, "description": "A SQL Connection", "type": "connections", "lastModifiedDate": "2013-07-30T06:39:49+05:30", "createDate": "2013-07-30T06:39:49+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": "10", "retryCount": "3", "retryDelay": "1000", "minPoolSize": "2", "driverClass": "oracle.jdbc.OracleDriver", "initialPoolSize": "5", "loginTimeOut": "5000" } }
Response Code : 200 OK

PUT Body in XML Format

Generate a PUT request. For example, the following PUT request updates an SQL connection in a RulePoint application:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <connection> <name>DBConnection</name> <type>connections</type> <description>A SQL Connection</description> <connectionType>jdbcConnection</connectionType> <config> <entry> <key>driverClass</key> <value>oracle.jdbc.OracleDriver</value> </entry> <entry> <key>jdbcString</key> <value>jdbc:oracle:thin:@invr28cep46:1521:ORCL</value> </entry> <entry> <key>username</key> <value>cep_ci_user</value> </entry> <entry> <key>password</key> <value>cep_ci_secret</value> </entry> <entry> <key>acquireIncrement</key> <value>1</value> </entry> <entry> <key>acquireRetryAttempts</key> <value>0</value> </entry> <entry> <key>acquireRetryDelay</key> <value>5000</value> </entry> <entry> <key>checkoutTimeout</key> <value>2000</value> </entry> <entry> <key>initialPoolSize</key> <value>5</value> </entry> <entry> <key>loginTimeout</key> <value>5000</value> </entry> <entry> <key>maxIdleTime</key> <value>36000</value> </entry> <entry> <key>maxPoolSize</key> <value>10</value> </entry> <entry> <key>minPoolSize</key> <value>2</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> </config> </connection>

PUT 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"?> <connection> <acl> <href>api/projects/98315/connections/1e5d5c0e-11ec-4c90-a5d9-25991b38befe/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/98315/connections/1e5d5c0e-11ec-4c90-a5d9-25991b38befe</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/98315/connections/1e5d5c0e-11ec-4c90-a5d9-25991b38befe</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>1e5d5c0e-11ec-4c90-a5d9-25991b38befe</id> <links/> <name>DBConnection</name> <owningProject> <href>api/projects/98315</href> <id>98315</id> <rel>owningProject</rel> <title>RT_TestProject1</title> </owningProject> <self> <href>api/projects/98315/connections/1e5d5c0e-11ec-4c90-a5d9-25991b38befe</href> <id>1e5d5c0e-11ec-4c90-a5d9-25991b38befe</id> <rel>self</rel> <title>DBConnection</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <description>A SQL Connection</description> <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>10</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>minPoolSize</key> <value>2</value> </entry> <entry> <key>driverClass</key> <value>oracle.jdbc.OracleDriver</value> </entry> <entry> <key>initialPoolSize</key> <value>5</value> </entry> <entry> <key>loginTimeOut</key> <value>3</value> </entry> </config> <connectionType>jdbcConnection</connectionType> <connectionTypeDisplayName>SQL Connection</connectionTypeDisplayName> </connection>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!