Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • RulePoint 6.1.2
  • All Products

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

Back Next

Retrieve Topics

Retrieve Topics

Use the GET method to retrieve a topic in RulePoint.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves a topic in a RulePoint application: 
GET http://localhost:8080/rulepoint/api/projects/1/topics
Accept: application/json
Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in JSON Format

{
    {
        "total": 1,
        "count": 1,
        "items": [
            {
                "id": "619cca07-4fc1-460a-8b6b-aef2901e8782",
                "name": "system_markers",
                "valid": true,
                "self": {
                    "rel": "self",
                    "href": "api/projects/1/topics/619cca07-4fc1-460a-8b6b-aef2901e8782",
                    "title": "system_markers",
                    "id": "619cca07-4fc1-460a-8b6b-aef2901e8782"
                },
                "actions": [
                    
                ],
                "acl": {
                    "rel": "acl",
                    "href": "api/projects/1/topics/619cca07-4fc1-460a-8b6b-aef2901e8782/acl",
                    "title": "acl"
                },
                "links": {
                    
                },
                "owningProject": {
                    "rel": "owningProject",
                    "href": "api/projects/1",
                    "title": "Default Project",
                    "id": "1"
                },
                "type": "topics",
                "lastModifiedDate": "2013-07-30T16:34:10+05:30",
                "createDate": "2013-07-30T16:34:10+05:30",
                "createdBy": "Administrator",
                "predefined": true,
                "deployable": true,
                "deployState": "DRAFT",
                "force": false,
                "expiresIn": 36000,
                "responderAccess": "NAMED_PROPERTIES",
                "properties": [
                    {
                        "name": "begin_time",
                        "description": "Time (since epoch in milliseconds) when marker begin is produced by engine",
                        "status": "ACTIVE",
                        "order": 0
                    },
                    {
                        "name": "end_time",
                        "description": "Time (since epoch in milliseconds) when marker end is produced by engine",
                        "status": "ACTIVE",
                        "order": 1
                    },
                    {
                        "name": "engine_name",
                        "description": "Name of the engine that produce the marker begin end events",
                        "status": "ACTIVE",
                        "order": 2
                    },
                    {
                        "name": "event_count",
                        "description": "Value of event count is string form of integer",
                        "status": "ACTIVE",
                        "order": 3
                    },
                    {
                        "name": "hit_ratio",
                        "description": "Ratio of number of events in marker boundary that participated in activations and EVENTS_COUNT",
                        "status": "ACTIVE",
                        "order": 4
                    },
                    {
                        "name": "marker_name",
                        "description": "marker_name",
                        "status": "ACTIVE",
                        "order": 5
                    },
                    {
                        "name": "marker_type",
                        "description": "value is either begin or end",
                        "status": "ACTIVE",
                        "order": 6
                    },
                    {
                        "name": "rule_activation_count",
                        "description": "Total number of activations in which event within marker boundary participated",
                        "status": "ACTIVE",
                        "order": 7
                    },
                    {
                        "name": "rules_processed",
                        "description": "Comma separated list of all rules that processed events received in the marker boundary",
                        "status": "ACTIVE",
                        "order": 8
                    },
                    {
                        "name": "source_list",
                        "description": "Comma separated list of sources that produced marker events",
                        "status": "ACTIVE",
                        "order": 9
                    },
                    {
                        "name": "total_processing_time",
                        "description": "Total processing time (in milliseconds) of all events in the marker boundary",
                        "status": "ACTIVE",
                        "order": 10
                    }
                ],
                "rules": [
                    
                ],
                "sources": [
                    
                ],
                "responders": [
                    
                ],
                "templates": [
                    
                ]
            }
        ]
    }
Response Code : 200 OK

GET Request in XML Format

Generate a GET request. For example, the following GET request retrieves a topic in a RulePoint application: 
GET http://localhost:8080/rulepoint/api/projects/1/topics
Accept: application/xml
Cookie: JSESSIONID=<VALID SESSION ID>

GET Response in XML Format

Returns the topic object and response code. Returns the error object if an error occurs. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<artifacts>
	<links/>
	<valid>false</valid>
	<count>1</count>
	<items>
		<topic>
			<acl>
				<href>api/projects/1/topics/619cca07-4fc1-460a-8b6b-aef2901e8782/acl</href>
				<rel>acl</rel>
				<title>acl</title>
			</acl>
			<id>619cca07-4fc1-460a-8b6b-aef2901e8782</id>
			<links/>
			<name>system_markers</name>
			<owningProject>
				<href>api/projects/1</href>
				<id>1</id>
				<rel>owningProject</rel>
				<title>Default Project</title>
			</owningProject>
			<self>
				<href>api/projects/1/topics/619cca07-4fc1-460a-8b6b-aef2901e8782</href>
				<id>619cca07-4fc1-460a-8b6b-aef2901e8782</id>
				<rel>self</rel>
				<title>system_markers</title>
			</self>
			<valid>true</valid>
			<createDate/>
			<createdBy>Administrator</createdBy>
			<deployState>DRAFT</deployState>
			<deployable>true</deployable>
			<force>false</force>
			<lastModifiedDate/>
			<predefined>true</predefined>
			<type>topics</type>
			<expiresIn>36000</expiresIn>
			<properties>
				<description>Time (since epoch in milliseconds) when marker begin is produced by engine</description>
				<name>begin_time</name>
				<order>0</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Time (since epoch in milliseconds) when marker end is produced by engine</description>
				<name>end_time</name>
				<order>1</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Name of the engine that produce the marker begin end events</description>
				<name>engine_name</name>
				<order>2</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Value of event count is string form of integer</description>
				<name>event_count</name>
				<order>3</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Ratio of number of events in marker boundary that participated in activations and EVENTS_COUNT</description>
				<name>hit_ratio</name>
				<order>4</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>marker_name</description>
				<name>marker_name</name>
				<order>5</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>value is either begin or end</description>
				<name>marker_type</name>
				<order>6</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Total number of activations in which event within marker boundary participated</description>
				<name>rule_activation_count</name>
				<order>7</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Comma separated list of all rules tchat processed events received in the marker boundary</description>
				<name>rules_processed</name>
				<order>8</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Comma separated list of sources that produced marker events</description>
				<name>source_list</name>
				<order>9</order>
				<status>ACTIVE</status>
			</properties>
			<properties>
				<description>Total processing time (in milliseconds) of all events in the marker boundary</description>
				<name>total_processing_time</name>
				<order>10</order>
				<status>ACTIVE</status>
			</properties>
			<responderAccess>NAMED_PROPERTIES</responderAccess>
		</topic>
	</items>
	<total>1</total>
	<invalidCount>0</invalidCount>
</artifacts>
Response Code : 200 OK
0 COMMENTS
We’d like to hear from you!