Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Big data, Analytics, DevOps
KSA Open Data Portal Connector
Overview
The KSA Open Data Platform Connector enables seamless integration with the Saudi Open Data Platform, providing access to dataset and organization-related data for applications such as data analytics, visualization tools, or reporting systems. The connector acts as a proxy to streamline data retrieval, supporting actions for dataset metadata queries, resource access, and organization details retriev
Integration Overview
This document outlines each integration action point, its purpose, configuration, and workflow support using the KSA Open Data Platform Connector.
Supported Integration Action Points
- Dataset Metadata Retrieval: Retrieves metadata for a specific dataset, including titles, descriptions, provider details, and categories.
- Dataset Resources Retrieval:Fetches resources (e.g., downloadable files) associated with a specific dataset.
- Organization Details Retrieval: Retrieves metadata for a specific organization, including its name, description, and associated datasets.
Detailed Integration Documentation
Dataset Metadata Retrieval
Action
/datasets
Purpose
Retrieves comprehensive metadata for a specific dataset, serving as the primary entry point for accessing dataset details such as titles, descriptions, provider information, categories, and timestamps.
Parameters
- Required:
- version (Required): Integer, the required version (e.g., -1).
- dataset (Required): String, the dataset ID (e.g., 565f4740-b454-4512-89af-065b80177324), the Arabic name (e.g., إحصاءات السكان 2025), or the English name (e.g., Population Statistics 2025).
- Optional:None.
Configuration
Ensure the connector is configured with the appropriate environment variables for authentication and connectivity.
Output
- Successful: Returns a JSON object with transactionId, id, titleEn, titleAr, descriptionEn, descriptionAr, providerNameEn, providerNameAr, organizationId, updateFrequency, language, timePeriod, resourcesCount, categories, tags, createdAt, and updatedAt.
- Failure: Returns error details (e.g., invalid dataset ID or missing parameters).
Workflow Example
1. Identify the dataset ID or name from the platform’s catalog.
2. Execute the Dataset Metadata Retrieval action with version (Required)=-1 and one of the following: dataset (Required)=565f4740-b454-4512-89af-065b80177324, dataset (Required)=إحصاءات السكان 2025, or dataset (Required)=Population Statistics 2025.
3. Process the response to extract metadata for display or further actions.
Dataset Resources Retrieval
Action
/datasets/resources
Purpose
Retrieves a list of resources (e.g., downloadable files) associated with a specific dataset, enabling access to data files for analysis or processing.
Parameters
- Required:
- version (Required): Integer, the required version (e.g., -1).
- dataset (Required): String, the dataset ID (e.g., 565f4740-b454-4512-89af-065b80177324), the Arabic name (e.g., إحصاءات السكان 2025), or the English name (e.g., Population Statistics 2025).
- Optional: None.
Configuration
Ensure the connector is configured with the appropriate environment variables for authentication and connectivity.
Output
- Successful:Returns a JSON object with transactionId, datasetId, and a resources array containing id, name, descriptionEn, descriptionAr, format (e.g., CSV, JSON), columns, downloadUrl, createdAt, and updatedAt for each resource.
- Failure:Returns error details (e.g., invalid dataset ID or no associated resources).
Workflow Example
1. Use the Dataset Metadata Retrieval action to select a dataset ID or name.
2. Execute the Dataset Resources Retrieval action with version (Required)=-1 and one of the following: dataset (Required)=565f4740-b454-4512-89af-065b80177324, dataset (Required)=إحصاءات السكان 2025, or dataset (Required)=Population Statistics 2025.
3. Extract the downloadUrl from the response for the desired resource (e.g., a CSV file).
Organization Details Retrieval
Action
/organizations
Purpose
Retrieves detailed metadata for a specific organization, providing context about the entity publishing datasets, including its name, description, and associated datasets.
Parameters
- Required:
- version (Required): Integer, the required version (e.g., -1).
- organization (Required): String, the organization ID (e.g., org-1234-5678-9012-3456), the Arabic name (e.g., وزارة الصحة), or the English name (e.g., Ministry of Health).
- Optional: None
Configuration
Ensure the connector is configured with the appropriate environment variables for authentication and connectivity.
Output
- Successful:Returns a JSON object with transactionId, id, nameEn, nameAr, descriptionEn, descriptionAr, websiteUrl, addressEn, addressAr, typeEn, typeAr, rating, and a datasets array containing dataset IDs and titles.
- Failure: Returns error details (e.g., invalid organization ID or missing parameters). Note that if the organization ID or name is incorrect or does not exist in the platform’s catalog, a 404 Not Found error will be returned. Ensure the organization ID or name is valid by checking the platform’s catalog, and be mindful of language (Arabic vs. English) or formatting requirements.
Workflow Example
1. Identify the organization ID or name from the platform’s catalog.
2. Execute the Organization Details Retrieval action with version (Required)=-1 and one of the following: organization (Required)=org-1234-5678-9012-3456, organization (Required)=وزارة الصحة, or organization (Required)=Ministry of Health.
3. Process the response to display organization details or retrieve associated dataset IDs.
Workflow Creation with the Connector
Example Workflow: Accessing and Downloading Dataset Resources
Retrieve Dataset Metadata
- Use the Dataset Metadata Retrieval action with version (Required)=-1 and one of the following: dataset (Required)=565f4740-b454-4512-89af-065b80177324, dataset (Required)=إحصاءات السكان 2025, or dataset (Required)=Population Statistics 2025 from the platform’s catalog to fetch metadata.
- Review metadata to confirm the dataset’s relevance (e.g., check titleEn or categories).
Retrieve Dataset Resources
- Execute the Dataset Resources Retrieval action with version (Required)=-1 and one of the following: dataset (Required)=565f4740-b454-4512-89af-065b80177324, dataset (Required)=إحصاءات السكان 2025, or dataset (Required)=Population Statistics 2025.
- Parse the resources array to identify the desired resource based on format (e.g., CSV) or name.
Download Resource
- Extract the downloadUrl (e.g., https://example.data.gov.sa/download/resource-csv-001.csv) from the selected resource.
- Use the URL to download the file for analysis or integration.
Retrieve Organization Details
If needed, use the Organization Details Retrieval action with version (Required)=-1 and one of the following obtained from the dataset metadata: organization (Required)=org-1234-5678-9012-3456, organization (Required)=وزارة الصحة, or organization (Required)=Ministry of Health to fetch organization context.
Pricing
iSolution logo - white - transparent 250 px