Open Data Paris Connector - Ismena website

info@ismena.com

Open Data Paris Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Open Data Paris Connector facilitates seamless integration with the OpenDataParis API, providing access to catalog datasets, records, and exports. This connector acts as a proxy to streamline data retrieval, supporting actions for querying catalogs, datasets, records, and exporting data in various formats. This supports JSON response formats for API responses, with exports in multiple formats

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Open Data Paris Connector.
Supported Integration Action Points

- 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.

Detailed Integration Documentation

Get Datasets Retrieval

Action	getDatasets
Purpose	Retrieves available datasets from the catalog, optionally filtered and sorted using various parameters. This serves as the primary entry point for accessing dataset information, useful for building data exploration interfaces.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: None Optional: select: Fields to return (string, e.g., dataset_id,title). where: Query language condition (string, e.g., records_count > 1000). order_by: Sorting (string, e.g., records_count DESC). limit: Number of results (integer, default: 10, max: 100). offset: Offset for pagination (integer, default: 0). refine: Refine by facet (string, e.g., publisher:"Opendatasoft"). exclude: Exclude by facet (string, e.g., publisher:"Opendatasoft"). lang: Language for labels (string, default: en). timezone: Timezone for dates (string, default: UTC). group_by: Group results (string). include_links: Include links (boolean, default: true). include_app_metas: Include app metas (boolean, default: false). key: Your API key (string, e.g., YOUR-API-KEY). Optional, but required for higher rate limits.
Output	Successful: Returns a JSON object with: links: Array of navigation links. datasets: Array of dataset objects with metas, fields, etc. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Configure the connector with the appropriate base URL. Execute the getDatasets action with optional where="records_count > 1000" and limit=20. Process the response to list available datasets.

List Export Formats Retrieval

Action	listExportFormats
Purpose	Lists available export formats for the catalog. This helps users identify supported formats for catalog exports.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: None Optional: key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Returns a JSON object with links (array of export format links). Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the listExportFormats action. Review the response to identify available export formats. Use the formats for subsequent export actions.

Export Datasets Retrieval

Action	exportDatasets
Purpose	Exports a catalog in the desired format, optionally filtered using various parameters. This enables bulk data retrieval in a specified format.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: format: Export format (string, e.g., csv, json). Optional: select: Fields to return (string, e.g., dataset_id,title). where: Query language condition (string, e.g., records_count > 1000). order_by: Sorting (string, e.g., records_count DESC). group_by: Group results (string). limit: Number of results (integer). offset: Offset for pagination (integer, default: 0). refine: Refine by facet (string, e.g., publisher:"Opendatasoft"). exclude: Exclude by facet (string, e.g., publisher:"Opendatasoft"). lang: Language for labels (string, default: en). timezone: Timezone for dates (string, default: UTC). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Return a file. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the exportDatasets action with format=json and optional where="records_count > 1000". Save the exported file for analysis. Use the data for reporting or integration purposes.

Export Catalog CSV Retrieval

Action	exportCatalogCSV
Purpose	Exports a catalog in CSV format, with specific configuration options for delimiters and quoting. This supports customized CSV exports for data processing.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: None Optional: delimiter: Field delimiter (string, enum: [;, ,, \t, \|], default: ;). list_separator: Separator for multivalued strings (string, default: ,). quote_all: Force quoting all strings (boolean, default: false). with_bom: Include Unicode BOM (boolean, default: true). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Return a file. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the exportCatalogCSV action with optional delimiter=,. Save the CSV file. Import the data into spreadsheet applications.

Export Catalog DCAT Retrieval

Action	exportCatalogDCAT
Purpose	Exports a catalog in RDF/XML described with DCAT vocabulary, with options for including exports and using labels. This facilitates metadata interchange using standard vocabularies.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dcat_ap_format: DCAT format variant (string, e.g., -ap). Optional: include_exports: Datasets exports to expose (string, e.g., csv,json). use_labels_in_exports: Use field labels in exports (boolean, default: true). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Return a file. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the exportCatalogDCAT action with optional include_exports=csv,json. Save the RDF/XML file. Use the metadata for catalog integration.

Get Datasets Facets Retrieval

Action	getDatasetsFacets
Purpose	Enumerates facet values for datasets, optionally refined by parameters. This can be used to implement guided navigation in large result sets.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: None Optional: facet: Facets to enumerate (string, e.g., publisher). refine: Refine by facet (string, e.g., publisher:"Opendatasoft"). exclude: Exclude by facet (string, e.g., publisher:"Opendatasoft"). where: Query language condition (string, e.g., records_count > 1000). timezone: Timezone for dates (string, default: UTC). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Returns a JSON object with: links: Array of navigation links. facets: Array of facet enumerations with name, facets (count, state, name, value). Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the getDatasetsFacets action with facet=publisher. Process the response to display facet values. Use the facets for refining searches.

Get Records Retrieval

Action	getRecords
Purpose	Performs a query on dataset records, optionally filtered and sorted. This helps users retrieve specific data records from a dataset.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000). Optional: select: Fields to return (string, e.g., name,population). where: Query language condition (string, e.g., population > 1000000). group_by: Group results (string). order_by: Sorting (string, e.g., population DESC). limit: Number of results (integer, default: 10, max: 100). offset: Offset for pagination (integer, default: 0). refine: Refine by facet (string). exclude: Exclude by facet (string). lang: Language for labels (string, default: en). timezone: Timezone for dates (string, default: UTC). include_links: Include links (boolean, default: true). include_app_metas: Include app metas (boolean, default: false). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Returns a JSON object with: total_count: Total number of records (integer). results: Array of record objects. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the getRecords action with dataset_id=geonames-all-cities-with-a-population-1000 and optional where="population > 1000000". Review the response to obtain record data. Use the records for analysis or display.

