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 RTAM Response

Create RTAM Response

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

POST Request in JSON Format

Generate a POST request. For example, the following POST request creates an RTAM 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": "rtamresponse", "valid": true, "force": false, "responder": { "rel": "self", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "title": "MyRTAMResponder", "id": "d4c831d8-e031-4119-ac1b-28d4e785ab54" }, "config": { "to": "Administrator", "body": "RTAM Alert Body", "subject": "RTAM Alert Subject", "priority": "3", "channels": null, "header": null, "actions": null, "groups": null, "metadata": null } }

POST Response in JSON Format

Returns the RTAM response object and response code. Returns the error object if an error occurs.
{ "id": "10467fff-8e53-4d23-b227-a663a7e458e3", "name": "rtamresponse", "valid": true, "self": { "rel": "self", "href": "api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3", "title": "rtamresponse", "id": "10467fff-8e53-4d23-b227-a663a7e458e3" }, "actions": [ { "rel": "update", "href": "api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3", "type": "DELETE", "title": "Delete" } ], "acl": { "rel": "acl", "href": "api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responses", "lastModifiedDate": "2013-09-19T17:51:50+05:30", "createDate": "2013-09-19T17:51:50+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "responseType": "RTAMResponder", "responseTypeDisplayName": "RTAM Responder", "responder": { "rel": "responder", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "title": "MyRTAMResponder", "id": "d4c831d8-e031-4119-ac1b-28d4e785ab54" }, "multithreaded": false, "config": { "to": "Administrator", "body": "RTAM Alert Body", "subject": "RTAM Alert Subject", "priority": "3", "channels": "", "header": "", "actions": "", "groups": "", "metadata": null } }
Response Code: 201 Created

POST Request in XML Format

Generate a POST request. For example, the following POST request creates an RTAM 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>rtamresponse</name> <type>responses</type> <config> <entry> <key>to</key> <value>Administrator</value> </entry> <entry> <key>body</key> <value>RTAM Alert Body</value> </entry> <entry> <key>subject</key> <value>RTAM Alert Subject</value> </entry> <entry> <key>priority</key> <value>3</value> </entry> <entry> <key>channels</key> <value/> </entry> <entry> <key>header</key> <value/> </entry> <entry> <key>actions</key> <value/> </entry> <entry> <key>groups</key> <value/> </entry> <entry> <key>metadata</key> </entry> </config> <responder> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <id>d4c831d8-e031-4119-ac1b-28d4e785ab54</id> <rel>responder</rel> <title>MyRTAMResponder</title> </responder> <responseType>RTAMResponder</responseType> </response>

POST Response in XML Format

Returns the RTAM 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/10467fff-8e53-4d23-b227-a663a7e458e3/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> </actions> <id>10467fff-8e53-4d23-b227-a663a7e458e3</id> <links/> <name>rtamresponse</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responses/10467fff-8e53-4d23-b227-a663a7e458e3</href> <id>10467fff-8e53-4d23-b227-a663a7e458e3</id> <rel>self</rel> <title>rtamresponse</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>Administrator</value> </entry> <entry> <key>body</key> <value>RTAM Alert Body</value> </entry> <entry> <key>subject</key> <value>RTAM Alert Subject</value> </entry> <entry> <key>priority</key> <value>3</value> </entry> <entry> <key>channels</key> <value/> </entry> <entry> <key>header</key> <value/> </entry> <entry> <key>actions</key> <value/> </entry> <entry> <key>groups</key> <value/> </entry> <entry> <key>metadata</key> </entry> </config> <multithreaded>false</multithreaded> <responder> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <id>d4c831d8-e031-4119-ac1b-28d4e785ab54</id> <rel>responder</rel> <title>MyRTAMResponder</title> </responder> <responseType>RTAMResponder</responseType> <responseTypeDisplayName>RTAM Responder</responseTypeDisplayName> <templates /> <rules /> </response>
Response Code : 201 Created

0 COMMENTS

We’d like to hear from you!