Custom Connector
Ajman Open Data Portal Connector
UAE
The Ajman Open Data Connector facilitates seamless integration with Ajman’s open-data platform, enabling access to catalog and dataset data for analytics, visualization, and GIS. It acts as a proxy for dataset enumeration, record queries, data exports, and facet-based navigation.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Ajman Open Data Connector (OpenDataSoft v2.1).
- getDatasets. Retrieves a list of all datasets in the catalog.
- listExportFormats / exportDatasets / exportCatalogCSV / exportCatalogDCAT. List and run catalog exports in a chosen format, CSV, or DCAT-AP.
- getDatasetsFacets. Retrieves global catalog-level facets.
- getDataset / getRecords / getRecord. Retrieve dataset metadata, its records, or a single record.
- listDatasetExportFormats / exportRecords / CSV / Parquet / GPX. List and run per-dataset exports in a chosen format.
- getRecordsFacets. Retrieves available facets for a dataset.
- getDatasetAttachments. Retrieves files or attachments related to a dataset.
Documentation
Detailed Integration Documentation
Get Datasets
| Action | getDatasets |
|---|---|
| Purpose | Retrieves a comprehensive list of all catalog datasets — the primary entry point for exploring available data. |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | Optional: select; where (ODSQL, e.g. publisher=“Opendatasoft”); order_by; limit (default 10, max 100); offset; refine; exclude; lang; timezone; group_by; include_links; include_app_metas; apikey. |
| Output | Successful: JSON with total_count, _links, and a results array of dataset objects (dataset_id, fields, metas). Failure: invalid parameters. |
| Workflow example | Execute getDatasets to fetch datasets, then identify one (e.g. lands-sales) for further actions. |
Catalog Export Formats & Exports
| Action | listExportFormats / exportDatasets / exportCatalogCSV / exportCatalogDCAT |
|---|---|
| Purpose | Lists catalog export formats and exports the catalog in a chosen format, CSV (delimiter options), or RDF/XML (DCAT-AP). |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | exportDatasets required: format (csv, json, xlsx). CSV optional: delimiter; list_separator; quote_all; with_bom. DCAT required: dcat_ap_format (e.g. dcat_ap_ch); optional include_exports, use_labels_in_exports. Plus catalog filters. |
| Output | Successful: a JSON list of export links or a file (CSV / RDF-XML). Failure: unsupported format. |
| Workflow example | Call listExportFormats, then exportCatalogCSV with delimiter=, and use the file for analysis. |
Get Datasets Facets
| Action | getDatasetsFacets |
|---|---|
| Purpose | Retrieves catalog-level facet values (e.g. publisher) for guided navigation. |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | Optional: facet (e.g. publisher); refine; exclude; where. |
| Output | Successful: JSON with links and facets arrays. Failure: invalid facet. |
| Workflow example | Execute getDatasetsFacets with facet=publisher, then use values to refine dataset queries. |
Dataset Metadata & Records
| Action | getDataset / getRecords / getRecord |
|---|---|
| Purpose | Retrieves metadata for a specific dataset; queries its records; and reads a single record by ID. |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | Required: dataset_id (getRecord also needs record_id). Optional: select; where (ODSQL); group_by; order_by; limit (max 100); offset; refine; exclude; lang; timezone; include_links; include_app_metas; apikey. |
| Output | Successful: dataset metadata (dataset_id, fields, metas), a results array of records, or a single record. Failure: invalid dataset_id/record_id. |
| Workflow example | Use getDataset to select lands-sales, getRecords with where=transaction_type:Sale, then getRecord with record_id=sale_001. |
Dataset Exports (formats / CSV / Parquet / GPX)
| Action | listDatasetExportFormats / exportRecords / exportRecordsCSV / exportRecordsParquet / exportRecordsGPX |
|---|---|
| Purpose | Lists a dataset’s export formats and exports its records in a chosen format, CSV, Parquet (snappy/zstd), or GPX. |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | Required: dataset_id (and format for exportRecords — e.g. csv, geojson). Optional: select, where, order_by, group_by, limit, refine, exclude, lang, timezone, use_labels, epsg; CSV delimiter options; parquet_compression; GPX name_field/description_field_list/use_extension; apikey. |
| Output | Successful: a file in the requested format. Failure: invalid format. |
| Workflow example | Execute exportRecordsParquet with dataset_id=lands-sales, then ingest into BigQuery. |
Record Facets & Attachments
| Action | getRecordsFacets / getDatasetAttachments |
|---|---|
| Purpose | Retrieves facet values for a dataset’s records (guided navigation) and lists a dataset’s files/attachments. |
| Configuration | Configure the base URL via CONNECTOR_ENV_AJMANOPENDATA_BASE_URL. |
| Parameters | Required: dataset_id. Optional (facets): facet; where; refine; exclude; lang; timezone; apikey. |
| Output | Successful: facet enumerations (links + facets), or an attachments array (href, mime-type, title). Failure: invalid dataset_id/facet. |
| Workflow example | Use getRecordsFacets with facet=transaction_type to refine, and getDatasetAttachments to download supplementary files. |
Example Workflow: Exploring & Exporting Land Sales
| Retrieve datasets | Use getDatasets to fetch datasets and identify a target (e.g. lands-sales). |
|---|---|
| Refine & query | Use getRecordsFacets with facet=transaction_type, then getRecords with where=transaction_type:Sale. |
| Export | Use exportRecordsCSV / exportRecordsParquet / exportRecordsGPX for the dataset’s records. |
| Metadata & catalog | Fetch metadata via getDataset and attachments via getDatasetAttachments; export the catalog via exportCatalogCSV or exportCatalogDCAT. |
Use Case
A real-estate analytics firm leverages the Ajman Open Data Connector, integrated with GCP, to streamline access to Ajman’s open data for market analysis. Using getDatasets and getRecords, the firm retrieves datasets like lands-sales; data is exported in Parquet (exportRecordsParquet) and ingested into BigQuery. Facet-based filtering (getRecordsFacets) refines by transaction type, exportRecordsGPX supports mapping in Google Maps, and metadata/attachments are fetched via getDataset and getDatasetAttachments and stored in Cloud Storage — enabling comprehensive market-trend analysis.
Support
For technical support, contact custom-connectors-support@isolutions.sa.