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

Update Email Responder

Use the PUT method to update an email responder in RulePoint.

PUT Request in JSON Format

Generate a PUT request. For example, the following PUT request creates an email responder in a RulePoint application.
PUT http://localhost:8080/rulepoint/api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1 Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in JSON Format

{ "name": "MyEmailResponder", "responderType": "EmailResponder", "connection": { "rel": "connection", "href": "api/projects/1/connections/446f972d-d3ea-4d77-98f8-84816ed4abcb", "title": "EmailConnection1", "id": "446f972d-d3ea-4d77-98f8-84816ed4abcb" }, "valid": true, "config": { "to": "sbhimisetty@informatica.com", "body": "Test email from EmailResponder", "replyTo": null, "subject": "Test email subject from EmailResponder", "sentDate": null, "bcc": null, "from": "sbhimisetty@informatica.com", "contentType": "text", "cc": null }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }

PUT Response in JSON Format

Returns the email responder object and response code. Returns the error object if an error occurs.
{ "id": "26154ed7-41ce-4db4-888f-ce5573e965d1", "name": "MyEmailResponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "title": "MyEmailResponder", "id": "26154ed7-41ce-4db4-888f-ce5573e965d1" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-09-13T16:19:50+05:30", "createDate": "2013-09-13T16:10:38+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": "sbhimisetty@informatica.com", "body": "Test email from EmailResponder", "replyTo": "", "subject": "Test email subject from EmailResponder", "sentDate": null, "bcc": "", "from": "sbhimisetty@informatica.com", "contentType": "text", "cc": "" }, "connection": { "rel": "connection", "href": "api/projects/1/connections/446f972d-d3ea-4d77-98f8-84816ed4abcb", "title": "EmailConnection1", "id": "446f972d-d3ea-4d77-98f8-84816ed4abcb" }, "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 creates an email responder in a RulePoint application.
PUT http://localhost:8080/rulepoint/api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1 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>MyEmailResponder</name> <type>responders</type> <config> <entry> <key>to</key> <value>sbhimisetty@informatica.com</value> </entry> <entry> <key>body</key> <value>Test email from EmailResponder</value> </entry> <entry> <key>replyTo</key> <value/> </entry> <entry> <key>subject</key> <value>Test email subject from EmailResponder</value> </entry> <entry> <key>sentDate</key> </entry> <entry> <key>bcc</key> <value/> </entry> <entry> <key>from</key> <value>sbhimisetty@informatica.com</value> </entry> <entry> <key>contentType</key> <value>text</value> </entry> <entry> <key>cc</key> <value/> </entry> </config> <connection> <href>api/projects/1/connections/446f972d-d3ea-4d77-98f8-84816ed4abcb</href> <id>446f972d-d3ea-4d77-98f8-84816ed4abcb</id> <rel>connection</rel> <title>EmailConnection1</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>EmailResponder</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/26154ed7-41ce-4db4-888f-ce5573e965d1/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>26154ed7-41ce-4db4-888f-ce5573e965d1</id> <links/> <name>EmailResponder1</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <id>26154ed7-41ce-4db4-888f-ce5573e965d1</id> <rel>self</rel> <title>EmailResponder1</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>to</key> <value>sbhimisetty@informatica.com</value> </entry> <entry> <key>body</key> <value>Test email from EmailResponder</value> </entry> <entry> <key>replyTo</key> <value/> </entry> <entry> <key>subject</key> <value>Test email subject from EmailResponder</value> </entry> <entry> <key>sentDate</key> </entry> <entry> <key>bcc</key> <value/> </entry> <entry> <key>from</key> <value>sbhimisetty@informatica.com</value> </entry> <entry> <key>contentType</key> <value>text</value> </entry> <entry> <key>cc</key> <value/> </entry> </config> <connection> <href>api/projects/1/connections/446f972d-d3ea-4d77-98f8-84816ed4abcb</href> <id>446f972d-d3ea-4d77-98f8-84816ed4abcb</id> <rel>connection</rel> <title>EmailConnection1</title> </connection> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>EmailResponder</responderType> <responderTypeDisplayName>Email Responder</responderTypeDisplayName> <responses /> <topics /> </responder>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!