The documentation portal is undergoing maintenance. During this period, you can't create any new user credentials. If you do, you'll need to recreate the user credential after the maintenance period ends.
Creating a subscription that consumes data with an API
Creating a subscription that consumes data with an API
Use the Navigator to create subscriptions that use the Consume Data REST API to consume the data from a specific topic in the
Cloud Integration Hub
relational publication repository.
The following conditions must exist before you create a subscription:
An application or applications that consume data must exist. You can either use existing applications, or create and save new applications.
A relational topic to consume data from must exist. You can either use an existing topic, or create and save a new topic.
On the Navigator, click
New
Subscription
.
The
New Subscription
page appears.
Enter the subscription name. Optionally, enter a description for the subscription.
Select the subscription mode. Choose one of the following options:
Enable
. The subscription runs according to the schedule that you define in the
Schedule
page. You can also run the subscription manually from Cloud Integration Hub.
Pause
. The subscription does not run according to a schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events.
Disable
. The subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
Select
Consume data with an API
.
Optionally, enter a notification URL.
Cloud Integration Hub
sends notifications to this URL when data is ready to consume. You can either enter an unauthenticated URL or a basic authenticated URL.
Select the application that subscribes to the data.
Select the topic that stores data in a relational database from which the application consumes the data and then click
Add Topic
. You can add as many topis as required.
Click
Save
.
You can copy the following URLs and use them in the request that runs the subscription:
URL of the REST API. Use this URL to consume the data.
URL of the Swagger structure for the topic that the subscription consumes data from.
If a Swagger structure base URL is configured for the organization, Cloud Integration Hub appends the base URL to the topic Swagger structure URL. For more information, see
System Properties.