Developer Guide

Back Next

Responder Attributes

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

The following table describes the HTTP request and response attributes of the REST calls for an RTAM responder:

Attributes	Description
to	The user name of the user who would receive the alert.
body	The body of the alert.
subject	The subject of the alert.
priority	The priority to place on the RTAM alert.
channels	A semicolon-delimited list of channels to deliver the alert to.
header	The header information for the alert, which the user can view in RTAM.
actions	A semicolon-delimited list of comma-delimited name-link pairs for actions to show in the RTAM interface for this alert.
groups	A group address to receive the Response message as defined by your RTAM administrator.
metadata	Additional information or metadata.

The following table describes the HTTP request and response attributes of the REST calls for an email responder:

Attributes	Description
to	A comma-delimited list of email addresses to which RulePoint sends the response.
body	The body of the email response.
replyTo	A comma-delimited list of email addresses to send replies to the email response.
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 the responses to as a blind copy.
from	The email address from which the email response must originate.
contentType	The content type of the email response.
cc	A comma-delimited list of email addresses to send the responses to as a copy.

The following table describes the HTTP request and response attributes of the REST calls for a JMS responder:

Attributes	Description
body	The body of the JMS response message.
retryCount	The number of retries.
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	The parameters to use in the SQL query.
timeToLive	The message expiry time.
destination	The JMS destination to which the message has to be sent. Prefix a topic name with "topic/".

The following table describes the HTTP request and response attributes of the REST calls for a web service responder:

Attributes	Description
operation	Operations defined within the WSDL file.
inputParameters	A comma-delimited list of name-value pairs provided to the Web Service.
serviceName	Name of the responder. The responder name must be unique.