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

Update RTAM Responder

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

PUT Request in JSON Format

Generate a PUT request. For example, the following PUT request updates an RTAM responder in a RulePoint application.
http://invrw28cep14:8080/rulepoint/api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54 Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

PUT Body in JSON Format

{ "name": "MyRTAMResponder", "responderType": "RTAMResponder", "connection": null, "valid": true, "config": { "to": "Administrator", "body": "RTAM Alert Body", "subject": "RTAM Alert Subject", "priority": "3", "channels": null, "header": null, "actions": null, "groups": null, "metadata": null }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {}, "marshallerThreadsafe": false } }

PUT Response in JSON Format

Returns the RTAM responder object and response code. Returns the error object if an error occurs.
{ "id": "d4c831d8-e031-4119-ac1b-28d4e785ab54", "name": "MyRTAMResponder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "title": "MyRTAMResponder", "id": "d4c831d8-e031-4119-ac1b-28d4e785ab54" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-09-19T17:49:26+05:30", "createDate": "2013-09-19T17:43:33+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "RTAMResponder", "responderTypeDisplayName": "RTAM Responder", "config": { "to": "Administrator", "body": "RTAM Alert Body", "subject": "RTAM Alert Subject", "priority": "3", "channels": "", "header": "", "actions": "", "groups": "", "metadata": null }, "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 an RTAM responder in a RulePoint application.
PUT http://invrw28cep14:8080/rulepoint/api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54 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>MyRTAMResponder</name> <type>responders</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> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>RTAMResponder</responderType> </responder>

PUT Response in XML Format

Returns the RTAM 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/d4c831d8-e031-4119-ac1b-28d4e785ab54/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>d4c831d8-e031-4119-ac1b-28d4e785ab54</id> <links/> <name>rtamresponder</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/d4c831d8-e031-4119-ac1b-28d4e785ab54</href> <id>d4c831d8-e031-4119-ac1b-28d4e785ab54</id> <rel>self</rel> <title>rtamresponder</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>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> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>RTAMResponder</responderType> <responderTypeDisplayName>RTAM Responder</responderTypeDisplayName> <responses /> <topics /> </responder>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!