Guandata Open Platform
8.3.0
  • 8.3.0
  • 8.2.0
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
8.3.0
  • 8.3.0
  • 8.2.0
  1. Sessions
  • Users
    • Batch Create Users
      POST
    • Batch Delete Users
      POST
    • Batch Update User Attributes
      POST
    • Batch Check Users Exist
      POST
    • Get Users 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
    • Clear Dataset Data
      GET
    • 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 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
      POST
    • Modify SQL Model Structure
      POST
    • Get Dataset Folder List
      POST
    • Batch Query Dataset Basic Information
      POST
    • Batch Query Dataset Permissions
      POST
  • Dashboards
    • Get Dashboard/Page List
    • Search Pages by Name Keyword
    • Get Users with Read Permission for 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
  • Cards
    • Get Card Data
    • Create Card Based on Dataset (Random ID)
    • Get Card Insight Agent
  • Subscriptions and Alerts
    • Query Subscription List
    • Query Alert List
    • Query Notification Sending History
    • Download Custom Channel Push File
    • Enable/Disable Subscription
    • Enable/Disable Alert
  • Permissions
    • Get Pages Accessible by User
    • Get Datasets Accessible by User
    • Modify User Page Access and Ownership
    • Modify User Dataset Access and Ownership
    • Get Pages Accessible by User Group
    • Get Datasets Accessible by User Group
    • Modify User Group Page Access and Ownership
    • Modify User Group Dataset Access and Ownership
    • General Resource Permission Grant and Revoke
    • Grant Resource Permissions to User or User Group
    • Revoke Resource Permissions from User or User Group
  • Resource Operations
    • Migrate Resources with Owner Permission from Specified User
    • Migrate Resources with Owner Permission from User Group
    • Generic Resource List
  • Card Exports
    • Card Export API Guide
    • Public API Card Export
    • Public API Task Status Polling
    • Public API Card Export File Download
  • Sessions
    • Session Create or Update
      POST
    • Query Dataset Session Configuration
      GET
  • Folders
    • Create Folder
    • Modify Folder Directory
    • Delete Folder
    • Add Folder Permission
    • Delete Folder Permission
    • Batch Query Folder Permissions
  • Data Accounts
    • Create Data Account
  • Authentication
    • User Login
    • Login via loginId
    • User Logout
  • User Management
    • User Management Overview
    • User Groups
      • Batch Create User Groups
      • Batch Modify User Groups
      • Delete User Group
      • Get User Group List
      • Add Single User Group
      • Delete User Group V2
    • User Group Members
      • Add Users to User Group
      • Remove User from User Group
      • Get Direct Users Under User Group
      • Get Direct User Groups of User
    • Roles
      • Query Role Information for User
      • Add Custom Role for User
      • Unbind Custom Roles for User
    • User Linked Accounts
      • Linked Account Configuration Guide
      • Configure User External Associated Account
      • Delete User Associated Account
      • Query User External Linked Accounts
  • System Related
    • Get Monitoring Information
  • Metric Center
    • Get Metric Project
    • Get Folders Under Metric Project
    • Get Metrics Under Project and Folder
    • Get Metric Details
  • Lineage
    • Query Resource Lineage
    • Query Field Lineage
  • Insight Agent
    • Create Insight Agent Task
    • Query Conversation Details
  1. Sessions

Session Create or Update

POST
/public-api/session/createOrUpdate
API Description
Create or update session

Request

Body Params application/json

