Developer Guide

Back Next

Data Integration Hub Catalog API Response

When you use the

Data Integration Hub

Catalog API to extract data from the

Data Integration Hub

catalog, the API returns a JSON string that contains metadata about all the topics for which you have the required privileges.

The string includes the following data for each topic in the response:

topicName

Name of the topic.

topicDesc

Textual description of the topic.

topicType

Type of the topic: Delta or Full.

topicTables

For each table in the topic, an entry with the table name and detailed information about each of the table fields.

publications

For each publication that is associated with the topic, the following data is provided:

publicationName: Name of the publication.
publicationDesc: Textual description of the publication.
applicationName: Application from which the publication publishes data or files.
publicationSourceType: Type of publication source.
publicationConnectionName: For relational database publications and for HDFS publications: name of the connection from where the publication workflow reads the data or the files to be published.
publicationDBType: For relational database publications: type of database.

subscriptions

For each subscription that is associated with the topic, the following data is provided:

subscriptionName: Name of the subscription.
subscriptionDesc: Textual description of the subscription.
applicationName: Application that consumes data or files from the topic.
subscriptionTargetType: Type of subscription target.
subscriptionConnectionName: For relational database subscriptions and for HDFS subscriptions: name of the connection to where the subscription workflow writes the data or the files that the application consumes.
subscriptionDBType: For relational database subscriptions: type of database.