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

Source Attributes

Source Attributes

The tables list the HTTP request and response attributes to call a REST API for different types of RulePoint sources.

SQL Source

The following table describes the HTTP request and response attributes of the REST calls for an SQL source:
Attributes
Description
fetchSize
Number of rows to fetch.
sql
The SQL query to run against the target database.
updateSql
The UPDATE statement for each record extracted from the query and published to RulePoint.
bufferResult
Determines whether to maintain a buffer of the result sets to publish to the topic. Used only when defining a SQL source service.
markerId
The name to assign to the marker. This is the batch name that the sever associates with all published events.
parameters
The parameters to use in the SQL query.
propertyMetadataMap
The unique name-value pairs of static metadata or additional information about this service that becomes part of the event properties.
transactionSize
The frequency to update the parameters with data from the most recently processed records.

JMS Source

The following table describes the HTTP request and response attributes of the REST calls for a JMS source:
Attributes
Description
clientAcknowledgeMode
Specifies the acknowledgement mode for non-transacted sessions, such as Auto Acknowledge, Client Acknowledge, or Acknowledge.
clientId
Client identifier to identify the souce.
destination
Name of the Queue or Topic on the JMS Provider.
messageSelector
Criteria for filtering message header or message properties, to limit which JMS messages RulePoint receives.
subscriptionName
Durable subscription name.

RSS Reader Source

The following table describes the HTTP request and response attributes of the REST calls for an RSS Reader Source:
Attributes
Description
username
The user name to access the specified URL if the URL requires authentication.
mostRecentEventDate
Only feeds with pubDate after this will be read.
markerId
The name to assign to the marker.
propertyMetadataMap
The unique name-value pairs of static metadata or additional information about this service that becomes part of the event properties.
url
The URL for the RSS news feed.
password
The password associated with the user name required to access the specified URL.

URL Monitoring Source

The following table describes the HTTP request and response attributes of the REST calls for a URL monitoring source:
Attributes
Description
markerId
The name to assign to the marker.
propertyMetadataMap
The unique name-value pairs of static metadata or additional information about this service that becomes part of the event properties.
url
The URL of the web page to connect.

Web Page Monitoring Source

The following table describes the HTTP request and response attributes of the REST calls for a web page monitoring source:
Attributes
Description
markerId
The name to assign to the marker.
propertyMetadataMap
The unique name-value pairs of static metadata or additional information about this service that becomes part of the event properties.
url
The URL of the web page to connect.

Web Service Source

The following table describes the HTTP request and response attributes of the REST calls for a web service source:
Attributes
Description
serviceName
Service to list the operations to run.
operation
The WSDL operation that you want to run.
inputParameters
List of parameters for your WSDL operation.
xpathExpr
If the operation returns a result, the type of output that the Web Service expects. The output types include an XML document or the result of the application of an XPath expression that you provide.
markerId
The name to assign to the marker. This is the batch name that the sever associates with all published events.
propertyMetadataMap
The unique name-value pairs of static metadata or additional information about this service that becomes part of the event properties.

0 COMMENTS

We’d like to hear from you!