Developer Guide

10.5
- 10.4.1
- 10.4.0

Back Next

Event Status API

When you use a

Data Integration Hub

Run Publication Subscription API to start the running of a publication or of a subscription and the action succeeds,

Data Integration Hub

returns the event ID of the publication or the subscription event that it generates.

The manner in which

Data Integration Hub

returns the event ID depends on the API that you use to run the publication or the subscription:

When you run the REST API,

Data Integration Hub

returns the event ID in the REST API response.

When you run the command line API,

Data Integration Hub

returns the event ID in the command line notification.

You can use the

Data Integration Hub

Event Status REST API to query the status of the publication or subscription event according to the event ID. You can see whether the publication or subscription process is still running, and after the process is complete, you can see whether it completed successfully. If the process fails, the response to the query includes the cause of the failure.

To query the status of an event, use a GET command with the following REST URL:

http://<DIH_console_host_port>/dih-console/api/v1/event/<eventId>

For example:

http://localhost:18080/dih-console/api/v1/event/2435

Sample Files: The
<DIH_InstallationDir>\samples\api\restapi\examples\event
folder contains the following files:
EventResponse.java
: Event response model class.
HttpRestClientEventApi.java
: A simple HTTP client that is based on Java API to query event status. The client uses
org.codehaus.jackson.map.ObjectMapper
to parse event status and send a
json
response to an
EventResponse
object.
SprintRestTemplateClientEventApi.java
: A sample client that uses a SpringRest template to query event status. Use this client if your client applications are contained in a Spring container.

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Event Status API

Event Status API