Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Victoria Open Data Connector
The Victoria Open Data Connector provides seamless integration with the Victorian Government’s official open data portal, enabling secure, reliable, and high-performance access to all publicly available datasets and metadata. This connector streamlines interactions with the portal by standardizing requests for datasets, resources, organizations, categories, and tags.
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Victoria Open Data Connector.
Supported Integration Action Points
- package_list: Returns a list of all dataset names (IDs).
- current_package_list_with_resources: Returns recent datasets with full resource metadata included.
- package_search: Performs full-text and faceted search across all datasets (most powerful discovery endpoint).
- package_show: Retrieves complete metadata and resources for a specific dataset.
- organization_list: Lists all publishing organizations (government departments and agencies).
- tag_list: Returns all tags used across the portal.
- group_list: Returns all groups/categories (topics) used to organize datasets.
Detailed Integration Documentation
2.1 List All Dataset Names
| Action | POST /package_list |
| Purpose | Returns a simple array of all dataset identifiers (names) available on the portal. Ideal for lightweight catalog enumeration. |
| Configuration | Ensure the connector is configured with the base URL via the CONNECTOR_ENV_VICTORIA_BASE_URL environment variable. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
2.2 List Recent Datasets with Resources
| Action | POST /current_package_list_with_resources |
| Purpose | Returns a list of datasets with full resource details (download URLs, formats, etc.) included. Useful for building rich catalogs without multiple follow-up calls. |
| Configuration | Ensure the connector is configured with the base URL via the CONNECTOR_ENV_VICTORIA_BASE_URL environment variable. |
| Parameters |
|
| Output |
|
2.3 Search Datasets (Faceted & Full-Text)
| Action | POST /package_search |
| Purpose | The primary discovery endpoint. Supports full-text search, faceted filtering (by organization, format, license, etc.), sorting, and pagination. |
| Configuration | Ensure the connector is configured with the base URL via the CONNECTOR_ENV_VICTORIA_BASE_URL environment variable. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
2.4 Get Complete Dataset Metadata
| Action | POST /package_show |
| Purpose | Retrieves full metadata for a single dataset, including title, description, resources, tags, extras, and update history. |
| Configuration | Ensure the connector is configured with the base URL via CONNECTOR_ENV_VICTORIA_BASE_URL |
| Parameters |
|
| Output |
|
| Workflow Example |
|
2.5 List Publishing Organizations
| Action | POST /organization_list |
| Purpose | Returns all government departments and agencies that publish data. |
| Configuration | Ensure connector uses CONNECTOR_ENV_VICTORIA_BASE_URL |
| Parameters |
|
| Output |
|
2.6 List All Tags
| Action | POST /tag_list |
| Purpose | Retrieves every tag used across the portal for building tag clouds or filters. |
| Configuration | Ensure connector uses CONNECTOR_ENV_VICTORIA_BASE_URL |
| Parameters |
|
2.7 List Groups/Categories
| Action | POST /group_list |
| Purpose | Returns thematic groups (e.g., Health, Transport, Environment) used to categorize datasets. |
| Configuration |
Ensure the connector is configured with the correct base URL via CONNECTOR_ENV_VICTORIA_BASE_URL. Supports authorization headers, JSON/form-encoded requests, streaming responses, 5-minute timeout for long-running searches. |
| Parameters |
|
Example Workflow
Example Workflow: Building a Victorian Open Data Portal or Dashboard
| Retrieve Publishing Organizations | Use the organization_list action to populate agency filters. |
| Discover Datasets | Execute package_search with faceted queries to power search and filtering interfaces. |
| Display Dataset Catalog | Use current_package_list_with_resources or package_search results to show titles, descriptions, and formats. |
| Show Detailed Dataset View | Execute package_show to display full metadata, license, update frequency, and direct resource download links. |
| Enable Thematic Browsing | Use group_list and tag_list to create topic-based navigation. |
This connector enables robust, performant, and standards-compliant integration with Victoria’s official open data platform, supporting use cases from public dashboards and research tools to enterprise data pipelines and automated reporting systems.
Pricing
Support
For Technical support please contact us on
custom-connectors-support@isolutions.sa
iSolution logo - white - transparent 250 px