Australian Capital Territory Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The ACT Government Open Data Portal Connector facilitates seamless integration with the Australian Capital Territory (ACT) Government Open Data Portal API, based on the Socrata Open Data API (SODA). This connector enables access to datasets from the ACT Government, supporting searches, metadata retrieval, data rows, and exports in JSON, CSV, and GeoJSON formats. It acts as a proxy to streamline data retrieval, with optional API key authentication for higher rate limits, ideal for applications requiring Australian territorial data.

Integration Overview

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

searchDatasets: Search for datasets using various filters.
getDatasetMetadata: Retrieve metadata for a specific dataset.
getDataRows: Retrieve rows of data from a dataset with SODA queries.
exportCsv: Export dataset rows as CSV.
exportGeoJson: Export spatial dataset rows as GeoJSON.
getCatalog: Retrieve the DCAT catalog of datasets.

Detailed Integration Documentation

2.1 Search Datasets Retrieval

Action	searchDatasets
Purpose	Searches for datasets (views) in the ACT Open Data Portal using filters like category, domain, or keyword. This serves as the primary entry point for discovering available datasets.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication to access higher rate limits.
Parameters	Required: None Optional: q (string) – Search query. domain (string) – Filter by domain. category (string) – Filter by category. tag (string) – Filter by tag. limit (integer, default: 1000) – Number of results. offset (integer, default: 0) – Pagination offset. only (string, comma-separated) – Include only these fields. exclude (string, comma-separated) – Exclude these fields. $$app_token (string) – App token for rate limits.
Output	Successful: Returns a JSON object with: total (integer) – Total datasets. page (integer) – Current page. per_page (integer) – Results per page. count (integer) – Number of results. results (array) – List of dataset objects (id, name, description, category, createdAt, etc.). Failure: Returns error details (e.g., 400: Bad request).
Workflow Example	Configure the connector with the appropriate base URL and optional API key. Execute the `searchDatasets` action with `q=environment` and `limit=10`. Process the response to list relevant datasets for selection.

2.2 Get Dataset Metadata Retrieval

Action	getDatasetMetadata
Purpose	Retrieves detailed metadata for a specific dataset (view), including columns, owner, and update timestamps. This supports dataset evaluation before data retrieval.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Dataset ID. Optional: $$app_token (string) – App token for rate limits.
Output	Successful: Returns a JSON object with: resource – Dataset metadata (id, name, description, columns array with id, name, dataTypeName, etc., owner details). Failure: Returns error details (e.g., 404: Not found).
Workflow Example	Execute the `getDatasetMetadata` action with `id=abcd-1234`. Review metadata to understand columns and data types. Use for preparing data queries.

2.3 Get Data Rows Retrieval

Action	getDataRows
Purpose	Retrieves rows of data from a specific dataset using SODA query parameters for filtering, selecting, and sorting. This enables customized data extraction.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Dataset ID. Optional: $limit (integer, default: 1000) – Number of rows. $offset (integer, default: 0) – Pagination offset. $where (string) – Filter condition. $select (string) – Select columns. $order (string) – Order by column. $group (string) – Group by column. $having (string) – Having condition. q (string) – Full-text search. $$app_token (string) – App token for rate limits.
Output	Successful: Returns a JSON object with: results – Array of row objects (dynamic based on dataset columns). Failure: Returns error details (e.g., 404: Not found).
Workflow Example	Execute the `getDataRows` action with `id=abcd-1234`, `$where=year=2023`, and `$limit=50`. Analyze the filtered data rows. Integrate into reporting tools.

2.4 Export CSV Retrieval

Action	exportCsv
Purpose	Exports dataset rows as CSV for easy download and offline analysis, with optional limiting and offsetting.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Dataset ID. Optional: $limit (integer) – Number of rows. $offset (integer) – Pagination offset. $$app_token (string) – App token for rate limits.
Output	Successful: Returns a CSV file with dataset rows. Failure: Returns error details.
Workflow Example	Execute the `exportCsv` action with `id=abcd-1234` and `$limit=100`. Save the CSV file for import into spreadsheets. Use for bulk data analysis.

2.5 Export GeoJSON Retrieval

Action	exportGeoJson
Purpose	Exports spatial dataset rows as GeoJSON for geospatial applications and mapping.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Dataset ID. Optional: $$app_token (string) – App token for rate limits.
Output	Successful: Returns a GeoJSON object with spatial features. Failure: Returns error details (e.g., non-spatial dataset).
Workflow Example	Execute the `exportGeoJson` action with `id=spatial-dataset-id`. Load the GeoJSON into a mapping tool. Use for geospatial visualizations.

2.6 Get Catalog Retrieval

Action	getCatalog
Purpose	Retrieves the DCAT representation of the entire data catalog for comprehensive metadata access.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ACTOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON array of dataset objects (id, name, description, etc.). Failure: Returns error details.
Workflow Example	Execute the `getCatalog` action. Process the catalog for indexing. Use for data discovery portals.

Workflow Creation with the Connector

Example Workflow: Environmental Data Analysis

Search for Datasets	Use the `searchDatasets` action with `q=environment` to find relevant datasets. Identify a target dataset ID (e.g., `abcd-1234`).
Retrieve Metadata and Data	Execute the `getDatasetMetadata` action with the ID to review columns. Use the `getDataRows` action with `$where` filters to fetch specific data.
Export for Analysis	Use the `exportCsv` action for tabular data or `exportGeoJson` for spatial datasets. Integrate exports into GCP analytics for environmental trend reporting.

This workflow enables applications to provide users with access to ACT Government data, enhancing research, policy analysis, and public services in the Australian Capital Territory.

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