Skip to content

Configure REST API Data Sources in NCC Portal

This article describes how to set up and manage REST API connections in the NCC Portal, following Microsoft Fabric best practices.

Prerequisites

Before you begin, review the prerequisites for your specific REST API. Requirements may vary depending on the API provider.

Step 1: Create a REST API Connection

To connect a REST API to your Fabric tenant:

  1. Visit Connect to REST API and follow the instructions to create a new connection.
  2. If required, create a private endpoint.
  3. Name your connection using the CON_NCC prefix. This naming convention ensures visibility and manageability within the NCC Portal.

Step 2: Add a Data Source

  1. In the NCC Portal, go to Tenant Settings > Data Sources.
  2. Select Add DataSource.
  3. Complete the following fields:
Field Description Example/Default Value
Name Data source name in NCC CBSOPENDATA
Data Source Type Type of data source REST
Namespace Prefix for storing data in Lakehouses REST_PAG
Code Identifier for pipelines ANONYMOUS or ANONYMOUS_PAGINATION
Description Description of the data source CBS opendata for InSpark
Connection Name of the connection in Fabric CON_NCC_REST_CBS
Environment NCC environment for the data source Development

Step 3: Create a Landing Zone Entity

  1. Navigate to Landing Zone Entities.
  2. Select New Entity.
  3. Fill in the required details:
Field Description Example/Default Value
Pipeline Not used PL_LDZ_COPY_FROM_REST_ANONYMOUS_PAG_ABS_URL
Data Source Data source for connection CBSOPENDATA
Source schema Identifies the source in NCC CBS
Source name Identifies the source in NCC BasisGegevens
Incremental Extract data incrementally False
Has encrypted columns Indicates if the table contains sensitive data False
Entity value NotebookName required, CustomParametersJSON optional. Entity values reference See example below
Lake house Lakehouse for storing data LH_Data_Landingzone
File path File path for data storage CBSNED
File name File name for data storage CBS_BasisGegevens
File type Expected file type Json, Csv, Parquet, Xlsx, Txt, Xml

Example Entity value:

Name Value
pagination_absolute_url $.['odata.nextLink']
relative_url https://opendata.cbs.nl/ODataFeed/odata/83502NED/TypedDataSet?$filter=Postcode%20ne%20%27NL01%20%20%20%20%27

Step 4: Create a Bronze Zone Entity

  1. Go to Bronze Zone Entities.
  2. Select New Entity.
  3. Enter the following information:
Field Description Example/Default Value
Pipeline Orchestrator pipeline for parsing PL_BRZ_COMMAND
Landing zone entity Landing zone entity to be parsed CBSNED/CBS_BasisGegevens
Entity value Optional. Entity values reference See example below
Column mappings Optional. Column mapping info See example below
Lake house Lakehouse for storing data LH_Bronze_Layer
Schema Schema for storing data dbo
Name Table name for storing data CBS_BasisGegevens
Primary keys Unique identifier fields (Case sensitive) ID

Example Entity value:

Name Value
Collection value

Example Column mappings:

SourceColumn TargetColumn DataType
value.Bevolking_1 Bevolking_1 String
value.Geslacht Geslacht String
value.ID ID String
value.Leeftijd Leeftijd String
value.Perioden Perioden String
value.Postcode Postcode String

Step 5: Create a Silver Zone Entity

  1. Go to Silver Zone Entities.
  2. Select New Entity.
  3. Provide the following details:
Field Description Example/Default Value
Pipeline Orchestrator pipeline for parsing PL_SLV_COMMAND
Bronze layer entity Bronze layer entity to be parsed dbo.CBS_BasisGegevens
Entity value Optional. Entity values reference
Lake house Lakehouse for storing data LH_Silver_Layer
Schema Schema for storing data dbo
Name Table name for storing data CBS_BasisGegevens
Columns to exclude Comma-separated columns to exclude (Case sensitive)
Columns to exclude from history Comma-separated columns to exclude from compare (Case sensitive)

Next steps