数据结构

最近更新时间:2025-09-16 01:55:36

我的收藏

AppJobInfo

安装应用,任务详情

被如下接口引用:DescribeApps。

名称 类型 描述
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Step Integer 当前步骤
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Id Integer 任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
TotalStep Integer 任务总共步骤数
注意:此字段可能返回 null,表示取不到有效值。
示例值:13
StepDesc String 当前步骤详情
示例值:完成
ErrMsg String 错误信息
示例值:''

DataSourceDetail

数据源详情列表

被如下接口引用:DescribeDataSourceList。

名称 类型 描述
Id String 数据源 ID
示例值:jl_yy0gs82
Title String 数据源名称
示例值:数据源
Name String 数据源标识
示例值:jl_yy0gs83
Type String 数据源类型
示例值:datasource
Description String 数据源描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:数据源说明
Schema String 数据源配置
示例值:{"x-primary-column":"_id","x-id":"7b9e453","title":"","type":"object","x-index":1)
CmsProject String cms 项目状态, 0: 重新获取详情信息,1: 不需要重新获取详情信息
示例值:1
PkgId String 当前为环境 id
示例值:lowcode-we34fvsdf
SchemaVersion String schema 版本信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.6
CreatorId String 创建者用户 ID
示例值:0gs83
CreatedAt String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-11-10 12:00:00
UpdatedAt String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-11-10 12:00:00
EnvId String 环境 id
示例值:lowcode-wa2332
DataSourceVersion String 版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.1
AppUsageList Array of DataSourceLinkApp 所属应用数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Id":"app-abc"}
PublishedAt String 发布时间
示例值:2024-11-10 12:00:00
ChildDataSourceIds Array of String 子数据源ids
注意:此字段可能返回 null,表示取不到有效值。
示例值:jl_yy0gs84
Fun String 数据源发布信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"onlineVersion": 1, "previewVersion": 1, "onlinePublishAt": 1704256751993, "prviewPublishAt": 1704256745583}
ScfStatus Integer 云函数状态 1 Active 2 Creating 3 Updating 4 Deleting 9 Deleted 11 CreatFailed 12 UpdateFailed 13 DeleteFailed 21 UpdateTimeOut
示例值:1
Methods String 自定义方法
示例值:action1
ChildDataSourceNames Array of String 子数据源名数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:["jl_yy0gs85","jl_yy0gs86"]
IsNewDataSource Integer 是否旧数据源 1 新 0 旧
示例值:1
ViewId String 数据源视图id
注意:此字段可能返回 null,表示取不到有效值。
示例值:234233
Configuration String 数据源属性配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:cfg_23sa
TemplateCode String 外部数据源模板code
注意:此字段可能返回 null,表示取不到有效值。
示例值:tpl_2sewe32
Source Integer 外部数据源模板来源 0 空模板 1 腾讯文档 2 腾讯会议 3 企业微信 4 微信电商
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
PublishViewId String 发布视图id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2353342
SubType String 数据源子类型 "database" 标准模型 "custom-database" 自定义模型 "system" 系统模型 "connector" 连接器 "custom-connector" 自定义连接器 "hidden" 隐藏数据源
示例值:datasource_type
AuthStatus Integer 授权状态 0 授权无效 1 授权有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AuthInfo TicketAuthInfo 数据源授权信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"AuthUser":"abc"}
PublishStatus Integer 1发布0未发布
示例值:1
UpdateVersion Integer 更新版本
示例值:1
RelationFieldList Array of RelationField 模型关联关系字段列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Field":"abc"}
DbInstanceType String db实例类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:MYSQL
PreviewTableName String 体验环境db表名
注意:此字段可能返回 null,表示取不到有效值。
示例值:pre_createA
PublishedTableName String 正式环境db表名
注意:此字段可能返回 null,表示取不到有效值。
示例值:prod_createA
DbSourceType String DB来源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:internal_flexdb

DataSourceDetailItems

数据详情列表

