Developer Guide

10.5
- 10.4.1
- 10.4.0

Back Next

Events API Response

When you use the

Data Integration Hub

Events API to get the details of a publication or a subscription event, the API returns the following event response:

The following is the response syntax to a request to query the details of an event:

{
	"eventId": "Long",
	"eventTypeName": "String",
	"applicationName": "String",
	"topicName": "String",
	"pubSubName": "String",
	"startTime": "Event StartTime :: Date",
	"completedTime": "Event Completed Time :: Date",
	"delayedTime": "Long (in milliseconds)",
	"parentEventId": "Long",
	"descendantsEventState": "enum mentioned in the request body.",
	"childEvents": "List<EventDetailResponse>",
	"eventHistory": {
		"eventId": "Long",
		"timeStamp": "Date",
		"eventStatusName": "String",
		"comments": "String"
	}
}

The following table describes the elements of the request:

Property	Description
eventId	ID of the event that Data Integration Hub generates for the publication or for the subscription.
eventTypeName	Name of the type of the event that Data Integration Hub generates for the publication or for the subscription.
applicationName	Name of the application 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.
StartTime	The date when the publication or the subscription event started.
completedTime	The date when the publication or the subscription event ended.
delayedTime	Time taken for the event to change from delayed state to the next state such as, processing or discard state.
parentEventId	Creates a child event based on a profile ID and returns the event ID of the child event.
descendantsEventState	The enum value mentioned in the request body.
childEvents	The events available within the parent event.
eventHistory	The details of the complete event process. The following syntax appears in the eventHistory response: { "eventId": "Long", "timeStamp": "Date", "eventStatusName": "String", "comments": "String" }

Response codes: When you use the
Data Integration Hub
Events API to get the details of an existing event,
Data Integration Hub
returns the response code of the action that you perform in the API response.

The API can return the following response codes:

Code
Description

500
Internal Server Error. A response is returned if the filter parameters are invalid.

404
Not Found. A response is returned if there is a mistake in the request url.

200
OK. A response is returned when the request succeeds.

400
Bad Request. A response is returned when the request body is malformed or invalid.

Code	Description
500	Internal Server Error. A response is returned if the filter parameters are invalid.
404	Not Found. A response is returned if there is a mistake in the request url.
200	OK. A response is returned when the request succeeds.
400	Bad Request. A response is returned when the request body is malformed or invalid.

For example:

[
	{
		"eventId": 9275,
		"eventTypeName": "Subscription",
		"eventStatusName": "Complete",
		"applicationName": "TestCompoundSub",
		"topicName": "ReprocessTest",
		"pubSubName": "CompoundSub",
		"startTime": "2021-04-01T08:55:09.486Z",
		"completedTime": "2021-04-01T08:56:52.607Z",
		"delayedTime": 80729,
		"parentEventId": 10079,
		"descendantsEventState": "NONE",
		"childEvents": [],
		"eventHistory": [
			{
				"eventId": 9275,
				"timeStamp": "2021-04-01T08:55:09.486Z",
				"eventStatusName": "Processing",
				"comments": ""
			},
			{
				"eventId": 9275,
				"timeStamp": "2021-04-01T08:55:09.548Z",
				"eventStatusName": "Delayed",
				"comments": "Compound subscription."
			},
			{
				"eventId": 9275,
				"timeStamp": "2021-04-01T08:56:30.293Z",
				"eventStatusName": "Processing",
				"comments": "This event is a part of a compound subscription."
			},
			{
				"eventId": 9275,
				"timeStamp": "2021-04-01T08:56:52.607Z",
				"eventStatusName": "Complete",
				"comments": "reflected by event 9278"
			}
		]
	},
	{
		"eventId": 9278,
		"eventTypeName": "Compound Subscription",
		"eventStatusName": "Complete",
		"applicationName": "TestCompoundSub",
		"topicName": "(multiple)",
		"pubSubName": "CompoundSub",
		"startTime": "2021-04-01T08:56:30.293Z",
		"completedTime": "2021-04-01T08:56:52.622Z",
		"delayedTime": 0,
		"descendantsEventState": "NONE",
		"childEvents": [],
		"eventHistory": [
			{
				"eventId": 9278,
				"timeStamp": "2021-04-01T08:56:30.293Z",
				"eventStatusName": "New",
				"comments": ""
			},
			{
				"eventId": 9278,
				"timeStamp": "2021-04-01T08:56:30.308Z",
				"eventStatusName": "Processing",
				"comments": "Released"
			},
			{
				"eventId": 9278,
				"timeStamp": "2021-04-01T08:56:52.622Z",
				"eventStatusName": "Complete",
				"comments": "Subscription to topic completed successfully"
			}
		]
	}
]

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Events API Response

Events API Response