Skip to main content

bizdata_dataset_response

Overview:

The "bizdata_dataset_response" key is a crucial component within our integration bridge in eZintegrations, serving as the container for response data obtained from the source. This documentation aims to provide a comprehensive understanding of the role of bizdata_dataset_response within a integration bridge.

Purpose:

The primary purpose of the bizdata_dataset_response key is to store the raw response data retrieved from the source system. This key acts as a storage unit, facilitating subsequent operations and transformations before the final data is sent to the target system.


Source-to-Target Data Processing Pipeline:

Workflow diagram 2.jpg

The workflow involving the "bizdata_dataset_response" key can be outlined as follows:

Data Source:
       1) Data is fetched from the Data Source during the integration process.
       2) The raw response is stored within the bizdata_dataset_response key.

 Data Operations:
       1) Operations are applied to the data within the bizdata_dataset_response key.

Data Target:
       1) The data is then sent to the Data Target.


Usage Example 1: When Using an API as a Source

Let's consider the Humanoid API as our data source.

Sample response :

{
  "page": 1,
  "per_page": 2,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "email": "george.bluth@reqres.in",
      "first_name": "George",
      "last_name": "Bluth",
      "avatar": "https://reqres.in/img/faces/1-image.jpg"
    },
    {
      "id": 2,
      "email": "janet.weaver@reqres.in",
      "first_name": "Janet",
      "last_name": "Weaver",
      "avatar": "https://reqres.in/img/faces/2-image.jpg"
    }
  ],
 "support": {
    "url": "https://reqres.in/#support-heading",
    "text": "To keep ReqRes free, contributions towards server costs are appreciated!"
  }
}

After configuring Humanoid as the Data Source in eZintegrations, the corresponding response is stored under the 'bizdata_dataset_response' key, as shown below.

"bizdata_dataset_response":
{
  "page": 1,
  "per_page": 2,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "email": "george.bluth@reqres.in",
      "first_name": "George",
      "last_name": "Bluth",
      "avatar": "https://reqres.in/img/faces/1-image.jpg"
    },
    {
      "id": 2,
      "email": "janet.weaver@reqres.in",
      "first_name": "Janet",
      "last_name": "Weaver",
      "avatar": "https://reqres.in/img/faces/2-image.jpg"
    }
  ],
 "support": {
    "url": "https://reqres.in/#support-heading",
    "text": "To keep ReqRes free, contributions towards server costs are appreciated!"
  }
}

Usage Example 2: When Using a Database as a Source

Consider a scenario where a Database serves as our data source. The data retrieved from a specific table within the Database can be illustrated as follows:

[
{
      "EMAIL": "marvinjackson@example.com",
      "PRODUCT_ID": "133",
      "QTY": "9",
      "AMOUNT": "14.57",
      "INVOICE_DATE": "10-09-1982",
      "ADDRESS": "283 Wendy Common",
      "CITY": "West Alexander",
      "STOCK_CODE": "36239634",
      "JOB": "Logistics and distribution manager",
      "FIRST_NAME": "Carmen Nixon",
      "LAST_NAME": "Todd Anderson"
    },
    {
      "EMAIL": "jeffrey84@example.net",
      "PRODUCT_ID": "155",
      "QTY": "5",
      "AMOUNT": "65.48",
      "INVOICE_DATE": "03-10-2012",
      "ADDRESS": "13567 Patricia Circles Apt. 751",
      "CITY": "Andreamouth",
      "STOCK_CODE": "2820163",
      "JOB": "Osteopath",
      "FIRST_NAME": "Mrs. Heather Miller",
      "LAST_NAME": "Julia Moore"
    }
]

Now, upon providing a sample Response Parameter such as 'Data', the information is stored within the 'bizdata_dataset_response' key, as depicted below:

"bizdata_dataset_response":
{
"Data":
  [   
	{
      "EMAIL": "marvinjackson@example.com",
      "PRODUCT_ID": "133",
      "QTY": "9",
      "AMOUNT": "14.57",
      "INVOICE_DATE": "10-09-1982",
      "ADDRESS": "283 Wendy Common",
      "CITY": "West Alexander",
      "STOCK_CODE": "36239634",
      "JOB": "Logistics and distribution manager",
      "FIRST_NAME": "Carmen Nixon",
      "LAST_NAME": "Todd Anderson"
    },
    {
      "EMAIL": "jeffrey84@example.net",
      "PRODUCT_ID": "155",
      "QTY": "5",
      "AMOUNT": "65.48",
      "INVOICE_DATE": "03-10-2012",
      "ADDRESS": "13567 Patricia Circles Apt. 751",
      "CITY": "Andreamouth",
      "STOCK_CODE": "2820163",
      "JOB": "Osteopath",
      "FIRST_NAME": "Mrs. Heather Miller",
      "LAST_NAME": "Julia Moore"
    }
]
}













Back to top