Cloud Integration Hub

Back Next

Cloud Integration Hub REST APIs

Use the

REST APIs to run publications and subscriptions, to publish data directly to a specific topic and to consume data directly from a specific topic, to enable and disable publications and subscriptions, to reprocess publication and subscription events, to query the status of publication and subscription events

, and to extract data from the

Cloud Integration Hub

catalog

You can use the following REST APIs:

Run Publication Subscription: Starts a publication or a subscription, including disabled publications and subscriptions, and returns the event ID of the publication or the subscription event that
Cloud Integration Hub
generates.
You can use the Run Publication Subscription REST API to publish data and subscribe to data with publications and subscriptions that trigger a
Data Integration
task and with publications and subscriptions that trigger a file ingestion task. You can't use the API to publish data with publications that publish data directly to a topic or to consume data with subscriptions that consume data directly from a topic.
Publish Data: Publishes data directly to a topic on the
Cloud Integration Hub
publication repository. Returns the status of a publication process.
You can use the Publish Data API to publish data with publications that publish data with an API. You can't use the API with publications that trigger a Data Integration task or a file ingestion task.
Consume Data: Consumes data directly from a topic on the
Cloud Integration Hub
publication repository. You can't use the Consume Data API to consume files directly from a topic on a file store. You can use the Consume Data API to consume data with subscriptions that consume data with an API. You can't use the API with subscriptions that trigger a
Data Integration
task or a file ingestion task.
If the subscription process fails, you can attempt to consume the published data by reprocessing the subscription Error event with the API.

You can reconsume data that had previously been processed by triggering the subscription Complete event with the API.
Change Publication Subscription Mode: Changes the mode of a publication or a subscription. That is, you can enable or disable a publication, and enable, pause, or disable a subscription.
Reprocess Event: Reprocesses subscription events, including events of disabled subscriptions.
You can use the Reprocess Event REST API to reprocess events of subscriptions that trigger a Data Integration task. You can't use the API to reprocess events of subscriptions that consume data with an API.
Event Status: Returns the status of a publication or subscription event.
Catalog: Extracts data from the
Cloud Integration Hub
catalog, including topic, publication, and subscription metadata.