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 Web Service Responder

Update Web Service Responder

Use the PUT method to update a web service responder in RulePoint.

PUT Request in JSON Format

To update a web service responder in a RulePoint application, generate the following PUT request:
PUT http://localhost:8080/rulepoint/api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01 Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in JSON Format

{ "name": "MyWebServiceResponder", "responderType": "webService", "connection": { "rel": "connection", "href": "api/projects/1/connections/e9bcc9ae-8e78-4b2c-a3f4-48352e817052", "title": "WsConnection1", "id": "e9bcc9ae-8e78-4b2c-a3f4-48352e817052" }, "valid": true, "config": { "serviceName": "HelloWorldServices", "operation": "hello", "inputParameters": "hello.name=Chris" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }

PUT Response in JSON Format

Returns the web service responder object and response code. Returns the error object if an error occurs.
{ "id": "776acc35-7a4a-47e1-8b9a-07f7d8bb6f01", "name": "MyWebServiceResponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01", "title": "MyWebServiceResponder", "id": "776acc35-7a4a-47e1-8b9a-07f7d8bb6f01" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-09-13T17:06:27+05:30", "createDate": "2013-09-13T17:05:02+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "webService", "responderTypeDisplayName": "Web Service Responder", "config": { "operation": "hello", "inputParameters": "hello.name=Chris", "serviceName": "HelloWorldServices" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/e9bcc9ae-8e78-4b2c-a3f4-48352e817052", "title": "WsConnection1", "id": "e9bcc9ae-8e78-4b2c-a3f4-48352e817052" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }
Response Code : 200 OK

PUT Request in XML Format

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>MyWebServiceResponder</name> <type>responders</type> <config> <entry> <key>operation</key> <value>hello</value> </entry> <entry> <key>inputParameters</key> <value>hello.name=Chris</value> </entry> <entry> <key>serviceName</key> <value>HelloWorldServices</value> </entry> </config> <connection> <href>api/projects/1/connections/e9bcc9ae-8e78-4b2c-a3f4-48352e817052</href> <id>e9bcc9ae-8e78-4b2c-a3f4-48352e817052</id> <rel>connection</rel> <title>WsConnection1</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>webService</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/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</id> <links/> <name>wsResponder1</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</href> <id>776acc35-7a4a-47e1-8b9a-07f7d8bb6f01</id> <rel>self</rel> <title>wsResponder1</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>operation</key> <value>hello</value> </entry> <entry> <key>inputParameters</key> <value>hello.name=Chris</value> </entry> <entry> <key>serviceName</key> <value>HelloWorldServices</value> </entry> </config> <connection> <href>api/projects/1/connections/e9bcc9ae-8e78-4b2c-a3f4-48352e817052</href> <id>e9bcc9ae-8e78-4b2c-a3f4-48352e817052</id> <rel>connection</rel> <title>WsConnection1</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>webService</responderType> <responderTypeDisplayName>Web Service Responder</responderTypeDisplayName> <responses /> <topics /> </responder>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!