Rennes Metropole Open Data Portal Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Rennes Metropole Open Data Portal Connector enables seamless integration with the Rennes Metropole Open Data API, providing access to public datasets. This connector simplifies access to catalog, dataset, and record data, supporting retrieval and export actions across multiple formats such as JSON, CSV, Parquet, GPX, and DCAT.
It leverages the Opendatasoft Query Language (ODSQL) for advanced filtering, sorting, grouping, and pagination.
This connector supports municipal, transportation, geospatial, and public service applications requiring dynamic and structured data access.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Rennes Metropole Open Data Portal Connector.

Supported Integration Action Points

getDatasets: Query catalog datasets.
listExportFormats: List export formats for the catalog.
exportDatasets: Export the catalog in the desired format.
exportCatalogCSV: Export the catalog in CSV.
exportCatalogDCAT: Export the catalog in RDF/XML (DCAT).
getDatasetsFacets: List facet values for datasets.
getRecords: Query dataset records.
listDatasetExportFormats: List export formats for a specific dataset.
exportRecords: Export a dataset in the desired format.
exportRecordsCSV: Export a dataset in CSV.
exportRecordsParquet: Export a dataset in Parquet.
exportRecordsGPX: Export a dataset in GPX.
getDataset: Show dataset information.
getRecordsFacets: List dataset facet values (records level).
getDatasetAttachments: List dataset attachments.
getRecord: Read a single dataset record.

Detailed Integration Documentation

2.1 Get Datasets Retrieval

