Custom Connector
Open Data Paris Connector
France
The Open Data Paris Connector facilitates seamless integration with the OpenDataParis API, providing access to catalog datasets, records, and exports. It acts as a proxy for querying catalogs, datasets, and records, and exporting data in multiple formats, with JSON responses.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Open Data Paris Connector.
- getDatasets. Query catalog datasets.
- listExportFormats. List export formats for the catalog.
- exportDatasets. Export a catalog in the desired format.
- exportCatalogCSV. Export a catalog in CSV.
- exportCatalogDCAT. Export a 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.
Documentation
Detailed Integration Documentation
Get Datasets
| Action | getDatasets |
|---|---|
| Purpose | Retrieves available datasets from the catalog, optionally filtered and sorted. The primary entry point for dataset information. |
| Parameters | Optional: select, where (ODSQL), order_by, limit (default 10, max 100), offset, refine, exclude, lang, timezone, group_by, include_links, include_app_metas, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with links and a datasets array (metas, fields). Failure: error (ODSQLError). |
| Workflow example | Execute getDatasets with where=“records_count > 1000” and limit=20, then list available datasets. |
List Export Formats
| Action | listExportFormats |
|---|---|
| Purpose | Lists available export formats for the catalog. |
| Parameters | Optional: key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with links (export format links). Failure: error (ODSQLError). |
| Workflow example | Execute listExportFormats, then use the formats for subsequent export actions. |
Export Datasets
| Action | exportDatasets |
|---|---|
| Purpose | Exports a catalog in the desired format, optionally filtered. |
| Parameters | Required: format (csv, json). Optional: select, where, order_by, group_by, limit, offset, refine, exclude, lang, timezone, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportDatasets with format=json, then save the file for reporting or integration. |
Export Catalog CSV
| Action | exportCatalogCSV |
|---|---|
| Purpose | Exports a catalog in CSV format, with delimiter and quoting options. |
| Parameters | Optional: delimiter (default ;), list_separator, quote_all, with_bom (default true), key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportCatalogCSV with delimiter=, then import into spreadsheet applications. |
Export Catalog DCAT
| Action | exportCatalogDCAT |
|---|---|
| Purpose | Exports a catalog in RDF/XML described with DCAT vocabulary. |
| Parameters | Required: dcat_ap_format (e.g. -ap). Optional: include_exports, use_labels_in_exports (default true), key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportCatalogDCAT with include_exports=csv,json, then use the metadata for catalog integration. |
Get Datasets Facets
| Action | getDatasetsFacets |
|---|---|
| Purpose | Enumerates facet values for datasets, optionally refined — for guided navigation. |
| Parameters | Optional: facet, refine, exclude, where, timezone, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with links and a facets array. Failure: error (ODSQLError). |
| Workflow example | Execute getDatasetsFacets with facet=publisher, then use the facets for refining searches. |
Get Records
| Action | getRecords |
|---|---|
| Purpose | Performs a query on dataset records, optionally filtered and sorted. |
| Parameters | Required: dataset_id. Optional: select, where (ODSQL), group_by, order_by, limit (default 10, max 100), offset, refine, exclude, lang, timezone, include_links, include_app_metas, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with total_count and a results array. Failure: error (ODSQLError). |
| Workflow example | Execute getRecords with dataset_id and where=“population > 1000000”, then display record data. |
List Dataset Export Formats
| Action | listDatasetExportFormats |
|---|---|
| Purpose | Lists available export formats for a specific dataset. |
| Parameters | Required: dataset_id. Optional: key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with links. Failure: error (ODSQLError). |
| Workflow example | Execute listDatasetExportFormats with dataset_id, then use the formats for dataset exports. |
Export Records
| Action | exportRecords |
|---|---|
| Purpose | Exports a dataset in the desired format, optionally filtered. |
| Parameters | Required: dataset_id, format (csv, json). Optional: select, where, order_by, group_by, limit, refine, exclude, lang, timezone, use_labels, compressed, epsg, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportRecords with format=json and where filter, then save the file for processing. |
Export Records CSV
| Action | exportRecordsCSV |
|---|---|
| Purpose | Exports a dataset in CSV format, with delimiter and quoting options. |
| Parameters | Required: dataset_id. Optional: delimiter (default ;), list_separator, quote_all, with_bom (default true), key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportRecordsCSV with delimiter=, then import into analysis tools. |
Export Records Parquet
| Action | exportRecordsParquet |
|---|---|
| Purpose | Exports a dataset in Parquet format, with compression options. |
| Parameters | Required: dataset_id. Optional: parquet_compression (snappy, zstd; default snappy), key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportRecordsParquet with parquet_compression=zstd, then use the data in big-data frameworks. |
Export Records GPX
| Action | exportRecordsGPX |
|---|---|
| Purpose | Exports a dataset in GPX format, with name and description field options. |
| Parameters | Required: dataset_id. Optional: name_field, description_field_list, use_extension (default true), key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: file. Failure: error (ODSQLError). |
| Workflow example | Execute exportRecordsGPX with name_field=name, then use the data in mapping or navigation tools. |
Get Dataset
| Action | getDataset |
|---|---|
| Purpose | Returns information about a specific dataset, including metadata and endpoints. |
| Parameters | Required: dataset_id. Optional: select, lang, timezone, include_links, include_app_metas, key. |
| Configuration | Configure the base URL via CONNECTOR_ENV_OPENDATAPARIS_BASE_URL. |
| Output | Successful: JSON with dataset_id, metas, fields, features. Failure: error (ODSQLError). |
| Workflow example | Execute getDataset with dataset_id, then use the metadata to configure data queries. |
Example Workflow: Comprehensive Data Exploration
| Retrieve datasets | Use getDatasets with refine=publisher:“Opendatasoft” to fetch available datasets. |
|---|---|
| Query dataset info | Execute getDataset with dataset_id to understand fields and features. |
| Fetch records | Use getRecords with a where filter to retrieve records for display. |
| Export data | Use exportRecords with format=csv to export data into analysis or archiving applications. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.