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 File Output Responder

Create File Output Responder

Use the POST method to create a file output responder in RulePoint.

POST Request in JSON Format

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

POST Body in JSON Format

{ "name": "fileout_responder", "description": "", "responderType": "fileOutput", "connection": null, "valid": true, "config": { "contents": "writing to my out file", "filename": "response.out", "mode": "append" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": {} } }

POST Response in JSON Format

Returns the file output responder object and response code. Returns the error object if an error occurs.
{ "id": "757f8948-dc3c-4a52-a755-c261e2010005", "name": "fileout_responder", "valid": false, "self": { "rel": "self", "href": "api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005", "title": "fileout_responder", "id": "757f8948-dc3c-4a52-a755-c261e2010005" }, "actions": [ { "rel": "update", "href": "api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005", "type": "PUT", "title": "Edit" }, { "rel": "delete", "href": "api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005", "type": "DELETE", "title": "Delete" }, { "rel": "createResponse", "href": "api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005", "type": "DELETE", "title": "Create Response" } ], "acl": { "rel": "acl", "href": "api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005/acl", "title": "acl" }, "owningProject": { "rel": "owningProject", "href": "api/projects/1", "title": "Default Project", "id": "1" }, "type": "responders", "lastModifiedDate": "2013-09-19T18:21:25+05:30", "createDate": "2013-09-19T18:21:25+05:30", "createdBy": "Administrator", "predefined": false, "deployable": true, "deployState": "DRAFT", "force": false, "dtError": "There are no responses associated with this Responder", "responderType": "fileOutput", "responderTypeDisplayName": "File Responder", "config": { "contents": "writing to my out file", "filename": "response.out", "mode": "append" }, "marshaller": { "marshallerClassname": null, "marshallerProperties": null, "marshallerThreadsafe": false } }
Response Code : 201 Created

POST Request in XML Format

Generate a POST request. For example, the following POST request creates a file output responder in a RulePoint application.
POST http://localhost:8080/rulepoint/api/projects/1/responders 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"?> <responder> <name>fileout_responder</name> <type>responders</type> <config> <entry> <key>contents</key> <value>writing to my out file</value> </entry> <entry> <key>filename</key> <value>response.out</value> </entry> <entry> <key>mode</key> <value>append</value> </entry> </config> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>fileOutput</responderType> </responder>

POST Response in XML Format

Returns the file output 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/757f8948-dc3c-4a52-a755-c261e2010005/acl</href> <rel>acl</rel> <title>acl</title> </acl> <actions> <action> <href>api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005</href> <rel>update</rel> <title>Edit</title> <type>PUT</type> </action> <action> <href>api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005</href> <rel>delete</rel> <title>Delete</title> <type>DELETE</type> </action> <action> <href>api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005</href> <rel>createResponse</rel> <title>Create Response</title> <type>DELETE</type> </action> </actions> <id>757f8948-dc3c-4a52-a755-c261e2010005</id> <links/> <name>fileout_responder</name> <owningProject> <href>api/projects/1</href> <id>1</id> <rel>owningProject</rel> <title>Default Project</title> </owningProject> <self> <href>api/projects/1/responders/757f8948-dc3c-4a52-a755-c261e2010005</href> <id>757f8948-dc3c-4a52-a755-c261e2010005</id> <rel>self</rel> <title>fileout_responder</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>contents</key> <value>writing to my out file</value> </entry> <entry> <key>filename</key> <value>response.out</value> </entry> <entry> <key>mode</key> <value>append</value> </entry> </config> <marshaller> <marshallerProperties/> <marshallerThreadsafe>false</marshallerThreadsafe> </marshaller> <responderType>fileOutput</responderType> <responderTypeDisplayName>File Responder</responderTypeDisplayName> <responses /> <topics /> </responder>
Response Code : 201 Created

0 COMMENTS

We’d like to hear from you!