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 JMS Responder

Update JMS Responder

Use the PUT method to update a JMS responder in RulePoint.

PUT Request in JSON Format

Generate a PUT request. For example, the following PUT request updates a JMS responder in a RulePoint application.
PUT http://localhost:8080/rulepoint/api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7 Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in JSON Format

{ "name": "ActiveMQResponder", "type": "responders", "responderType": "JMSResponder", "config": { "body": "test message", "retryCount": "3", "priority": "4", "retryDelay": "1000", "deliveryMode": "2", "params": null, "timeToLive": "0", "destination": "jmsQueue" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/894b2948-ce82-4e0a-9302-267d3482ae25", "title": "jmsconnection", "id": "894b2948-ce82-4e0a-9302-267d3482ae25" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }

PUT Response in JSON Format

Returns the JMS responder object and response code. Returns the error object if an error occurs.
{ "id": "ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7", "name": "ActiveMQResponder", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7", "title": "ActiveMQResponder", "id": "ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7", "type": "DELETE", "title": "Delete" }, { "rel": "deploy", "href": "api/projects/1/deploy", "type": "POST", "title": "Deploy" }, { "rel": "createResponse", "href": "api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-08-23T15:20:20+05:30", "createDate": "2013-08-23T15:20:14+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responderType": "JMSResponder", "responderTypeDisplayName": "JMS Responder", "config": { "body": "test message", "retryCount": "3", "priority": "4", "retryDelay": "1000", "deliveryMode": "2", "params": null, "timeToLive": "0", "destination": "jmsQueue" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/894b2948-ce82-4e0a-9302-267d3482ae25", "title": "jmsconnection", "id": "894b2948-ce82-4e0a-9302-267d3482ae25" }, "responses": [ { "href": "api/projects/1/responses/acb4152d-d034-468d-be96-d95178200755", "title": "jmsresponder_response", "objectType": "responses", "id": "acb4152d-d034-468d-be96-d95178200755" } ], "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }
Response Code : 200 OK

PUT Request in XML Format

Generate a PUT request. For example, the following PUT request updates a JMS responder in a RulePoint application.
PUT http://localhost:8080/rulepoint/api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7 Accept: application/xml Content-Type: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <responder> <name>ActiveMQResponder</name> <type>responders</type> <config> <entry> <key>body</key> <value>test message</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>priority</key> <value>4</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>deliveryMode</key> <value>2</value> </entry> <entry> <key>params</key> </entry> <entry> <key>timeToLive</key> <value>0</value> </entry> <entry> <key>destination</key> <value>jmsQueue</value> </entry> </config> <connection> <href>api/projects/1/connections/894b2948-ce82-4e0a-9302-267d3482ae25</href> <id>894b2948-ce82-4e0a-9302-267d3482ae25</id> <rel>connection</rel> <title>jmsconnection</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>JMSResponder</responderType> </responder>

PUT 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/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/deploy</href> <rel>deploy</rel> <title>Deploy</title> <type>POST</type> </action> <action> <href>api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</id> <links/> <name>jmsresponder</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</href> <id>ec9ba07c-7ac1-48b0-8b7d-ffcd35c1f8f7</id> <rel>self</rel> <title>jmsresponder</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>responders</type> <config> <entry> <key>body</key> <value>test message</value> </entry> <entry> <key>retryCount</key> <value>3</value> </entry> <entry> <key>priority</key> <value>4</value> </entry> <entry> <key>retryDelay</key> <value>1000</value> </entry> <entry> <key>deliveryMode</key> <value>2</value> </entry> <entry> <key>params</key> </entry> <entry> <key>timeToLive</key> <value>0</value> </entry> <entry> <key>destination</key> <value>jmsQueue</value> </entry> </config> <connection> <href>api/projects/1/connections/894b2948-ce82-4e0a-9302-267d3482ae25</href> <id>894b2948-ce82-4e0a-9302-267d3482ae25</id> <rel>connection</rel> <title>jmsconnection</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>JMSResponder</responderType> <responses /> <topics /> </responder>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!