Custom Connector
City of Zurich Open Data Portal Connector
Switzerland
The City of Zurich Open Data Portal Connector integrates with the Zurich Open Data Portal API (CKAN v3), enabling access to 834 datasets across government, transport, economy, society, environment, and technology. It supports dataset searches, metadata retrieval, resource access, and DCAT exports in JSON, Turtle, XML, and JSON-LD, with optional API-token authentication.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the City of Zurich Open Data Portal Connector.
- packageListGet. List all dataset IDs.
- packageSearchGet. Search for datasets (Solr query syntax).
- packageShow. Retrieve details for a specific dataset.
- resourceShow. Retrieve details for a specific resource.
- catalogJson / catalogTtl / catalogXml / catalogJsonld. Export the catalog in DCAT JSON, Turtle, XML RDF, or JSON-LD.
Documentation
Detailed Integration Documentation
Package List / Search
| Action | packageListGet / packageSearchGet |
|---|---|
| Purpose | Lists all dataset (package) IDs with pagination, or searches datasets using Solr query syntax with faceting, sorting, and pagination. |
| Configuration | Configure the base URL via CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL. Optionally provide an API token (Authorization header). |
| Parameters | packageListGet optional: limit (0–1000); offset. packageSearchGet optional: q (default *:*); fq (e.g. tags:transport); sort (default metadata_modified desc); rows; start; facet.field; facet.limit. |
| Output | Successful: JSON with success, result (array of IDs, or count + facets + results array of package objects), and help. Failure: 400 Bad request. |
| Workflow example | Execute packageListGet with limit=50, or packageSearchGet with q=transport and rows=20 to filter by topic. |
Package Show
| Action | packageShow |
|---|---|
| Purpose | Retrieves detailed information for a specific dataset — resources, tags, groups, license, and metadata. |
| Configuration | Configure the base URL via CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL. Optionally provide an API token (Authorization header). |
| Parameters | Required: id (dataset ID or name). Optional: include_private. |
| Output | Successful: JSON with success, result (id, name, title, notes, resources, tags, groups, license_id, metadata_created/modified), and help. Failure: 404 Dataset not found. |
| Workflow example | Execute packageShow with id=transport-dataset-id to review resources for data-integration planning. |
Resource Show
| Action | resourceShow |
|---|---|
| Purpose | Retrieves details for a specific resource within a dataset — URL, format, size — enabling direct data access. |
| Configuration | Configure the base URL via CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL. Optionally provide an API token (Authorization header). |
| Parameters | Required: id (resource ID). |
| Output | Successful: JSON with success, result (id, url, format, description, hash, mimetype, size, created, last_modified), and help. Failure: 404 Resource not found. |
| Workflow example | Execute resourceShow with id=resource-id to retrieve a resource URL for download. |
Catalog Exports (JSON / TTL / XML / JSON-LD)
| Action | catalogJson / catalogTtl / catalogXml / catalogJsonld |
|---|---|
| Purpose | Exports the entire catalog metadata in DCAT JSON, Turtle RDF, XML RDF, or JSON-LD — for interoperability, semantic-web, and catalog federation. |
| Configuration | Configure the base URL via CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL. Optionally provide an API token (Authorization header). |
| Parameters | Required: None. |
| Output | Successful: DCAT JSON, RDF Turtle, RDF XML, or JSON-LD (@context, @graph). Failure: error details. |
| Workflow example | Execute catalogJson for metadata harvesting, or catalogJsonld for semantic queries and API documentation. |
Example Workflow: Urban Transport Data Analysis
| List & search datasets | Use packageListGet to fetch all IDs, then packageSearchGet with q=transport for relevant datasets. |
|---|---|
| Retrieve details | Use packageShow with a dataset ID for metadata, then resourceShow to access data files. |
| Export metadata | Use catalogJson to export DCAT metadata, then integrate into a GCP dashboard for transport trend analysis. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.