Developer Guide

10.5
- 10.4.1
- 10.4.0

Back Next

Event Details REST API Request

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

http://<dih_serverHost>:<18080_port>/dih-console/api/v1/events

For example:

http://serverhost:18080/dih-console/api/v1/events

You must provide the required header, body, and authorization details.

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

{
	"applicationName": "String",
	"partnerId": "int",
	"topicName": "String",
	"pubSubName": "String",
	"timeFrame": "String or in the UTC Timezone format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')",
	"descendantsEventState": "String",
	"firstResult": "int",
	"maxResults": "int",
	"matchAll": "boolean",
	"useExactMatch": "boolean",
	"eventId": "Long",
	"eventType": "String",
	"eventStatus": "String"
}

The following table describes the elements of the request:

Property	Description
applicationName	Name of the publishing or of the subscribing application.
partnerId	The application ID of the partner that is associated with the publication or with the subscription.
topicName	Name of the topic that is associated with the publication or with the subscription.
pubSubName	Name of the publication or of the subscription.
timeFrame	You can either enter the UTC Timezone format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') or select the range from the list of enum values. { "range": enum values } You can select the range from the following enum values: TODAY YESTERDAY LAST_24_HOURS LAST_7_DAYS LAST_30_DAYS CUSTOM NO_RANGE Default range is TODAY. 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-dd'T'HH:mm:ss.SSS'Z').
descendantsEventState	Optional. Specify the event state consumption status value from the following enum values: NONE DELAYED ERROR FINAL IN_PROCESS
firstResult	Specify the event number from which the results should be displayed. Default is zero.
maxResults	Specify the maximum number of results to display.
matchAll	Provide all the matches to the search expression when performing the search. Default is true.
useExactMatch	Exactly match the search expression when performing the search. Default is false.
eventId	ID of the event that Data Integration Hub generates for the publication or for the subscription.
eventType	The type of the event that Data Integration Hub generates for the publication or for the subscription. Select the value from the following enum values: PUBLICATION SUBSCRIPTION COMPOUND_SUBSCRIPTION UNBOUND_SUBSCRIPTION AGGREGATED_SUBSCRIPTION SYSTEM
eventStatus	The status of the event that Data Integration Hub generates for the publication or for the subscription. Select the value from the following enum values: ERROR COMPLETE DELAYED DISCARDED PROCESSING REPROCESSED

For example:

{
	"applicationName": "CompoundSub",
	"timeFrame": {
		"fromDate": "2021-03-02T15:00:00.000+05:30",
		"toDate": "2021-04-02T18:30:00.000+05:30",
		"range": "CUSTOM"
	},
	"useExactMatch": "false",
	"maxResults": "2"
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Event Details REST API Request

Event Details REST API Request