Guandata Open Platform
8.2.0
  • 8.3.0
  • 8.2.0
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
8.2.0
  • 8.3.0
  • 8.2.0
  1. Datasets
  • Users
    • Batch Create Users
      POST
    • Batch Delete Users
      POST
    • Batch Update User Attributes
      POST
    • Batch Check if Users Exist
      POST
    • Get User List by Attribute Value
      POST
    • Get User List
      POST
    • Get User Information via loginId
      POST
    • Modify User Status
      POST
  • Developer Guide
    • Token Authentication
    • Common Concepts
  • Datasets
    • Update Dataset Using Parquet File
      GET
    • Get Dataset List
      POST
    • Modify Dataset Path
      POST
    • Delete Dataset
      POST
    • Search Dataset List
      POST
    • Query Dataset Schema
      POST
    • Batch Update Dataset Update Mode
      POST
    • Get Users with Access Permission for Specified Dataset
      POST
    • Upload Dataset
      POST
    • Get Dataset Download Authorization Token
      GET
    • Download Dataset Data
      POST
    • Get Dataset Data
      POST
    • Create Dataset
      POST
    • Update Dataset Field Comments
      POST
    • Trigger Dataset to Read Data File and Update
      GET
    • Query Dataset Update Result by TaskID
      GET
    • Modify Dataset Schema
      POST
    • Update Dataset
      POST
    • Modify Dataset Field Alias
      POST
    • Modify Dataset Name
      POST
    • Dataset Preview API
      POST
    • Modify SQL Model Structure API
      POST
    • Get Dataset Folder List API (Supports Search by Specified Folder)
      POST
    • Batch Query Dataset Basic Information
      POST
    • Clear Dataset Data
      GET
    • Batch Query Dataset Permission Information
      POST
  • Dashboards
    • Get Dashboard/Page List
    • Search Pages by Name Keyword
    • Get Users with Read Permission for Specified Page
    • Get Page List in Tree Structure
    • Export Dashboard as PDF or Image
    • Get Dashboard Export File
    • Get Page Basic Information
    • Get Page Information
    • Get Dashboard Smart Insights
  • Subscriptions and Alerts
    • Query Subscription List
    • Query Alert List
    • Download Custom Channel Push File
    • Enable/Disable Subscription
    • Enable/Disable Alert
  • Cards
    • Get Card Data
    • Create Card Based on Dataset API (Random ID Generation)
    • Get Card Insight Agent
  • Permissions
    • Get Pages Accessible by Specified User
    • Get Datasets Accessible by Specified User
    • Modify Page Access and Ownership for Specified User
    • Modify Dataset Access and Ownership for Specified User
    • Get Pages Accessible by Specified User Group
    • Get Datasets Accessible by Specified User Group
    • Modify Page Access and Ownership for Specified User Group
    • Modify Dataset Access and Ownership for Specified User Group
    • General Resource Permission Grant and Revoke
    • Grant Resource Permissions to Specified User or User Group
    • Revoke Resource Permissions from Specified User or User Group
  • Resource Operations
    • Migrate Resources with Owner Permission from Specified User to User Group or User
    • Migrate Resources with Owner Permission from Specified User Group to User Group or User
    • Generic Resource List
  • Card Exports
    • Card Export API Usage Instructions
    • Public API Card Export
    • Public API Task Status Polling
    • public-api Card Export File Download
  • Sessions
    • Create or Update Session
    • Query Dataset Session Configuration
  • Folders
    • Create Folder
    • Modify Folder Directory
    • Delete Folder API
    • Add Folder Permission API
    • Delete Folder Permission API
    • Batch Query Folder Permission Information
  • Data Accounts
    • Create Data Account
  • Authentication
    • User Login
    • Login via User loginId
    • User Logout
  • User Management
    • User Management Overview
    • User Groups
      • Batch Create User Groups
      • Batch Modify User Groups
      • Delete Specified User Group
      • Get User Group List
      • Add Single User Group
      • Delete User Group V2 API
    • User Group Members
      • Add Users to User Group
      • Remove User from User Group
      • Get Directly Mounted Users Under Specified User Group
      • Get Direct User Groups of Specified User
    • Roles
      • Query Role Information for Specified User
      • Add Custom Role for User
      • Unbind Custom Roles for User
    • User Linked Accounts
      • Linked Account Configuration Introduction
      • Configure User External Associated Account
      • Delete User Associated Account
      • Query User External Linked Accounts
  • System Related
    • Get Monitoring Information
  • Metric Center
    • Get Metric Data
    • Get Metric Project
    • Get Folders Under Metric Project
    • Get Metrics Under Specified Project and Folder
    • Get Metric Details
  • Lineage
    • Query Resource Lineage
    • Query Field Lineage
  • Insight Agent
    • Create Insight Agent Task
    • Query Conversation Details
  1. Datasets

Trigger Dataset to Read Data File and Update

GET
/public-api/data-source/refresh-with-file
API Description
Core steps:
1.
Refer to the instructions below to copy the data file to the specified server location
2.
Call the API to update the specific dataset.
Special notes:
① This is a limited-time free API. Additional charges may apply in the future.
② The specific data file needs to be stored in the designated server location.
Non-minio environment: /home/guandata/data/guandata-store/upload_dataset/{dsid}
Minio environment: /home/guandata/data/minio/guandata-store/upload_dataset/{dsid}
③ File format requirements:
Snappy compression, written as file groups, avoid single large files
Escape the following special characters in field names: ' ', ',', ';', '{', '}', '(', ')', '\n', '\t', '=', '.'. Use '%' as the escape character, so '%' itself also needs escaping.
④ Similar to /public-api/data-source/:dsId/refresh-with-file, but that uses Personal Token while this uses Application Token.

Request

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/public-api/data-source/refresh-with-file?token&dsId&overwrite&fileType&preClean&subDir'

Responses

🟢200Success
application/json
Body

Example
{
    "result": "ok",
    "response": {
        "taskId": "1c30f9f0-6d7f-11ee-8cc2-bd5513e186d5",
        "status": "Submitted",
        "result": "Processing"
    }
}
Modified at 2026-07-15 06:40:16
Previous
Update Dataset Field Comments
Next
Query Dataset Update Result by TaskID