Action	getDatasets
Purpose	Retrieves available datasets from the Rennes catalog, optionally filtered and sorted using various parameters. This serves as the main entry point for accessing Rennes datasets for analytics and public services.
Configuration	Ensure the connector is configured with the base URL via the environment variable: `CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: None Optional: select (string) – Fields to return (e.g., `dataset_id,title`). where (string) – ODSQL condition (e.g., `records_count > 1000`). order_by (string) – Sorting (e.g., `records_count DESC`). limit (integer, default: 10, max: 100) – Number of results. offset (integer, default: 0) – Offset for pagination. refine (string) – Refine by facet (e.g., `publisher:"Rennes"`). exclude (string) – Exclude by facet (e.g., `publisher:"Rennes"`). lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates. group_by (string) – Group results. include_links (boolean, default: true) – Include links. include_app_metas (boolean, default: false) – Include app metas.
Output	Successful: Returns a JSON object with: links – Array of navigation links. datasets – Array of dataset objects with metadata, fields, and features. Failure: Returns error details (e.g., `message: ODSQL query malformed`, `error_code: ODSQLError`).
Workflow Example	Configure the connector with the base URL. Execute the `getDatasets` action with optional `where="records_count > 1000"` and `limit=20`. Process the response to list available Rennes datasets.

2.2 List Export Formats Retrieval

Action	listExportFormats
Purpose	Lists available export formats for the Rennes catalog. This helps users identify supported formats for exporting data in bulk.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON object with: links – Array of export format links. Failure: Returns error details (e.g., `message: request invalid`, `error_code: FormatError`).
Workflow Example	Execute the `listExportFormats` action. Review the response to identify available formats for catalog export.

2.3 Export Datasets Retrieval

Action	exportDatasets
Purpose	Exports the Rennes catalog in the desired format (CSV, JSON, RDF, etc.) with optional filtering and sorting parameters.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: format (string) – Export format (e.g., csv, json, rdf). Optional: select – Fields to return. where – Filter condition. order_by – Sorting order. group_by – Group results. limit – Number of records. offset – Pagination offset. refine – Refine by facet. exclude – Exclude by facet. lang – Language (default: en). timezone – Timezone (default: UTC).
Output	Successful: Returns an exported file. Failure: Returns error details (e.g., `message: invalid parameter`, `error_code: ExportError`).
Workflow Example	Execute `exportDatasets` with `format=json` and `where="records_count > 1000"`. Save the file for downstream analytics.

2.4 Export Catalog CSV Retrieval

Action	exportCatalogCSV
Purpose	Exports the Rennes catalog in CSV format with options for delimiter, separator, quoting, and BOM inclusion.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Optional: delimiter (string, default: 😉 – Field delimiter. list_separator (string, default: ,) – Separator for multivalued strings. quote_all (boolean, default: false) – Force quoting. with_bom (boolean, default: true) – Include BOM.
Output	Successful: Returns a CSV file. Failure: Returns error details.
Workflow Example	Execute `exportCatalogCSV` with `delimiter=,`. Save and open the CSV in spreadsheet tools.

2.5 Export Catalog DCAT Retrieval

Action	exportCatalogDCAT
Purpose	Exports the Rennes catalog in RDF/XML format using the DCAT vocabulary, enabling metadata exchange across systems.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dcat_ap_format (string) – DCAT format variant (e.g., _ap_fr). Optional: include_exports – Dataset export types to include (e.g., csv,json). use_labels_in_exports (boolean, default: true) – Use field labels in exports.
Output	Successful: Returns an RDF/XML file. Failure: Returns error details.
Workflow Example	Execute `exportCatalogDCAT` with `include_exports=csv,json`. Save the RDF file for catalog synchronization.

2.6 Get Datasets Facets Retrieval

Action	getDatasetsFacets
Purpose	Enumerates facet values for Rennes datasets, allowing guided navigation and filtering.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Optional: facet – Facet field (e.g., publisher). refine – Refine by facet (e.g., publisher:"Rennes"). exclude – Exclude facet. where – Filter condition. timezone – Timezone (default: UTC).
Output	Successful: Returns JSON with: links facets – Name, values with count, state, and value. Failure: Returns error details.
Workflow Example	Execute `getDatasetsFacets` with `facet=publisher`. Display results for interactive filtering.

2.7 Get Records Retrieval

Action	getRecords
Purpose	Retrieves records from a specific Rennes dataset, filtered, grouped, and sorted as required.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: select, where, group_by, order_by, limit, offset, refine, exclude, lang, timezone, include_links, include_app_metas.
Output	Successful: JSON containing: total_count results – Array of record objects.
Workflow Example	Execute `getRecords` with `dataset_id=geonames-all-cities-with-a-population-1000` and `where="population > 100000"`. Process response for record visualization.

2.8 List Dataset Export Formats Retrieval

Action	listDatasetExportFormats
Purpose	Lists available export formats for a specific dataset.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id (string) – Dataset identifier.
Output	Successful: JSON object with export format links. Failure: Error message if dataset not found.
Workflow Example	Execute `listDatasetExportFormats` with dataset ID. Use results to select export format.

2.9 Export Records Retrieval

Action	exportRecords
Purpose	Exports dataset records in the specified format with optional filters and grouping.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id format (e.g., csv, json) Optional: select, where, order_by, group_by, limit, refine, exclude, lang, timezone, use_labels, compressed, epsg.
Output	Successful: Returns a file. Failure: Returns error details.
Workflow Example	Execute `exportRecords` with `dataset_id=world-administrative-boundaries-countries-and-territories`, `format=csv`. Download and use file for further analysis.

2.10 Export Records CSV Retrieval

Action	exportRecordsCSV
Purpose	Exports dataset records in CSV with delimiter and quoting configuration.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id Optional: delimiter, list_separator, quote_all, with_bom.
Output	Successful: CSV file. Failure: Error message.
Workflow Example	Execute `exportRecordsCSV` with `delimiter=,`. Import file into data analytics tools.

2.11 Export Records Parquet Retrieval

Action	exportRecordsParquet
Purpose	Exports dataset records in Parquet format with configurable compression for efficient storage.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id Optional: parquet_compression (string, default: snappy).
Output	Successful: Parquet file. Failure: Error details.
Workflow Example	Execute `exportRecordsParquet` with `parquet_compression=zstd`. Save and use in big data tools.

2.12 Export Records GPX Retrieval

Action	exportRecordsGPX
Purpose	Exports dataset records in GPX format for GPS or mapping applications.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id Optional: name_field, description_field_list, use_extension (default: true).
Output	Successful: GPX file. Failure: Error details.
Workflow Example	Execute `exportRecordsGPX` with `name_field=name`. Use GPX data for visualization.

2.13 Get Dataset Retrieval

Action	getDataset
Purpose	Retrieves metadata, endpoints, and structural details for a specific Rennes dataset.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id Optional: select, lang, timezone, include_links, include_app_metas
Output	Successful: JSON with dataset_id, fields, metas, features. Failure: Returns error message.
Workflow Example	Execute `getDataset` with dataset ID. Use metadata to configure data queries.

2.14 Get Records Facets Retrieval

Action	getRecordsFacets
Purpose	Lists facet values for dataset records to support refined searching and filtering.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id Optional: facet, refine, exclude, where, lang, timezone
Output	Successful: JSON with facets and facet values. Failure: Error details.
Workflow Example	Execute `getRecordsFacets` with `facet=cou_name_en`. Use results to create interactive filters.

2.15 Get Dataset Attachments Retrieval

Action	getDatasetAttachments
Purpose	Lists available attachments for a specific Rennes dataset, such as reports or supporting files.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id
Output	Successful: JSON with links and attachments. Failure: Error message.
Workflow Example	Execute `getDatasetAttachments` with dataset ID. Download attached files for offline reference.

2.16 Get Record Retrieval

Action	getRecord
Purpose	Reads a single record from a specific Rennes dataset using its unique identifier.
Configuration	`CONNECTOR_ENV_RENNESOPENDATA_BASE_URL`
Parameters	Required: dataset_id, record_id Optional: select, lang, timezone
Output	Successful: JSON object with record details and metadata. Failure: Error message if record not found.
Workflow Example	Execute `getRecord` with `dataset_id=geonames-all-cities-with-a-population-1000` and `record_id=2798031`. Display record details in the application.

Workflow Creation with the Connector

Example Workflow: Smart City Data Integration

Retrieve Datasets	Use `getDatasets` to obtain datasets related to transportation, environment, or public services.
Query Specific Dataset	Execute `getDataset` to obtain field structure and metadata.
Fetch Records	Use `getRecords` with filters such as `where="population > 100000"` for targeted results.
Export Data	Export filtered datasets using `exportRecordsCSV` or `exportRecordsParquet`.
Visualize or Integrate	Process and visualize data using business intelligence or mapping tools.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking