Looking for the previous version? View v2024.06 documentation →
REST API as Data Source in Query Builder
Overview
This guide shows how to use a REST API as a data source in Query Builder and Query Chain. A REST API connection is configured to call an endpoint and parse the JSON response into a tabular result that can be queried, transformed, and output like any database table.
Prerequisites
- You are logged in to Data Trust with a Pro-User or Admin Pro-User role.
- A REST API connection profile has been configured with the correct endpoint URL and authentication.
Steps
Path: Data Trust › Query Studio › REST API as Data Source in Query Builder
Navigate to the Query Studio module and select Click the Query Studio to open the Query Builder workspace. This is the starting point for creating, editing, and managing queries in Data Trust.
Navigate to the Query Studio module and select Click the Query for hamburger menu and App launcher to open the Query Builder workspace. This is the starting point for creating, editing, and managing queries in Data Trust.
This step shows Create Query generator in the REST API as Data Source in Query Builder workflow. Follow the on-screen prompts to complete this configuration step before proceeding to the next stage.
Select the appropriate connection profile from the dropdown to link the query to its data source. Choosing the correct profile ensures the query reads from the intended database or system.
The Restapi connection page details panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
The Additional Settings panel provides advanced configuration options such as custom aliases, timeout limits, and execution flags. Configure only the settings relevant to your use case and leave optional fields at their defaults.
The Additional Settings panel provides advanced configuration options such as custom aliases, timeout limits, and execution flags. Configure only the settings relevant to your use case and leave optional fields at their defaults.
The JSON Data popup-Select the Array-Click the Select button panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
The Restapi-Metadata view panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
The Preview Data button fetches a sample of records from the selected table or query result. Verify the column names and sample values before proceeding to confirm the data source is correctly configured.
Click Save to persist the query or configuration to the Query Explorer. A confirmation message appears once the save completes, and the query is available for reuse in Query Chains and scenarios.
Click Save to persist the query or configuration to the Query Explorer. A confirmation message appears once the save completes, and the query is available for reuse in Query Chains and scenarios.
Click Save to persist the query or configuration to the Query Explorer. A confirmation message appears once the save completes, and the query is available for reuse in Query Chains and scenarios.
Navigate to the Query Studio module and select Query Studio-Query Chain to open the Query Builder workspace. This is the starting point for creating, editing, and managing queries in Data Trust.
The Query Chain-Create page is the main workspace for building and editing queries. Use the canvas to write SQL, add data sources, connect transformations, and configure output options.
Drag the Query Widget On The Data Source Tab widget from the palette and drop it onto the Query Chain canvas. Once placed, click the widget to open its configuration popup and complete the required settings.
The Query popup-checkbox the Restapi Sample Test-Click the Select button panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
The Preview Data button fetches a sample of records from the selected table or query result. Verify the column names and sample values before proceeding to confirm the data source is correctly configured.
The Preview Data button fetches a sample of records from the selected table or query result. Verify the column names and sample values before proceeding to confirm the data source is correctly configured.
Drag the Rd Output Widget On The Output Tab widget from the palette and drop it onto the Query Chain canvas. Once placed, click the widget to open its configuration popup and complete the required settings.
The RD Output widget captures the final result set from the Query Chain for use in downstream processes. Configure the output name and format, then save the widget to make the results accessible to other scenarios and reports.
Navigate to the Query Studio module and select Navigate the Query Chain page to open the Query Builder workspace. This is the starting point for creating, editing, and managing queries in Data Trust.
Navigate to the Query Studio module and select Drag and drop the Email widget on the Additional Options tab to open the Query Builder workspace. This is the starting point for creating, editing, and managing queries in Data Trust.
Click Save to persist the query or configuration to the Query Explorer. A confirmation message appears once the save completes, and the query is available for reuse in Query Chains and scenarios.
Click Execute Now to run the query immediately and fetch the result set. The results appear in the Results tab, and the execution status is displayed in the progress indicator.
The RD Output widget captures the final result set from the Query Chain for use in downstream processes. Configure the output name and format, then save the widget to make the results accessible to other scenarios and reports.
The Execution results tab displays the output data returned by the query or Query Chain execution. Review row counts, column values, and data quality before saving or using the output in downstream processes.
The Email widget sends an automated notification with the Query Chain execution results to the specified recipients. Configure the recipient addresses, subject line, and result attachment options, then save before executing.
The REST API in an FDR Scenario panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
This step shows FDR Exceptions page in the REST API as Data Source in Query Builder workflow. Follow the on-screen prompts to complete this configuration step before proceeding to the next stage.
The REST API in Validation Scenario panel configures the REST API connection including the endpoint URL, authentication method, and response mapping. Verify the connection settings and test the API call before saving to ensure the query retrieves the expected JSON payload.
The Email widget sends an automated notification with the Query Chain execution results to the specified recipients. Configure the recipient addresses, subject line, and result attachment options, then save before executing.