byecode
  1. Datasheet API
byecode
  • 管理端
    • Workflow API
      • 创建工作流
      • 发送微信公众号模板消息
      • 更新工作流
      • 更新工作流日志
      • 更新记录
      • 更新并启用工作流
      • trigger action
      • 复制工作流
      • 创建工作流日志
      • 创建记录
      • activeWxRobotAction
      • 激活发送微信小程序订阅消息节点
      • 执行子流程节点
      • activeStationMessageAction
      • activeSendEmailAction
      • 执行过滤器
      • activeDingTalkRobotAction
      • 激活代码执行节点动作流
      • 阿里云发送消息
      • 获取工作流的列表
      • 获取工作流详情
      • getWorkflowLog
      • 获取使用了当前子流程的所有节点
      • Get the execution logs for all workflows.
      • 启用或关闭工作流
      • 删除工作流
    • User API
      • 增加用户
      • 管理端新用户注册时的用户信息收集
      • 更新用户信息
      • 修改用户密码
      • 用户完成任务
      • 完善用户信息
      • 用户解除绑定微信
      • 获取指定用户头像和昵称
      • 获取当前用户信息
      • 获取用户最后浏览位置
      • 生成API TOKEN
      • 用户绑定微信
    • Space API
      • 更新空间用户的角色
      • 创建空间
      • 批量添加用户到空间
      • 更新space
      • 获取空间列表
      • 获取应用列表
      • 获取空间内用户列表 未输入检索关键字时全部查询
      • Get the space usage
      • 获取指定空间信息
      • 获取当前空间所有版本的信息
      • Get the renewal orders in the spaces
      • leave space
      • 删除空间
    • Page API
      • create a page
      • 复制页面到指定语言版本
      • Batch add user groups that can view the page after getDingTalkAuthCode
      • updateApp a page
      • updateApp a Block
      • 提交表单内容
      • move a page
      • 主要用于发布之后的微信分享回显
      • create a Block
      • Get all pages from the app
      • get Record
      • get a page
      • get blocks
      • Remove user groups that have visibility permission to the specified page
      • delete a page
      • delete a Block
    • Integration API
      • install integration
      • 获取微信公众号消息模板列表
      • update integration
      • 获取微信小程序消息模板列表
      • 获取第三方应用列表
      • 获取一个集成的信息
      • 获取阿里云短信信息
      • 第三方应用连接测试
      • 检查网页扫码登录是否配置完全
      • ai modules
      • delete integration
    • Env API
      • 更新环境
      • 将应用版本切换到指定环境
      • 环境合并
      • 创建一个环境
      • 取消绑定用户表
      • 获取环境列表
      • 获取环境列表
      • 环境合并比较
      • 绑定用户表
      • 删除一个环境
    • Datasheet API
      • 将同步表切换到指定环境
        PUT
      • Copy ds
        PUT
      • Update record
        POST
      • Update the field in datasheet
        POST
      • Update the datasheet
        POST
      • Update the cell
        POST
      • Move the datasheet
        POST
      • Import Excel into a data sheet
        POST
      • Import Excel into a data sheet in append mode
        POST
      • Gets all record contents for the specified field (de-duplicate)
        POST
      • Retrieve one record from a specified data source
        POST
      • Retrieve a data sheet
        POST
      • Retrieve the schemas of multiple datasheets
        POST
      • Export datasheet to excel
        POST
      • Get the number of rows in data sheet
        POST
      • Delete a record
        POST
      • Delete a field in the datasheet
        POST
      • Create a sync data sheet
        POST
      • Create a record
        POST
      • Create a Joined datasheet
        POST
      • Create a field in datasheet
        POST
      • Create a data sheet
        POST
      • Create a analytics datasheet
        POST
      • Analytics datasheet data preview
        GET
      • 获取被同步表所在应用下所有环境下是否有该同步表
        GET
      • Retrieve a specific record from a data sheet
        GET
      • Deriving the actual data type based on a formula
        GET
      • Retrieve the schema of the datasheet
        GET
      • Delete a data sheet
        DELETE
    • App API
      • 分享到邮箱
      • 创建应用版本
      • 创建应用断点
      • Create an application
      • 通过模板创建应用
      • 创建分析配置
      • 复制应用
      • Update an application
      • 更新应用同步block配置
      • 更新应用状态,包含应用上线和离线
      • 更新页面全局导航栏配置
      • Update the domain of the application
      • 更新应用断点
      • Update an application
      • 更新分析配置
      • 切换到指定应用版本
      • 更新版本预览状态
      • 应用合并到线上版本并删除当前版本
      • 查找引用
      • 创建应用同步block
      • 应用版本列表
      • 模板组件列表
      • Get all data sheets in the current application
      • Get all data sheets in the current application
      • 版本是否有更新
      • 获取同步组件Block列表
      • Get the binding status of a custom domain
      • 获取使用指定环境的应用
      • Retrieve the basic information of an application
      • 获取分析配置
      • Create an application
      • 应用断点列表
      • 删除指定应用版本
      • 批量删除同步block
      • 删除应用同步block配置
      • 删除应用断点
      • Delete an application
      • 删除分析配置
    • View API
      • Retrieve the number of rows in a view
      • Retrieve view data
      • Get view groups
      • Retrieve the chart data
      • Export view
      • exportTemplate
      • Export the chart data
      • Bulk delete records in the view
      • Retrieve template list
      • Delete template
    • Pay API
      • upgrade the space plan
      • purchase traffic package in space
      • purchase sms package in space
      • get the pay status
    • Oss API
      • 上传资源到公共空间
      • oss上传文件到应用
      • 上传模板到数据源
    • Analysis API
      • 页面分析
      • 流量趋势
      • 流量来源
      • 地区分布
      • 核心指标
    • Wechat Open API
      • wechat
      • callback
      • 微信支付回调
      • thirdPartyMsgCallback
      • thirdPartyEventCallback
      • verifyUrl
      • thirdPartyAuthCallback
      • poll
      • getLoginQr
    • Open API
      • 获取登录用的短信验证码,该短信接口不需要鉴权
      • 刷新JWT Token
      • 应用健康警告
      • upgradeOneMiniProgram
      • upgradeMiniProgram
      • upgradeMiniProgramList
      • 获取表单验证的验证码
      • auditingMiniprogram
      • Heath check
      • 检查用户是否已经登录
      • 获取模板列表
      • Retrieve the basic information of an application
      • 获取活动列表
      • auditingMiniprogram_1
    • Pexels API
      • Get all pages from the app
    • Operation API
      • 获取更新通知
      • 获取更新活动
    • Admin API
      • reload caddy config
      • register
    • Mini Program API
      • 小程序提交审核
      • 保存小程序审核信息
      • 发布通过审核的小程序
      • 撤回代码审核
      • 获取微信小程序授权二维码
      • 获取体验版的二维码
      • 获取小程序的二维码
      • 获取小程序的信息
      • 小程序是否授权完成
  • 应用端
    • User API
      • 用户解除绑定
      • 用户绑定账号
      • perfectInfo
      • bindMobile
      • 获取当前用户信息
    • Workflow API
      • 发送微信公众号模板消息
      • 更新工作流日志
      • 更新记录
      • trigger action
      • 创建工作流日志
      • 创建记录
      • activeWxRobotAction
      • 执行子流程节点
      • activeStationMessageAction
      • activeSendEmailAction
      • activeDingTalkRobotAction
      • 激活代码执行节点动作流
      • 阿里云发送消息
    • Page API
      • 更新block
      • 提交表单内容
      • 获取页面的简要概括信息,主要用于SEO和微信分享等场景
      • get Record
      • 获取页面
      • 获取页面的所有block
    • Datasheet API
      • 获取视图的行数
      • 更新记录
      • 更新单元格
      • Import Excel into a data sheet in append mode
      • 获取视图数据
      • 获取视图分组
      • 获取指定字段的所有记录内容
      • 获取数据源配置信息
      • 获取指定数据源的一条记录
      • 获取数据源数据
      • 获取数据源图表视图(折线图、柱状图、饼状图)
      • Export Table to Excel
      • Export Table to Excel
      • exportTemplate
      • Export the chart data
      • 获取数据源的行数
      • 视图中批量删除记录
      • 删除record
      • 创建record
      • get Record
      • listTemplate
    • 动作模块
      • 执行微信支付
      • 执行stripe支付
      • 微信支付回调
      • wechat
      • callback
      • douyinCallback
      • stripe回调
      • 获取微信支付状态
      • 获取stripe支付状态
    • Block API
      • oss上传文件
    • Open API
      • 存储小程序订阅模板的订阅结果
      • 获取小程序需要订阅的模板列表
      • 小程序登录
      • 小程序授权
      • 获取数据源数据
      • 获取数据源的行数
      • 应用健康警告
      • 获取工作流的列表
      • 获取短信验证码,该短信接口不需要鉴权
      • 获取表单验证的验证码
      • PWA Manifest.json
      • poll
      • 获取app下的所有页面
      • 获取小程序预登录码
      • 判断当前用户小程序是否授权
      • 获取小程序订阅模板的结果
      • 获取一个 signature
      • getLoginQr
      • 获取邮箱验证码
      • 获取同步组件Block列表
      • csrf
      • SEO Injection
      • 健康检查
      • 获取指定应用的基础信息
      • 通过url获取应用id
    • App API
      • 事件收集
      • Get all data sheets in the current application
      • Get all data sheets in the current application
      • 是否有未读消息
      • 获取消息通知
      • 获取消息详情
      • 应用断点列表
    • Wechat Verify API
      • 微信域名验证
    • Integration API
      • 判断当前用户对此公众号是否授权
      • 根据code来获取微信公众号的访问凭据
      • 获取一个集成的信息
  • 升级
    • new-upgrade-controller
      • upgradeUmengLog
      • upgradeOne
      • upgradeList
      • upgradeAll
      • reUpgradeAll
  • miniprogram
  • login
    POST
  • 未命名接口
    GET
  • 未命名接口
    GET
  1. Datasheet API

