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

Create Email Response

Create Email Response

Use the POST method to create an email response in RulePoint.

POST Request in JSON Format

Generate a POST request. For example, the following POST request creates an email response in a RulePoint application.
POST http://localhost:8080/rulepoint/api/projects/1/responses Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

POST Body in JSON Format

{ "name": "EmailResponse1", "description": "", "valid": true, "force": false, "responder": { "rel": "self", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "title": "EmailResponder1", "id": "26154ed7-41ce-4db4-888f-ce5573e965d1" }, "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 } }

POST Response in JSON Format

Returns the email response object and response code. Returns the error object if an error occurs.
{ "id": "aa8c1aa6-31a1-48bb-9e0a-a9477df4e625", "name": "EmailResponse1", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625", "title": "EmailResponse1", "id": "aa8c1aa6-31a1-48bb-9e0a-a9477df4e625" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-09-13T16:27:51+05:30", "createDate": "2013-09-13T16:27:51+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "EmailResponder", "responseTypeDisplayName": "Email Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1", "title": "EmailResponder1", "id": "26154ed7-41ce-4db4-888f-ce5573e965d1" }, "multithreaded": false, "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": "" } }
Response Code: 201 Created

POST Request in XML Format

Generate a POST request. For example, the following POST request creates an email response in a RulePoint application.
POST http://localhost:8080/rulepoint/api/projects/1/responses Accept: application/xml Content-Type: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

POST Body in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <name>EmailResponse1</name> <type>responses</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> <responder> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <id>26154ed7-41ce-4db4-888f-ce5573e965d1</id> <rel>responder</rel> <title>EmailResponder1</title> </responder> <responseType>EmailResponder</responseType> </response>

POST Response in XML Format

Returns the email response object and response code. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response> <acl> <href>api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>aa8c1aa6-31a1-48bb-9e0a-a9477df4e625</id> <links/> <name>EmailResponse1</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responses/aa8c1aa6-31a1-48bb-9e0a-a9477df4e625</href> <id>aa8c1aa6-31a1-48bb-9e0a-a9477df4e625</id> <rel>self</rel> <title>EmailResponse1</title> </self> <valid>true</valid> <createDate/> <createdBy>Administrator</createdBy> <deployState>DRAFT</deployState> <deployable>true</deployable> <force>false</force> <lastModifiedDate/> <predefined>false</predefined> <type>responses</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> <multithreaded>false</multithreaded> <responder> <href>api/projects/1/responders/26154ed7-41ce-4db4-888f-ce5573e965d1</href> <id>26154ed7-41ce-4db4-888f-ce5573e965d1</id> <rel>responder</rel> <title>EmailResponder1</title> </responder> <responseType>EmailResponder</responseType> <responseTypeDisplayName>Email Responder</responseTypeDisplayName> <templates /> <rules /> </response>
Response Code : 201 Created

0 COMMENTS

We’d like to hear from you!