Bizdata Dataset Response

Overview

The bizdata_dataset_response key is a core component within the Integration Bridge in eZintegrations.

It acts as the primary container for response data received from a configured data source and makes this data available for processing and transformation.

This structure ensures that source data remains accessible throughout the integration workflow.

Purpose

The primary purpose of the bizdata_dataset_response key is to store raw response data retrieved from the source system.

This stored data can then be used for applying operations, transformations, and mappings before being delivered to the target system.

It serves as a centralized storage unit within the pipeline.

Source-to-Target Data Processing Pipeline

The bizdata_dataset_response key plays a critical role in the end-to-end data processing workflow.

• Data Source: Data is fetched from the configured source system.
• Storage: The raw response is stored in the bizdata_dataset_response key.
• Data Operations: Transformations and operations are applied.
• Data Target: Processed data is sent to the target system.

This structured flow ensures controlled and reliable data movement.

How It Works

When a data source executes successfully, the response is captured automatically.

This response is mapped to the bizdata_dataset_response key and remains available for all downstream operations.

Any operation within the Integration Bridge accesses this key to read, modify, or enrich the data.

Usage Example 1: Using an API as a Source

In this example, an API is used as the data source.

The API returns a structured JSON response.

Sample API 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 the API as the Data Source, this response is stored inside the bizdata_dataset_response key.

Stored in bizdata_dataset_response

"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!"
  }
}

The complete API response is preserved for further processing.

Usage Example 2: Using a Database as a Source

When a database is used as a source, table data is retrieved as structured records.

Sample Database Response

[
  {
    "FIRST_NAME": "Carmen Nixon",
    "LAST_NAME": "Todd Anderson"
  },
  {
    "FIRST_NAME": "Mrs. Heather Miller",
    "LAST_NAME": "Julia Moore"
  }
]

This dataset is stored in the bizdata_dataset_response key using the defined response parameter.

Stored in bizdata_dataset_response

"bizdata_dataset_response": {
  "Data": [
    {
      "FIRST_NAME": "Carmen Nixon",
      "LAST_NAME": "Todd Anderson"
    },
    {
      "FIRST_NAME": "Mrs. Heather Miller",
      "LAST_NAME": "Julia Moore"
    }
  ]
}

The response parameter determines how database records are structured inside the key.

Frequently Asked Questions

What is bizdata_dataset_response?

It is a system-generated key that stores raw response data from the source system inside the Integration Bridge.

Why is bizdata_dataset_response important?

It ensures that source data is preserved and accessible for transformations, validations, and mappings.

Can users modify data inside bizdata_dataset_response?

Yes. Data Operations can read and modify values stored within this key.

Is bizdata_dataset_response created automatically?

Yes. It is generated automatically when a data source returns a successful response.

Does this key exist for all data sources?

Yes. It is used for API, database, and other supported data sources.

Benefits

• Centralized response storage
• Supports complex data transformations
• Ensures data traceability
• Improves integration reliability
• Enables flexible data processing

Notes

• The structure depends on the source response format.
• Response parameters affect how data is stored.
• Always validate response data before processing.
• Use operations carefully when modifying this key.
• Maintain consistent response structures across integrations.