Developer Guide

Back Next

Consume Data REST API Action Response

When you use the

Data Integration Hub

Consume Data REST API to consume data directly from a topic,

Data Integration Hub

returns the response code of the action that you perform in the REST API response.

Consuming data through the REST API returns one of the following response codes:

SUCCESS: Data Integration Hub
consumed the data successfully.; The response includes the consumed data in the following syntax:
{ "<table_name>": [ {"<column_name>":"<data>"} ] "responseStatus": "<value>", "responseExtraMessage": "<string>", "responseType": "<value>", "aggregatedEventId": "<value>", "statsSuccessRows": "<value>", }

For example:

{ "Sales": [ {"Opportunity_Name":"string”,"Opportunity_Owner_Id":"string"} ], "Orders": [ {"Account_Name":"string","Account_Id":"string","OrderId": "string"} ] "responseStatus": "SUCCESS", "responseExtraMessage": "", "responseType": "application/json", "aggregatedEventId": "1566010", "statsSuccessRows": "4", }
A SUCCESS response also includes the aggregated event ID of the subscription event that
Data Integration Hub
generates, the number of rows successfully processed, and the number of total rows processed.
FAILURE: Data Integration Hub
could not consume the data. For example, if is there is no pending data for the subscription to consume. The response includes a description of the error that caused the failure.