Cloud Integration Hub

Back Next

Events REST API Request

To get the details of an event, use the following REST API URL:

https://<pod>.<baseUrl>/dih-console/api/v1/events

Where:

<pod>

is the name of the Informatica Intelligent Cloud Services point of delivery (PoD) where you access Cloud Integration Hub. For example:

cih-pod1

is the Informatica Intelligent Cloud Services URL. For example:

dm-us.informaticacloud.com/

For example:

https://cih-pod1.dm-us.informaticacloud.com/dih-console/

To get the details of an event, use the following request syntax:

Request headers: Include the following headers in the Events REST API request:

Content-Type: application/json
Accept: application/json

Request body: Include the following in the Events REST API request:

{
	"applicationName": "String",
	"topicName": "String",
	"pubSubName": "String",
	"timeframe": Custom - For more details, refer to the following table,
	"firstResult": int,
	"maxResults": int,
	"useExactMatch": boolean,
	"eventType": "String",
	"eventStatus": "String"
}

The request to get details of an event can include the following optional properties:

Property	Description
applicationName	Name of the publishing or subscribing application.
topicName	Name of the topic that is associated with the publication or subscription.
pubSubName	Name of the publication or subscription.
timeframe	You can either enter the UTC Timezone format (yyyy-MM-ddTHH:mm:ss.SSSZ) or select the range from the list of enum values. { "range": enum values } You can select the range from the following enum values: NO_RANGE LAST_HOUR LAST_TWO_HOURS LAST_24_HOURS LAST_7_DAYS LAST_30_DAYS TODAY YESTERDAY CUSTOM Default range is LAST_24_HOURS. You must mention the fromDate and toDate in the request body if the timeframe range is set to CUSTOM. { "fromDate": "Date", "toDate": "Date", "range": "CUSTOM" } The fromDate and toDate must be in UTC Timezone format (yyyy-MM-ddTHH:mm:ss.SSSZ).
firstResult	The number of rows to skip. For example, you might want to skip the first three rows. Default is zero.
maxResults	Enter the maximum number of results to display. Default is 2000.
useExactMatch	Exact match of the search expression when performing the search. Applies to pubSubName, topicName, and applicationName properties. You can enter one of the following values: true false Default is false.
eventType	The type of the event that Cloud Integration Hub generates for the publication or for the subscription. Select the value from the following enum values: ALL PUBLICATION SUBSCRIPTION COMPOUND_SUBSCRIPTION COMPOUND_PUBLICATION UNBOUND_SUBSCRIPTION AGGREGATED_SUBSCRIPTION Default is ALL.
eventStatus	The status of the event that Cloud Integration Hub generates for the publication or for the subscription. Enter one of the following enum values: ALL COMPLETE DELAYED DISCARDED ERROR PROCESSING REPROCESSED Default is ALL.

For example:


	Basic Auth
	{
		Username: Administrator@MyCompany.com
		Password: MyPassword
	}

Accept - application/json
Content-Type - application/json

{
   "eventStatus": "COMPLETE",
   "eventType": "PUBLICATION",
   "applicationName":"API_App",
   "topicName" :"APIT",
   "pubSubName" :"APIPUB",
    "timeframe": {
        "range": "NO_RANGE"
       
    },
    "eventType": "ALL",
    "useExactMatch" : true
}

The rate limit policy controls the number of times API consumers can invoke the API during a designated time period. This API has a rate limit policy of 5 invocations per minute. Cloud Integration Hub rejects attempts to access the API after it reaches the 5 invocations per minute limit.

Events REST API

Download Guide

Watch

Comments

Cloud Integration Hub Homepage