Retrieve the schemas of multiple datasheets

POST
/lighthouse/admin/api/v1/ds/getDsSchemas

请求参数

Header 参数

Body 参数application/json必填

示例
{
    "envId": "string",
    "dsIds": [
        "string"
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/lighthouse/admin/api/v1/ds/getDsSchemas' \
--header 'Lang: zh-CN' \
--header 'B-App-Id: {{B-App-Id}}' \
--header 'B-App-User-Id: {{B-App-User-Id}}' \
--header 'B-Origin-Domain: {{B-Origin-Domain}}' \
--header 'Cookie: {{Cookie}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "envId": "string",
    "dsIds": [
        "string"
    ]
}'

返回响应

🟢200成功
*/*
OK
Body

示例
{
    "success": true,
    "msg": "string",
    "code": "string",
    "content": [
        {
            "viewOptions": {
                "dsId": "string",
                "tableProps": [
                    {
                        "id": "string",
                        "width": 0,
                        "visible": true
                    }
                ],
                "pagination": {
                    "pageSize": 0,
                    "currentPage": 0,
                    "custom": true
                },
                "joinConfig": {
                    "conditions": [
                        {
                            "joinedDsId": "string",
                            "joinType": "string",
                            "joinWhere": "string",
                            "joinConditions": [
                                {
                                    "leftFieldId": "string",
                                    "right": {
                                        "type": "VARIABLE",
                                        "fieldVariable": {
                                            "dsId": "string",
                                            "fieldId": "string"
                                        },
                                        "valueVariable": {
                                            "value": {},
                                            "type": "string"
                                        },
                                        "upstreamVariable": {
                                            "nodeId": "string",
                                            "fieldId": "string"
                                        },
                                        "fieldIdVariable": {
                                            "fieldId": "string"
                                        },
                                        "systemVariable": {
                                            "value": "TODAY",
                                            "format": "string"
                                        },
                                        "userVariable": {
                                            "fieldId": "string",
                                            "format": "string"
                                        },
                                        "inputVariable": {
                                            "blockId": "string",
                                            "scope": "string"
                                        },
                                        "viewVariable": {
                                            "fieldId": "string",
                                            "format": "string"
                                        },
                                        "filterVariable": {
                                            "blockId": "string",
                                            "itemId": "string"
                                        },
                                        "argVariable": {
                                            "nodeId": "string",
                                            "argId": "string"
                                        },
                                        "selectDataSourceVariable": {
                                            "dsId": "string",
                                            "fieldId": "string",
                                            "filter": {
                                                "expression": {
                                                    "idVariable": {},
                                                    "operator": "string",
                                                    "paramList": [
                                                        {}
                                                    ],
                                                    "where": "string",
                                                    "conditions": [
                                                        {}
                                                    ]
                                                }
                                            },
                                            "sorts": [
                                                {
                                                    "id": "string",
                                                    "fieldId": "string",
                                                    "order": "ASC"
                                                }
                                            ]
                                        },
                                        "pageLinkVariable": {
                                            "value": {}
                                        },
                                        "formVariable": {
                                            "fieldId": "string"
                                        },
                                        "resolvedVariable": {
                                            "value": {},
                                            "type": "string",
                                            "innerType": "ARRAY"
                                        },
                                        "routePathVariable": {
                                            "id": "string"
                                        },
                                        "routeQueryVariable": {
                                            "id": "string"
                                        },
                                        "pageDataQueryVariable": {
                                            "id": "string",
                                            "itemId": "string"
                                        },
                                        "pageStateVariable": {
                                            "id": "string"
                                        },
                                        "loopVariable": {
                                            "value": "LOOP_TIMES"
                                        }
                                    },
                                    "operator": "string"
                                }
                            ],
                            "joinFields": [
                                {
                                    "fieldId": "string",
                                    "name": "string"
                                }
                            ]
                        }
                    ],
                    "primaryDsId": "string"
                },
                "analyticConfig": {
                    "edges": [
                        {
                            "id": "string",
                            "source": "string",
                            "target": "string",
                            "sourceHandle": "string",
                            "type": "string",
                            "success": true
                        }
                    ],
                    "nodes": [
                        {
                            "id": "string",
                            "type": "DATA_INPUT",
                            "data": {
                                "empty": true,
                                "property1": {},
                                "property2": {}
                            },
                            "position": {
                                "x": 0,
                                "y": 0
                            }
                        }
                    ]
                },
                "draftAnalyticConfig": {
                    "edges": [
                        {
                            "id": "string",
                            "source": "string",
                            "target": "string",
                            "sourceHandle": "string",
                            "type": "string",
                            "success": true
                        }
                    ],
                    "nodes": [
                        {
                            "id": "string",
                            "type": "DATA_INPUT",
                            "data": {
                                "empty": true,
                                "property1": {},
                                "property2": {}
                            },
                            "position": {
                                "x": 0,
                                "y": 0
                            }
                        }
                    ]
                }
            },
            "name": "string",
            "createdBy": "string",
            "id": "string",
            "appId": "string",
            "appName": "string",
            "schema": {
                "property1": {
                    "dsId": "string",
                    "select": {
                        "sort": 0,
                        "multiple": true,
                        "options": [
                            {
                                "label": "string",
                                "color": "string",
                                "id": "string"
                            }
                        ]
                    },
                    "singleSelect": {
                        "sort": 0,
                        "options": [
                            {
                                "label": "string",
                                "color": "string",
                                "id": "string"
                            }
                        ]
                    },
                    "idConfig": {
                        "type": "CUSTOM",
                        "rules": [
                            {
                                "type": "DATE",
                                "length": 0,
                                "fixedCharacter": "string",
                                "dateFormat": "string"
                            }
                        ]
                    },
                    "formula": {
                        "expression": "string"
                    },
                    "number": {
                        "accuracy": 0,
                        "prefix": "string",
                        "suffix": "string"
                    },
                    "date": {
                        "format": "string"
                    },
                    "person": {
                        "multiple": true
                    },
                    "join": {
                        "joinDsId": "string",
                        "joinFieldId": "string"
                    },
                    "id": "string",
                    "name": "string",
                    "dsName": "string",
                    "type": "string",
                    "innerType": "string"
                },
                "property2": {
                    "dsId": "string",
                    "select": {
                        "sort": 0,
                        "multiple": true,
                        "options": [
                            {
                                "label": "string",
                                "color": "string",
                                "id": "string"
                            }
                        ]
                    },
                    "singleSelect": {
                        "sort": 0,
                        "options": [
                            {
                                "label": "string",
                                "color": "string",
                                "id": "string"
                            }
                        ]
                    },
                    "idConfig": {
                        "type": "CUSTOM",
                        "rules": [
                            {
                                "type": "DATE",
                                "length": 0,
                                "fixedCharacter": "string",
                                "dateFormat": "string"
                            }
                        ]
                    },
                    "formula": {
                        "expression": "string"
                    },
                    "number": {
                        "accuracy": 0,
                        "prefix": "string",
                        "suffix": "string"
                    },
                    "date": {
                        "format": "string"
                    },
                    "person": {
                        "multiple": true
                    },
                    "join": {
                        "joinDsId": "string",
                        "joinFieldId": "string"
                    },
                    "id": "string",
                    "name": "string",
                    "dsName": "string",
                    "type": "string",
                    "innerType": "string"
                }
            },
            "type": 0,
            "sync": true,
            "syncAppId": "string",
            "syncAppName": "string",
            "syncDsId": "string",
            "syncDsName": "string",
            "syncEnvId": "string",
            "syncEnvName": "string",
            "primaryName": "string",
            "envId": "string"
        }
    ]
}
修改于 2025-10-10 08:38:37
上一页
Retrieve a data sheet
下一页
Export datasheet to excel
Built with