被如下接口引用:DescribeDataSourceList。

名称 类型 描述
Rows Array of DataSourceDetail 数据详情列表
示例值:[{"id":"jl_yy0gs82","Title":"数据源title"},{"id":"jl_yy0gs83","Title":"数据源title3"}]
Count Integer 数据源列表总个数
示例值:1

DataSourceLinkApp

数据源关联App信息

被如下接口引用:DescribeDataSourceList。

名称 类型 描述
Id String 应用Id
示例值:app-xx
Title String 应用名称
示例值:MyApp
EditStatusUse Integer 是否编辑状态使用
示例值:1
PreviewStatusUse Integer 是否预览状态使用
示例值:1
OnlineStatusUse Integer 是否正式状态使用
示例值:1
DataSourceId String 数据源ID
示例值:data-xxx

DataSourceQueryOption

数据源模糊查询参数

被如下接口引用:DescribeDataSourceList。

名称 类型 必选 描述
LikeName String 数据源标识模糊匹配
示例值:data-3w6wEhrF
LikeTitle String 数据源名称模糊匹配
示例值:时间轴区块数据

DeleteKnowledgeDocumentSetRsp

删除文档出参

被如下接口引用:DeleteKnowledgeDocumentSet。

名称 类型 描述
AffectedCount Integer 删除文档数量。
示例值:10

DescribeKnowledgeDocumentSetDetailRsp

上传知识库文档返回结果

被如下接口引用:DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
Count Integer 获取的数量。
示例值:10
DocumentSet KnowledgeDocumentSet 文档信息

DescribeKnowledgeDocumentSetListRsp

删除文档出参

被如下接口引用:DescribeKnowledgeDocumentSetList。

名称 类型 描述
DocumentSets Array of QureyKnowledgeDocumentSet 文件集
Count Integer 条数
示例值:10

DocumentQuery

删除文档时查询入参

被如下接口引用:DeleteKnowledgeDocumentSet。

名称 类型 必选 描述
DocumentSetId Array of String 文件ids
示例值:docId
DocumentSetName Array of String 文件名集合
示例值:docName
Filter String 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式
示例值:filter

KnowledgeDocumentSet

文档信息

