Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Open Data City of Brussels Connector
Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Overview
The Open Data City of Brussels Connector facilitates seamless integration with the City of Brussels open data platform, providing access to catalog datasets, records, export formats, facets, and attachments. This connector acts as a proxy to streamline data retrieval, supporting actions for querying datasets, listing export formats, exporting data, enumerating facets, and retrieving individual records or attachments. It supports JSON response formats and is optimized for deployment on Google Cloud Platform (GCP).
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Open Data City of Brussels Connector.
Detailed Integration Documentation
Catalog Datasets Retrieval
Action | getDatasets |
Purpose | Retrieves a list of available datasets, optionally filtered by query parameters such as where clauses, refinements, or limits. This serves as the primary entry point for discovering datasets, useful for building catalog interfaces. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL environment variable. For GCP deployment, set the apikey via query parameters or GCP Secret Manager for secure storage. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getDatasets action with optional where=publisher="Opendatasoft". Process the response to populate a dataset selection list in a GCP-hosted application. |
Export Formats Listing
Action | listExportFormats |
Purpose | Lists available export formats for the catalog, useful for determining supported output types before exporting. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL environment variable. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the listExportFormats action. Use the response to select a format for subsequent exports in a GCP Cloud Function. |
Catalog Export
Action | exportDatasets |
Purpose | Exports the catalog in a desired format, optionally filtered, useful for bulk data retrieval. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportDatasets action with format=json and optional where filters. Store the exported file in GCP Cloud Storage for further processing. |
Catalog CSV Export
Action | exportCatalogCSV |
Purpose | Exports the catalog in CSV format with customizable delimiters, useful for spreadsheet integration. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportCatalogCSV action with delimiter=;. Import the CSV into Google BigQuery for analysis. |
Catalog DCAT Export
Action | exportCatalogDCAT |
Purpose | Exports the catalog in RDF/XML (DCAT) format, useful for metadata interoperability. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportCatalogDCAT action. Use the DCAT file for metadata sharing in a GCP-hosted metadata repository. |
Datasets Facets Enumeration
Action | getDatasetsFacets |
Purpose | Enumerates facet values for datasets, useful for guided navigation in large result sets. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getDatasetsFacets action with facet=publisher. Use facets to refine dataset queries in a GCP Cloud Run application. |
Dataset Records Query
Action | getRecords |
Purpose | Performs a query on records within a specific dataset, optionally with filters or aggregations. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getRecords action with dataset_id=world-administrative-boundaries-countries-and-territories and optional where filters. Process records for display in a GCP-hosted dashboard. |
Dataset Export Formats Listing
Action | listDatasetExportFormats |
Purpose | Lists available export formats for a specific dataset. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the listDatasetExportFormats action with dataset_id. Select a format for dataset export in a GCP Cloud Function. |
Dataset Export
Action | exportRecords |
Purpose | Exports records from a specific dataset in a desired format. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportRecords action with dataset_id and format=json. Store the exported file in GCP Cloud Storage. |
Dataset CSV Export
Action | exportRecordsCSV |
Purpose | Exports dataset records in CSV format with customization. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportRecordsCSV action with dataset_id. Import CSV into Google BigQuery for analysis. |
Dataset Parquet Export
Action | exportRecordsParquet |
Purpose | Exports dataset records in Parquet format with compression options. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportRecordsParquet action with dataset_id. Use Parquet in Google BigQuery for big data analysis. |
Dataset GPX Export
Action | exportRecordsGPX |
Purpose | Exports dataset records in GPX format for geospatial applications. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the exportRecordsGPX action with dataset_id. Load GPX into Google Maps API for visualization. |
Dataset Information Retrieval
Action | getDataset |
Purpose | Retrieves metadata and endpoints for a specific dataset. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getDataset action with dataset_id=geonames-all-cities-with-a-population-1000. Use metadata to configure a GCP-hosted application interface. |
Dataset Records Facets Enumeration
Action | getRecordsFacets |
Purpose | Enumerates facet values for records in a specific dataset, useful for guided navigation. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getRecordsFacets action with dataset_id and facet=timezone. Use facets to refine record queries in a GCP Cloud Run application. |
Dataset Attachments Listing
Action | getDatasetAttachments |
Purpose | Lists all available attachments for a specific dataset. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getDatasetAttachments action with dataset_id. Download attachments to GCP Cloud Storage. |
Single Record Retrieval
Action | getRecord |
Purpose | Retrieves a single dataset record by its identifier. |
Parameters |
|
Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_OPENDATA_BRUSSELS_BASE_URL. For GCP deployment, set the apikey via query parameters or GCP Secret Manager. |
Output |
|
Workflow Example |
Configure the connector with the base URL and apikey in GCP Secret Manager. Execute the getRecord action with dataset_id and record_id. Display the record in a GCP-hosted user interface. |
Workflow Creation with the Connector
Example Workflow: Dataset Exploration and Export
Retrieve Available Datasets |
Use the getDatasets action to fetch a list of datasets with optional refine=publisher:Opendatasoft .Identify datasets of interest (e.g., geonames-all-cities-with-a-population-1000 ).
|
Query Dataset Records |
Execute the getRecords action with dataset_id=geonames-all-cities-with-a-population-1000 and optional where=timezone:Europe/Brussels .Process records to display in a GCP-hosted dashboard. |
Export Dataset for Analysis |
Use the exportRecordsCSV action with dataset_id and delimiter=; to export records.Store the CSV in GCP Cloud Storage and analyze it using Google BigQuery. |
This workflow enables applications to explore, query, and export open data from the City of Brussels, enhancing data-driven applications hosted on GCP.
Pricing
iSolution logo - white - transparent 250 px
Register To Palo Alto & iSolution Event
[forminator_form id=”14485″]
[forminator_form id=”14419″]
[forminator_form id=”14298″]
[forminator_form id=”13094″]