Example
{
    "token": "h96e55f6ad3144d428d592b7",
    "uIdToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkZXZpY2VUeXBlIjoiUEMiLCJzdWIiOiIxLWpUUktIVSsxNlNTdlVYdmNsMkpEZFJEZmxPV0VON01Ob3pZTzc3WXdzZ0VzcHB5YmY4Vm9LR2poaEI1SHlXODh4QXZiK0dTMnZVTGFrTnFLaDlaMHF0Qy9HSnNIOU1Uam42OWVibUpjUlFzQTNSNXciLCJhdXRvTG9nb3V0T25DbG9zZUVuYWJsZWQiOmZhbHNlLCJpc3MiOiJndWFuZGF0YS5jb20iLCJleHAiOjE3Mjk5MDYxNzYsImlhdCI6MTcyODY5NjU3OCwiaW5pdFRpbWUiOiIyMDI0LTEwLTEyIDA5OjI5OjM2LjQwNiIsImp0aSI6IjNhODY5YjY0MzI0MGRmMzUzOTQzZGUwZmY5ZmUzMjk1OWIxYTY0NmNmYmIxNDI3NjI5YTU0NjAzOTk5OGI3ODRmZjVlYjFmMWVmMmJiZjViNDNmNmY0Y2ZjOGIwNTY4NzMzMTY0ODkwMGI0ZjZhMjJlN2MzNTYwMTA5NWY5ZjBhNmJiOTJiNjU1ZjAyYzM4YjYwZWU5YjdiOGZlMjA3YjdjM2MwMDRiYTMzZTgwYjNkYjQxZDNiNzBiMzZlMDJjYWU2OTA1MTI0NGQ1OWM2ZTY1OGY4YjYxZTA5NGNlZDJiOGFhYzBhODU4OTg1NDJhMmQ2NGIwYjQ4NTc2ZDNjYzIiLCJwd2RWZXJzaW9uIjowLjB9.oBIv_VDHbJaeHcLBRW83H6_Gj4hedE2356RvUqCMW6Q",
    "bizType": "GLOBAL_PARAMETER",
    "data": [
        {
        "dsId": "k5652f88f33a4494abb7c97b",
        "dpId": "w0288f3ba99274e92b71891a",
        "dpName": "testDataset",
        "value": "12345"
        }
    ]
}

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 POST '/public-api/session/createOrUpdate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "h96e55f6ad3144d428d592b7",
    "uIdToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkZXZpY2VUeXBlIjoiUEMiLCJzdWIiOiIxLWpUUktIVSsxNlNTdlVYdmNsMkpEZFJEZmxPV0VON01Ob3pZTzc3WXdzZ0VzcHB5YmY4Vm9LR2poaEI1SHlXODh4QXZiK0dTMnZVTGFrTnFLaDlaMHF0Qy9HSnNIOU1Uam42OWVibUpjUlFzQTNSNXciLCJhdXRvTG9nb3V0T25DbG9zZUVuYWJsZWQiOmZhbHNlLCJpc3MiOiJndWFuZGF0YS5jb20iLCJleHAiOjE3Mjk5MDYxNzYsImlhdCI6MTcyODY5NjU3OCwiaW5pdFRpbWUiOiIyMDI0LTEwLTEyIDA5OjI5OjM2LjQwNiIsImp0aSI6IjNhODY5YjY0MzI0MGRmMzUzOTQzZGUwZmY5ZmUzMjk1OWIxYTY0NmNmYmIxNDI3NjI5YTU0NjAzOTk5OGI3ODRmZjVlYjFmMWVmMmJiZjViNDNmNmY0Y2ZjOGIwNTY4NzMzMTY0ODkwMGI0ZjZhMjJlN2MzNTYwMTA5NWY5ZjBhNmJiOTJiNjU1ZjAyYzM4YjYwZWU5YjdiOGZlMjA3YjdjM2MwMDRiYTMzZTgwYjNkYjQxZDNiNzBiMzZlMDJjYWU2OTA1MTI0NGQ1OWM2ZTY1OGY4YjYxZTA5NGNlZDJiOGFhYzBhODU4OTg1NDJhMmQ2NGIwYjQ4NTc2ZDNjYzIiLCJwd2RWZXJzaW9uIjowLjB9.oBIv_VDHbJaeHcLBRW83H6_Gj4hedE2356RvUqCMW6Q",
    "bizType": "GLOBAL_PARAMETER",
    "data": [
        {
        "dsId": "k5652f88f33a4494abb7c97b",
        "dpId": "w0288f3ba99274e92b71891a",
        "dpName": "testDataset",
        "value": "12345"
        }
    ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "result": "ok",
    "response": {
        "sessionId": {
            "domId": "guanbi",
            "sessionId": "6715c47d7904f25fe54571eeef0c92ef",
            "bizType": "GLOBAL_PARAMETER",
            "configData": "[{\"dpId\":\"x622a74c1378f484ea2a6cd1\",\"value\":\"12345\"}]",
            "expiredTime": "2024-11-22 09:41:07+0800"
        }
    }
}
Modified at 2026-07-14 14:06:45
Previous
Public API Card Export File Download
Next
Query Dataset Session Configuration