List Dataset Export Formats Retrieval

Action	listDatasetExportFormats
Purpose	Lists available export formats for a specific dataset. This helps users identify supported formats for dataset exports.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000). Optional: key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Returns a JSON object with links (array of export format links). Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the listDatasetExportFormats action with dataset_id=geonames-all-cities-with-a-population-1000. Review the response to identify available export formats. Use the formats for dataset exports.

Export Records Retrieval

Action	exportRecords
Purpose	Exports a dataset in the desired format, optionally filtered using various parameters. This enables bulk data retrieval from a dataset in a specified format.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000). format: Export format (string, e.g., csv, json). Optional: select: Fields to return (string, e.g., name,population). where: Query language condition (string, e.g., population > 1000000). order_by: Sorting (string, e.g., population DESC). group_by: Group results (string). limit: Number of results (integer). refine: Refine by facet (string). exclude: Exclude by facet (string). lang: Language for labels (string, default: en). timezone: Timezone for dates (string, default: UTC). use_labels: Use field labels instead of names (boolean, default: false). compressed: Compress the output (boolean, default: false). epsg: EPSG code for spatial reference (integer, e.g., 4326). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Return a file. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the exportRecords action with dataset_id=geonames-all-cities-with-a-population-1000, format=json, and optional where="population > 1000000". Save the exported file. Use the data for further processing.

Export Records CSV Retrieval

Action	exportRecordsCSV
Purpose	Exports a dataset in CSV format, with specific configuration options for delimiters and quoting. This supports customized CSV exports for dataset records.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000). Optional: delimiter: Field delimiter (string, enum: [;, ,, \t, \|], default: ;). list_separator: Separator for multivalued strings (string, default: ,). quote_all: Force quoting all strings (boolean, default: false). with_bom: Include Unicode BOM (boolean, default: true). key: Your API key (string, optional, required for higher rate limits).
Output	Successful: Return a file. Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError).
Workflow Example	Execute the exportRecordsCSV action with dataset_id=geonames-all-cities-with-a-population-1000 and optional delimiter=,. Save the CSV file. Import the data into analysis tools.

Export Records Parquet Retrieval

Action	exportRecordsParquet
Purpose	Exports a dataset in Parquet format, with options for compression. This supports efficient storage and querying of large datasets.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000) Optional: parquet_compression: Compression algorithm (string, enum: [snappy, zstd], default: snappy) key: Your API key (string, optional, required for higher rate limits)
Output	Successful: Return a file Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError)
Workflow Example	Execute the exportRecordsParquet action with dataset_id=geonames-all-cities-with-a-population-1000 and optional parquet_compression=zstd Save the Parquet file Use the data in big data processing frameworks

Export Records GPX Retrieval

Action	exportRecordsGPX
Purpose	Exports a dataset in GPX format, with options for name and description fields. This supports geospatial data export for GPS applications.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000) Optional: name_field: Field for GPX name attribute (string) description_field_list: Fields for GPX description (string) use_extension: Use extension tag for attributes (boolean, default: true) key: Your API key (string, optional, required for higher rate limits)
Output	Successful: Return a file Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError)
Workflow Example	Execute the exportRecordsGPX action with dataset_id=geonames-all-cities-with-a-population-1000 and optional name_field=name Save the GPX file Use the data in mapping or navigation tools

Get Dataset Retrieval

Action	getDataset
Purpose	Returns information about a specific dataset, including metadata and endpoints. This provides detailed dataset metadata for application integration.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_OPENDATAPARIS_BASE_URL environment variable.
Parameters	Required: dataset_id: Dataset identifier (string, e.g., geonames-all-cities-with-a-population-1000) Optional: select: Fields to return (string, e.g., metas,title) lang: Language for labels (string, default: en) timezone: Timezone for dates (string, default: UTC) include_links: Include links (boolean, default: true) include_app_metas: Include app metas (boolean, default: false) key: Your API key (string, optional, required for higher rate limits)
Output	Successful: Returns a JSON object with dataset_id, metas, fields, and features Failure: Returns error details (e.g., message: ODSQL query is malformed, error_code: ODSQLError)
Workflow Example	Execute the getDataset action with dataset_id=geonames-all-cities-with-a-population-1000 Process the response to obtain dataset metadata Use the information to configure data queries

Workflow Creation with the Connector

Example Workflow: Comprehensive Data Exploration

Retrieve Datasets	Use the getDatasets action with optional refine=publisher:"Opendatasoft" to fetch a list of available datasets. Identify target datasets (e.g., geonames-all-cities-with-a-population-1000).
Query Dataset Information	Execute the getDataset action with dataset_id=geonames-all-cities-with-a-population-1000 to fetch dataset metadata. Process the response to understand fields and features.
Fetch Records	Use the getRecords action with dataset_id=geonames-all-cities-with-a-population-1000 and optional where="population > 1000000" to retrieve records. Display the records in a user interface.
Perform Data Export	Use the exportRecords action with dataset_id=geonames-all-cities-with-a-population-1000, format=csv, and optional where="population > 1000000" to export data. Integrate the exported data into analysis or archiving applications.

This workflow enables applications to provide users with accurate dataset exploration, querying, and export capabilities, enhancing data management and analysis.

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