Table of Contents

Search

  1. Preface
  2. Introduction to Cloud Integration Hub
  3. Hub administration
  4. Project and Asset Management
  5. Applications
  6. Topics
  7. Data Integration tasks
  8. File ingestion tasks
  9. Publications
  10. Subscriptions
  11. Tracking and monitoring
  12. Cloud Integration Hub REST APIs
  13. Glossary

Cloud Integration Hub

Cloud Integration Hub

Request body

Request body

The syntax of the Consume Data REST API request body varies, based on the action you perform with the API.
Consume data
To consume data from a topic, use the following request syntax:
{ "aggregated": <value> }
Where
<value>
takes one of the following values:
  • true. The subscription consumes all the available publications in each API call.
  • false. The subscription consumes only the oldest publication in each API call.
For example:
{ "aggregated": true }
When you run multiple publications, you can add the publication event ID of a specific publication to the request body to consume only the data of the specific publication event. You can add only one publication event ID to the request body. The key
"publicationEventId"
is case sensitive. If you don't add the publication event ID of a specific publication to the request body, the subscription consumes all the available publication events.
To add the publication event ID of a specific publication event to the request, use the following syntax:
{ "publicationEventId" : "<publicationEventId>" }
For example:
{ "publicationEventId" : "594210" }
When you add the publication event ID of a specific publication to the request body,
Cloud Integration Hub
validates the key
"publicationEventId"
before it runs the subscription instance.
Reconsume data
To reconsume data that had previously been processed, use the following request syntax:
{ "requestType" : "RECONSUME", "eventId" : "<subscriptionEventId>" }
Where the key
"eventId"
is the subscription event ID to reconsume.
For example:
{ "requestType" : "RECONSUME", "eventId" : "40559" }
Reprocess subscription
To reprocess a failed subscription, use the following request syntax:
{ "requestType" : "REPROCESS", "eventId" : "<subscriptionEventId>" }
Where the key
"eventId"
is the subscription event ID to reprocess.
For example:
{ "requestType" : "REPROCESS", "eventId" : "40577" }

0 COMMENTS

We’d like to hear from you!