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

Response Attributes

Response Attributes

The tables list the HTTP request and response attributes to call REST APIs for the supported RulePoint responses.

SQL Response

The following table describes the attributes in the HTTP request and response content in an SQL response:
Attributes
Description
sql
The SQL query to run.
params
Parameters to be passed to the query.

Email Response

The following table describes the attributes in the HTTP request and response content in an email response:
Attributes
Description
to
A comma-delimited list of email addresses to send the response.
body
The body of the email response.
replyTo
A comma-delimited list of email addresses to send email response replies.
subject
The subject of the email response.
sentDate
The date that you want to appear as the email send date.
bcc
A comma-delimited list of email addresses to send a blind copy of the response.
from
The email address from which the email response originates.
contentType
The content type of the email response.
cc
A comma-delimited list of email addresses to send a copy of the response.

JMS Response

The following table describes the attributes in the HTTP request and response content in a JMS response:
Attributes
Description
body
Message body.
retryCount
The number of retries to be made
priority
Priority of the message.
retryDelay
Delay between two consecutive retries.
deliveryMode
Persistent or Non-Persistent modes of delivering the message. Valid values would be 1 for non-persistent mode, 2 for persistent mode.
params
Message parameters.
timeToLive
The message expiry time.
destination
The JMS destination to which the message has to be sent. Prefix a topic name with "topic/"

Web Service Response

The following table describes the attributes in the HTTP request and response content in a web service response:
Attributes
Description
operation
Operations defined within the WSDL file.
inputParameters
A comma-delimited list of name-value pairs provided to the Web Service. The operation and parameters that you list must be defined in the WSDL.
serviceName
Name of the responder. The responder name must be unique.

0 COMMENTS

We’d like to hear from you!