被如下接口引用:DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
DocumentSetId String 文档id
示例值:docId
DocumentSetName String 文档名
示例值:docName
Text String 文件完整内容。
示例值:我的文档
TextPrefix String 文件内容前 200个字符。
示例值:我的文档
DocumentSetInfo KnowledgeDocumentSetInfo 文件详情
SplitterPreprocess KnowledgeSplitterPreprocess 文件拆分信息
Name String 未使用
示例值:name
FileTitle String 文档标题
示例值:kent测试文件
FileMetaData String 文档元信息,必须为jsonstring
示例值:{"url": "https://ww.com\", "total": 3}
Author String 作者
示例值:bob
DocStatus String 上传文件状态
示例值:Ready
ErrMsg String 文件上传失败的具体原因
示例值:failed
FileId String Cos存储文件ID
示例值:cloud://aa.doc

KnowledgeDocumentSetInfo

文档信息

被如下接口引用:DescribeKnowledgeDocumentSetDetail。

名称 类型 描述
TextLength Integer 文件的字符数。
示例值:64
ByteLength Integer 文件的字节数。
示例值:256
IndexedProgress Integer 文件被预处理、Embedding 向量化的进度。
示例值:64
IndexedStatus String 文件预处理、Embedding 向量化的状态。
New:等待解析。
Loading:文件解析中。
Failure:文件解析、写入出错。
Ready:文件解析、写入完成。

示例值:Ready
CreateTime String 文件创建时间。
示例值:2020-01-01 00:00:00
LastUpdateTime String 文件最后更新时间。
示例值:2020-01-01 00:00:00
Keywords String 文件关键字。
示例值:key

KnowledgeSet

知识库信息

被如下接口引用:DescribeKnowledgeSetList。

名称 类型 描述
Name String 知识库标识
示例值:name
Title String 知识库名称
示例值:title
Desc String 描述
示例值:desc
Active String 状态,
NOT_ENABLED未启用
ENABLED 已启用
示例值:NOT_ENABLED
CreateTime String 创建时间
示例值:2024-06-04 11:16:49
UpdateTime String 更新时间
示例值:2024-06-04 11:16:49
Meta String 知识库的meta信息
示例值:meta
TotalSize String 知识库容量,单位字节
示例值:"1024"

KnowledgeSetRsp

查询知识库列表返回

被如下接口引用:DescribeKnowledgeSetList。

名称 类型 描述
Total Integer 总数
示例值:1
KnowledgeSets Array of KnowledgeSet 知识库列表

KnowledgeSplitterPreprocess

文件拆分信息

被如下接口引用:DescribeKnowledgeDocumentSetDetail, DescribeKnowledgeDocumentSetList。

名称 类型 描述
AppendTitleToChunk Boolean 在对文件拆分时,配置是否将 Title 追加到切分后的段落后面一并 Embedding。取值如下所示:
false:不追加。
true:将段落 Title 追加到切分后的段落。

示例值:true
AppendKeywordsToChunk Boolean 在对文件拆分时,配置是否将关键字 keywords 追加到切分后的段落一并 Embedding。取值如下所示:
false:不追加。
true:将全文的 keywords 追加到切分后的段落。

示例值:true

OrgResp

组织架构返回参数

被如下接口引用:DescribeRelatedUsers。

名称 类型 描述
OrgId String 部门id
OrgName String 部门名称
OrgIdentity String 部门标识
Level String 部门层级
PrimaryColumn String 主键字段

PageQuery

查询条件

被如下接口引用:DescribeKnowledgeDocumentSetList。

名称 类型 必选 描述
DocumentSetId Array of String 文件id数组,表示要查询的文件的所有 ID,支持批量查询,数组元素范围[1,20]。
示例值:docId
DocumentSetName Array of String 表示要查询的文档名称,支持批量查询,数组元素范围[1,20]。
示例值:docName
Limit Integer 取值范围:[1,16384]
示例值:10
Offset Integer 设置分页偏移量,用于控制分页查询返回结果的起始位置,方便用户对数据进行分页展示和浏览。
取值:为 limit 整数倍。
计算公式:offset=limit*(page-1)。
例如:当 limit = 10,page = 2 时,分页偏移量 offset = 10 * (2 - 1) = 10,表示从查询结果的第 11 条记录开始返回数据。

示例值:0
OutputFields Array of String 设置后,其他字段为空值
示例值:file
Filter String 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。
示例值:filter

QureyKnowledgeDocumentSet

搜索数据的集合

被如下接口引用:DescribeKnowledgeDocumentSetList。

名称 类型 描述
DocumentSetId String 文件id
示例值:docId
DocumentSetName String 文件名
示例值:docName
TextPrefix String 文件内容前 200个字符。
示例值:我的文档
SplitterPreprocess KnowledgeSplitterPreprocess 文件拆分信息
DocumentSetInfo QureyKnowledgeDocumentSetInfo 文件详情
FileTitle String 文件标题
示例值:kent测试文件
FileMetaData String 文件元信息,必须为jsonstring
示例值:{"url": "https://ww.com\", "total": 3}
Name String name
示例值:name
Author String 作者
示例值:bob
DocStatus String 文档上传状态
示例值:Ready
ErrMsg String 上传文件失败时具体的错误消息
示例值:xxx param invalid
FileId String Cos存储文件ID
示例值:cloud://aa.doc

QureyKnowledgeDocumentSetInfo

查询文件集合信息详情

被如下接口引用:DescribeKnowledgeDocumentSetList。

名称 类型 必选 描述
TextLength Integer 文件的字符数。
示例值:1024
ByteLength Integer 文件的字节数。
示例值:4096
IndexedProgress Integer 文件被预处理、Embedding 向量化的进度。
示例值:10
IndexedStatus String 文件预处理、Embedding 向量化的状态。
New:等待解析。
Loading:文件解析中。
Failure:文件解析、写入出错。
Ready:文件解析、写入完成。

示例值:Ready
IndexedErrorMsg String 错误信息
示例值:error
CreateTime String 文件创建时间。
示例值:2020-01-01 00:00:00
LastUpdateTime String 文件最后更新时间。
示例值:2020-01-01 00:00:00
Keywords String 文件关键字。
示例值:key

RelationField

数据源关联的的信息

被如下接口引用:DescribeDataSourceList。

名称 类型 描述
Field String 关联关系字段
示例值:name
Format String 关联关系格式
示例值:format_name
RelateDataSourceName String 关联数据源名称
示例值:sys_department

RoleGroup

权限组

被如下接口引用:DescribeRelatedUsers。

名称 类型 必选 描述
Id Integer 权限组id
注意:此字段可能返回 null,表示取不到有效值。
Name String 权限组名称
GroupIdentity String 权限组标识
GroupDesc String 权限组描述
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
RoleList Array of WedaRole 角色数组
注意:此字段可能返回 null,表示取不到有效值。

RoleListPage

角色分页

被如下接口引用:DescribeResourceRoleList。

名称 类型 描述
RoleList Array of WedaRole 角色列表
Total Integer 总数
示例值:1

SearchDocInfo

知识库搜索文档信息

被如下接口引用:SearchDocList。

名称 类型 描述
CollectionViewName String 知识库名称
示例值:collectionName
DocSetId String 文档Id
示例值:docId
DocSetName String 文档Name
示例值:docName
DocType String 文档类型
示例值:.md
FileTitle String 文档标题
示例值:title
FileMetaData String 文档元信息
示例值:{"foo":"bar"}
DocDesc String 文档描述
示例值:docDesc
FileSize Integer 文档大小
示例值:100
FileId String Cos存储文件ID
示例值:cloud://aa.doc

SearchDocRsp

知识库文档搜索结果

被如下接口引用:SearchDocList。

名称 类型 描述
DocInfos Array of SearchDocInfo 文档基本信息
示例值:[]
Total Integer 文档总数
示例值:0

TicketAuthInfo

数据源授权信息

被如下接口引用:DescribeDataSourceList。

名称 类型 描述
AuthUser String 授权用户
示例值:relation_data_depart

UploadKnowledgeDocumentSetRsp

上传知识库文档返回结果

被如下接口引用:UploadKnowledgeDocumentSet。

名称 类型 必选 描述
DocumentSetName String 文件名
示例值:docName
FileTitle String 文件标题
示例值:文件标题
FileMetaData String 文件元信息,为jsonstring
示例值:{"url":"url","title":"标题"}
FileId String Cos存储文件ID
示例值:cloud://aa.doc

Weapp

低码应用详情

被如下接口引用:DescribeApps。

名称 类型 描述
Id String 应用id
示例值:app-xxx
Owner String 应用所属者
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Name String 标识
示例值:test
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test app
Title String 应用名称
示例值:test
Env String 环境信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"envId": "lowcode-8gbx7ubrsss55ce1", "region": "ap-shang
Status Integer 状态.
0:已经安装
3:安装中
4:安装失败
示例值:0
EnvId String 环境信息
示例值:lowcode-8gbx7ubr7935sss1
EnvRegion String 环境地域
示例值:ap-shanghai
PkgId String 资源包
示例值:lowcode-8gbx7ubr7935sss1
CmsProject Integer 应用信息是否安装到cms
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Channel String 渠道
注意:此字段可能返回 null,表示取不到有效值。
示例值:weda
TemplateId String 模板id
注意:此字段可能返回 null,表示取不到有效值。
示例值:tepl-xxx
ExpireTime String 过期时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-08-26 15:28:19
CreateTime String 创建时间
示例值:2021-08-26 15:28:19
UpdateTime String 更新时间
示例值:2021-08-26 15:28:19
Source String 来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:source
IsFree Boolean 是否计费应用
示例值:0
ContentType String 应用内容类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:JSON
AppType Integer 应用类型,是否为B端应用
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AttachAppId String 关联B端一样id
注意:此字段可能返回 null,表示取不到有效值。
示例值:app-sdfds
EType Integer 应用类型,是否为企业应用
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EData String 企业应用数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:sss
LastMpCiId String 最新一次小程序构建id
注意:此字段可能返回 null,表示取不到有效值。
示例值:sas
LastMpCiStatus String 最新一次小程序状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
LastWebCiId String 最新一次web构建id
注意:此字段可能返回 null,表示取不到有效值。
示例值:sss
LastWebCiStatus String 最新一次web状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
LastDeployTime String 最新部署时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-08-26 15:28:19
FlowId Integer 安装任务id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
JobInfo AppJobInfo 任务详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
Platform String 应用端
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
LastWebCiMode Integer 最新一次web构建模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LastMpCiMode Integer 最新一次小程序构建模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SceneType String 应用场景化入口类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:data
ClientId String client_Id
注意:此字段可能返回 null,表示取不到有效值。
IconUrl String 图标地址
注意:此字段可能返回 null,表示取不到有效值。
FaviconUrl String 页面图标地址
注意:此字段可能返回 null,表示取不到有效值。
BackgroundColor String 图标背景色
注意:此字段可能返回 null,表示取不到有效值。
Favorite Boolean 应用是否收藏
示例值:true
PublishPlatform String 发布平台:web、mp、pc、adminPortal、xPagePC、cloudAdmin
示例值:cloudAdmin

WedaRole

weda角色

被如下接口引用:DescribeRelatedUsers, DescribeResourceRoleList。

名称 类型 描述
Name String 角色名称
示例值:""
RoleIdentity String 角色标识
示例值:""
Id Integer 角色id
示例值:1
ParentRoleId Integer 父角色id
示例值:1
ChildRoleId Integer 子角色id
示例值:1
EnvIdentity String 环境标识
示例值:""
IsReleased Boolean 是否已发布
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

WedaUser

weda用户

被如下接口引用:DescribeRelatedUsers。

名称 类型 描述
Uin Integer 腾讯云主账号uin
示例值:1
Name String 名字
示例值:test
Env Integer 环境
示例值:1
Type Integer 类型
示例值:1
NickName String 昵称
示例值:test
Email String 邮箱
示例值:test@qq.com
Phone String 手机号
示例值:1
ProjectId Integer 项目id
示例值:1
Uuid String 用户uuid
示例值:1
Source Integer 渠道,1:自建;2:企业微信导入
示例值:1
OpenId String 微信openid
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RelatedRoles Array of WedaRole 关联角色
注意:此字段可能返回 null,表示取不到有效值。
WechatUserId String 企业微信userid
注意:此字段可能返回 null,表示取不到有效值。
InternalUserType Integer 内部用户类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
UserId Integer 微搭用户id
示例值:1
OrgName String 所属部门名称
UserSchema String 用户schema
注意:此字段可能返回 null,表示取不到有效值。
UserExtend String 用户扩展信息
注意:此字段可能返回 null,表示取不到有效值。
IsLicensed Boolean 用户是否授权License
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
RelatedRoleGroups Array of RoleGroup 权限组数组
注意:此字段可能返回 null,表示取不到有效值。
Orgs Array of OrgResp 兼岗部门
注意:此字段可能返回 null,表示取不到有效值。
MainOrg Array of OrgResp 主岗部门
注意:此字段可能返回 null,表示取不到有效值。
ParentUserId Integer 直属上级
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
PrimaryColumn String 主列字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:_id
AvatarUrl String 用户头像
注意:此字段可能返回 null,表示取不到有效值。
LastLoginTime String 最后登录时间
示例值:2024-12-06 17:38:13