模型定义

应用

Account

账号

interface Account {
	id:string;//ID
	name:string;//名称
	avatar:string;//头像
	userName:string;//用户名
	mobileNo:string;//手机号
	email:string;//邮箱
	companyId:string;//团队ID
	oid:string;//第三方ID
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
	language:string;//语言
	needUpdatePassword:boolean;//是否需要重置密码
	isValid:boolean;//是否有效
}

AggregationQuery

聚合查询

interface AggregationQuery {
	func:string;//聚合函数
	fieldId:string;//聚合字段
	distinct:boolean;//是否去重
}

App

应用

interface App {
	id:string;//ID
	name:string;//名称
	icon:string;//图标
	color:string;//颜色
	appDefineId:string;//应用标识符
	logLevel:string;//日志级别
	env:string;//运行环境
	enableAppLog:boolean;//是否将日志输出到文件中(文本)
	enableAppJsonLog:boolean;//是否将日志输出到文件中(JSON)
	appDefineBuild:number;//发布编号
	appDefineVersion:string;//应用版本
	appDefineEditable:boolean;//是否允许应用设计
	createAccountId:string;//创建人
	updateAccountId:string;//更新人
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
}

AppDefine

应用配置

interface AppDefine {
	id:string;//ID
	name:string;//名称
	color:string;//颜色
	roleList:array<ObjectRef>;//角色列表
	moduleList:array<ObjectRef>;//模块列表
	automaticList:array<ObjectRef>;//自动化列表
	scriptList:array<ObjectRef>;//脚本列表
	scheduleList:array<ObjectRef>;//定时任务列表
	apiList:array<ObjectRef>;//API列表
	versionList:array<ObjectRef>;//版本列表
	eventList:array<AppEventDefine>;//事件列表
}

AppEvent

应用事件

interface AppEvent {
	id:string;//ID
	content:object;//内容
}

AppEventDefine

应用事件定义

interface AppEventDefine {
	id:string;//ID
	key:string;//标识符
	name:string;//名称
	remark:string;//备注
}

ApplicationProcess

应用进程

interface ApplicationProcess {
	id:string;//ID
	type:string;//类型
	associatedId:string;//关联ID
	associatedName:string;//关联名称
	associatedKey:string;//关联标识符
	startTime:Date;//开始时间
	endTime:Date;//结束时间
	status:string;//状态
	serverId:string;//服务器ID
}

CustomRole

应用自定义角色

interface CustomRole {
	id:string;//ID
	name:string;//名称
	remark:string;//备注
	permissionList:array<String>;//权限列表
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
}

Filter

过滤器

interface Filter {
	opt:string;//操作符
	conditionList:array<Condition>;//过滤条件
	children:array<Filter>;//子过滤条件
}

ModuleAlert

模块提示

interface ModuleAlert {
	moduleId:string;//模块标识符
	title:string;//提示信息的标题
	description:string;//提示信息的描述
	closeable:boolean;//是否可关闭
	modal:boolean;//是否模态显示
	center:boolean;//是否居中显示
	descriptionHtml:boolean;//描述字段是否使用html格式
	showIcon:boolean;//是否显示图标
	type:string;//提示类型，可选值为 success warning info error
}

ModuleFavorite

我的收藏

interface ModuleFavorite {
	id:string;//ID
	accountId:string;//账户ID
	applicationId:string;//应用ID
	moduleId:string;//模块ID
	moduleName:string;//模块名称
	moduleType:string;//模块类型
	moduleIcon:string;//模块图标
}

ObjectRef

对象关系

interface ObjectRef {
	id:string;//ID
	key:string;//标识符
	name:string;//名称
	icon:string;//图标
	type:string;//类型
	remark:string;//备注
	isDirectory:boolean;//是否目录
	children:array<ObjectRef>;//子节点
	expand:boolean;//扩展
	displayName:string;//显示名称
}

OrderBy

排序

interface OrderBy {
	field:string;//字段名
	type:string;//排序类型
}

PushEvent

推送事件

interface PushEvent {
	eventId:string;//事件ID，ModuleRefresh 刷新模块，RecordFormRefresh 刷新表单 ，Toast 显示提示信息
	moduleRefreshModuleId:string;//刷新的模块标识符
	recordFormRefreshTableId:string;//刷新的表单的数据表标识符
	recordFormRefreshRecordId:string;//刷新的表单的记录ID
	toastMessage:string;//提示信息内容
	recordFormCloseTableId:string;//记录所属数据表
	recordFormCloseRecordId:string;//表单记录ID
}

Query

查询条件

interface Query {
	filter:InformatFilter;//过滤器
	pageIndex:number;//页码，默认值：1
	pageSize:number;//每页大小，默认值：50
	orderByList:array<OrderBy>;//排序方式
	includeFields:LinkedHashSet;//返回字段列表
	excludeFields:Set;//包含字段列表
}

工作流

BpmnComment

工作流评论

interface BpmnComment {
	id:string;//ID
	createTime:Date;//创建时间
	userId:string;//用户ID
	taskId:string;//任务ID
	procInstId:string;//流程实例ID
	message:string;//消息
}

BpmnCommentQuery

工作流评论查询

interface BpmnCommentQuery {
	procInstId:string;//流程实例ID
	taskId:string;//任务ID
	executionId:string;//执行ID
	filter:InformatFilter;//过滤器
	pageIndex:number;//页码，默认值：1
	pageSize:number;//每页大小，默认值：50
	orderByList:array<OrderBy>;//排序方式
	includeFields:LinkedHashSet;//返回字段列表
	excludeFields:Set;//包含字段列表
}

BpmnIdentityLink

工作流身份关联

interface BpmnIdentityLink {
	id:string;//IdentityLink的唯一标识符
	type:string;//IdentityLink的类型，通常是participant（参与者）或candidate（候选人）
	userId:string;//与IdentityLink相关联的用户的ID
	groupId:string;//与IdentityLink相关联的用户角色的ID
	taskId:string;//工作流任务ID
}

BpmnInstance

工作流实例

interface BpmnInstance {
	id:string;//ID
	name:string;//实例名称
	procInstId:string;//工作流实例ID
	businessKey:string;//业务key
	procDefId:string;//工作流定义ID
	isActive:boolean;//ID
	startTime:Date;//开始时间
	endTime:Date;//结束时间
	taskCount:number;//任务数量
	startUserId:string;//发起人
	startUserName:string;//发起人名称
	startUserAvatar:string;//发起人头像
	procDefName:string;//工作流定义名称
	tenantId:string;//应用ID和模块ID
	deleteReason:string;//撤销原因
}

BpmnInstanceQuery

工作流实例查询

interface BpmnInstanceQuery {
	status:string;//实例状态，进行中 doing，已完成 done
	processDefineId:string;//工作流定义标识符
	name:string;//实例名称
	startUserId:string;//实例状态，进行中 doing，已完成 done
	startTimeStart:Date;//起始开始时间
	startTimeEnd:Date;//终止开始时间
	endTimeStart:Date;//起始结束时间
	endTimeEnd:Date;//终止结束时间
	varList:array<BpmnVar>;//工作流变量列表
	filter:InformatFilter;//过滤器
	pageIndex:number;//页码，默认值：1
	pageSize:number;//每页大小，默认值：50
	orderByList:array<OrderBy>;//排序方式
	includeFields:LinkedHashSet;//返回字段列表
	excludeFields:Set;//包含字段列表
}

BpmnProcess

工作流定义

interface BpmnProcess {
	id:string;//流程ID
	key:string;//标识符
	name:string;//名称
	icon:string;//图标
	remark:string;//描述
	color:string;//颜色标识
	rowNumber:number;//排序
	createTime:Date;//创建时间
	updateTime:Date;//最后修改时间
}

BpmnProcessDiagramConfig

工作流流程图

interface BpmnProcessDiagramConfig {
	imageType:string;//图片类型，默认png
	highLightedActivities:array<String>;//已完成流程任务
	highLightedFlows:array<String>;//已完成顺序流
	activityFontName:string;//流程任务字体名称
	labelFontName:string;//标签字体名称
	annotationFontName:string;//注释字体名称
	scaleFactor:double;//比例
	drawSequenceFlowNameWithNoLabelDI:boolean;//
}

BpmnProcessQuery

工作流定义查询

interface BpmnProcessQuery {
	accountId:string;//可以发起流程的账号ID
	name:string;//工作流名称
	filter:InformatFilter;//过滤器
	pageIndex:number;//页码，默认值：1
	pageSize:number;//每页大小，默认值：50
	orderByList:array<OrderBy>;//排序方式
	includeFields:LinkedHashSet;//返回字段列表
	excludeFields:Set;//包含字段列表
}

BpmnTask

工作流任务

interface BpmnTask {
	id:string;//ID
	name:string;//实例名称
	procDefId:string;//工作流定义ID
	procDefName:string;//工作流定义名称
	procInstId:string;//工作流实例ID
	procInstName:string;//工作流实例名称
	taskDefKey:string;//任务定义Key
	executionId:string;//任务执行ID
	tenantId:string;//应用ID和模块ID
	assignee:string;//责任人ID
	assigneeName:string;//责任人名称
	assigneeAvatar:string;//责任人头像
	delegation:string;//委托状态, 任务责任人委派 PENDING 委托人已解决任务 RESOLVED
	owner:string;//委托或转交人
	ownerName:string;//委托或转交人名称
	ownerAvatar:string;//委托或转交人头像
	startUserId:string;//发起人
	startUserName:string;//发起人名称
	startUserAvatar:string;//发起人头像
	dueDate:Date;//逾期时间
	claimTime:Date;//认领或指派时间
	startTime:Date;//开始时间
	endTime:Date;//完成时间
	duration:number;//持续时间
	deleteReason:string;//撤销原因
	lastUpdatedTime:Date;//最后更新时间
}

BpmnTaskCc

工作流任务抄送

interface BpmnTaskCc {
	id:string;//ID
	taskId:string;//任务ID
	copyUserId:string;//抄送用户
	startUserId:string;//发起人
	copyUserAvatar:string;//抄送用户头像
	copyUserName:string;//抄送用户名称
}

BpmnTaskQuery

工作流任务查询

interface BpmnTaskQuery {
	accountId:string;//责任人账号ID
	status:string;//状态,进行中 doing，已完成 done
	assignee:string;//指派类型，所有 all，指派给我 assignee，待认领 candidate，抄送给我 copy
	taskName:string;//任务名称
	procInstId:string;//流程ID
	createTimeStart:Date;//起始创建时间
	createTimeEnd:Date;//终止创建时间
	executionId:string;//任务执行ID
	filter:InformatFilter;//过滤器
	pageIndex:number;//页码，默认值：1
	pageSize:number;//每页大小，默认值：50
	orderByList:array<OrderBy>;//排序方式
	includeFields:LinkedHashSet;//返回字段列表
	excludeFields:Set;//包含字段列表
}

BpmnVar

工作流变量

interface BpmnVar {
	name:string;//变量名
	value:object;//值
	opt:string;//
}

团队

AppGroup

应用分组

interface AppGroup {
	id:string;//ID
	name:string;//名称
	rowNumber:number;//排序
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
}

Company

团队

interface Company {
	id:string;//ID
	name:string;//名称
	dbIndex:number;//数据库索引
	avatar:string;//团队logo
	favicon:string;//浏览器图标
	version:string;//当前套餐
	createAccountId:string;//创建人
	maxUserNum:number;//
	maxApplicationNum:number;//
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
}

CompanyMember

团队成员

interface CompanyMember {
	id:string;//账号ID
	name:string;//账号名称
	leaderList:array<String>;//直属上级列表
	roleList:array<String>;//角色列表
	departmentList:array<String>;//所在部门列表
	departmentKeyList:array<String>;//所在部门标识符列表
	dingtalkUserId:string;//钉钉账号ID
	weworkUserId:string;//企业微信账号ID
	feishuUserId:string;//飞书账号ID
	rowNumber:number;//排序权重
	createTime:Date;//创建时间
	updateTime:Date;//最后更新时间
}

CompanyRole

团队角色

interface CompanyRole {
	id:string;//标识符
	name:string;//名称
	isAdmin:boolean;//是否为管理员
	permissionIds:Set;//权限列表
	createTime:Date;//创建时间
}

InstallAppRequest

安装应用请求

interface InstallAppRequest {
	imrUrl:string;//imr文件URL
	groupId:string;//团队ID
	isForce:boolean;//是否强制
}

UpdateAppGroupRequest

更新应用团队请求

interface UpdateAppGroupRequest {
	imrUrl:string;//imr文件URL
	groupId:string;//团队ID
}

UpgradeAppRequest

升级应用请求

interface UpgradeAppRequest {
	appId:string;//应用ID
	imrUrl:string;//imr文件URL
	isForce:boolean;//是否强制
}

部门

Department

部门

interface Department {
	id:string;//ID
	name:string;//部门名称
	shortName:string;//简称
	remark:string;//描述
	parentId:string;//上级部门ID
	ownerList:array<String>;//负责人列表
	rowNumber:number;//排序
}

邮箱

EmailRecipient

email收件人

interface EmailRecipient {
	address:string;//地址
	personal:string;//姓名
	type:string;//发送类型
}

EmailServer

email服务器

interface EmailServer {
	host:string;//主机
	port:number;//端口
	ssl:boolean;//是否启用ssl
	auth:boolean;//是否启用认证
	account:string;//账号
	password:string;//密码
	protocol:string;//协议
}

Excel

TemplateCell

单元格模版

interface TemplateCell {
	content:object;//单元格值
	rowspan:number;//
	colspan:number;//
}

文件

File

文件

interface File {
	name:string;//文件名称
	path:string;//文件路径
	absolutePath:string;//绝对路径
	isAbsolute:boolean;//是否启用绝对路径
	canRead:boolean;//是否可读
	canWrite:boolean;//是否可编辑
	isDirectory:boolean;//是否为文件夹
	isFile:boolean;//是否为文件
	totalSpace:number;//文件大小
	usableSpace:number;//可用大小
	lastModified:number;//最后修改时间
	length:number;//长度
}

FTP

FtpFile

文件传输

interface FtpFile {
	group:string;//文件群组
	hardLinkCount:number;//链接数量
	link:string;//链接
	name:string;//文件名
	size:number;//文件大小
	timestamp:Calendar;//最后修改时间戳
	timestampInstant:Instant;//即时时间戳
	type:number;//文件类型
	user:string;//文件拥有者
	directory:boolean;//是否为文件夹
	file:boolean;//是否为文件
}

Http

HttpRequest

HTTP请求

interface HttpRequest {
	url:string;//请求地址
	method:string;//请求方法
	timeout:number;//超时毫秒数
	body:string;//请求体
	charset:string;//字符集
	followRedirect:boolean;//
	maxRedirectCount:number;//重定向次数
	headers:Map;//请求头
	form:Map;//请求表单
	files:Map;//请求文件
	storages:Map;//
}

Jdbc

ConnnectionInfo

数据库连接

interface ConnnectionInfo {
	dburl:string;//数据库连接串
	dbuser:string;//用户名
	dbpassword:string;//密码
	driverClassName:string;//驱动名称
	autoCommit:boolean;//是否自动提交事务，默认为true
}

JDBCResultSet

JDBC结果集

interface JDBCResultSet {
	rs:ResultSet;//结果集
}

Ldap

LdapConnectionInfo

LDAP连接

interface LdapConnectionInfo {
	initialContextFactory:string;//上下文服务提供者
	providerURL:string;//服务器地址
	securityAuthentication:string;//认证方式，none 不认证，simple 用户名密码认证
	securityPrincipal:string;//用户名
	securityCredentials:string;//密码
	referral:string;//服务器地址
}

LdapListResult

LDAP列表结果

interface LdapListResult {
	className:string;//
	name:string;//
	nameInNamespace:string;//
	isRelative:boolean;//
}

LdapModifyAttribute

LDAP属性列表

interface LdapModifyAttribute {
	id:string;//属性的ID
	value:object;//属性值
}

LdapSearchControl

搜索控制

interface LdapSearchControl {
	returningAttributes:String[];//返回的属性列表
	searchScope:string;//搜索的限定范围,默认为 SUBTREE。SUBTREE 返回所有满足条件的条目，ONELEVEL 返回同级的条目，OBJECT 只返回满足条件的对象
	countLimit:number;//返回的条目的最大数量
	timeLimit:number;//连接超时时间，单位为毫秒
	returningObjFlag:boolean;//是否返回对象
	derefLinkFlag:boolean;//JNDI links are dereferenced during
}

LdapSearchResult

LDAP返回搜索结果

interface LdapSearchResult {
	className:string;//
	name:string;//条目名称
	nameInNamespace:string;//条目的全路径
	object:object;//
	attributes:array<LdapSearchResultAttribute>;//条目的属性列表
}

LdapSearchResultAttribute

LDAP条目属性

interface LdapSearchResultAttribute {
	id:string;//属性的ID
	values:Object[];//属性值的列表
}

Mpp

MppCustomFieldValueDataType

自定义字段数据类型

interface MppCustomFieldValueDataType {
	value:number;//值
	maskValue:number;//掩码
	dataType:string;//数据类型
}

MppCustomFieldValueMask

MPP自定义字段掩码

interface MppCustomFieldValueMask {
	length:number;//长度
	level:number;//级别
	separator:string;//分隔符
	type:InformatMppCustomFieldValueDataType;//
}

MppWriterConfig

MPP配置文件

interface MppWriterConfig {
	microsoftProjectCompatibleOutput:boolean;//输出是否可以被MS Project读取，默认值为true
	splitTimephasedAsDays:boolean;//控制是否将分时分配数据拆分成天。默认值为true
	writeTimephasedData:boolean;//控制是否将分时资源分配数据写入文件。默认值为false
	saveVersion:string;//设置在生成MSPDI文件时要使用的保存版本,默认值Project2016
}

消息队列

MqMessage

消息队列消息

interface MqMessage {
	body:object;//消息体
	props:InformatMqMessageProperties;//消息参数
}

MqMessageProperties

消息参数

interface MqMessageProperties {
	headers:Map;//消息头
	timestamp:Date;//消息的时间戳，消息生成的时间。
	messageId:string;//消息ID
	userId:string;//发送用户
	appId:string;//发生应用ID
	clusterId:string;//集群ID
	type:string;//消息的类型
	correlationId:string;//关联请求和响应的ID
	replyTo:string;//指定接收响应的队列名称
	contentType:string;//消息内容的MIME类型
	contentEncoding:string;//消息内容的编码方式
	contentLength:number;//消息内容长度
	deliveryMode:string;//消息的持久性，2表示持久化消息，1表示非持久化消息。
	expiration:string;//消息的过期时间，单位为毫秒。
	priority:number;//消息的优先级，数值越高优先级越高。
	redelivered:boolean;//是否已发送
	receivedExchange:string;//接收交换机
	receivedRoutingKey:string;//接收路由
	receivedUserId:string;//接收用户
	deliveryTag:number;//接收标志
	messageCount:number;//消息数量
	consumerTag:string;//消费标记
	consumerQueue:string;//消费队列
	receivedDelay:number;//接收时延
	receivedDeliveryMode:string;//接收模式
	finalRetryForMessageWithNoId:boolean;//最后重试
	publishSequenceNumber:number;//发布序列号
	lastInBatch:boolean;//是否最后一个
	projectionUsed:boolean;//投影
}

MqPublishSetting

消息发布设置

interface MqPublishSetting {
	expiration:number;//生效时长 单位：毫秒
	priority:number;//优先级
	deliveryMode:number;//投递模式
	waitForConfirms:boolean;//是否等待确认
}

通知

Notification

通知

interface Notification {
	id:string;//系统通知ID
	accountId:string;//账号ID
	companyId:string;//团队ID
	applicationId:string;//应用ID
	name:string;//通知标题
	type:string;//类型。openbpmntask：打开Bpmn任务，openurl：打开链接，openrecord：打开数据表记录
	content:string;//通知内容
	data:string;//与类型对应的附加信息
	isRead:boolean;//是否已读
	isWebSend:boolean;//web是否发送
	isWeworkSend:boolean;//企业微信是否发送
	isDingTalkSend:boolean;//钉钉是否发送
	isFeishuSend:boolean;//飞书是否发送
	isCustomSend:boolean;//自定义通知是否发送
	createTime:Date;//创建时间
	updateTime:Date;//更新时间
}

NotificationBpmnTaskSetting

工作流任务配置信息

interface NotificationBpmnTaskSetting {
	taskId:string;//任务ID
	moduleId:string;//模块ID
}

NotificationForm

系统通知表单

interface NotificationForm {
	title:string;//标题
	content:string;//内容
	accountId:string;//账号ID
	type:string;//类型。openbpmntask：打开Bpmn任务，openurl：打开链接，openrecord：打开数据表记录
	name:string;//
	urlSetting:InformatNotificationUrlSetting;//链接配置信息。类型为openurl时，配置信息生效
	recordSetting:InformatNotificationReocrdSetting;//数据表记录配置信息。类型为openrecord时，配置信息生效
	bpmnTaskSetting:InformatNotificationBpmnTaskSetting;//工作流任务配置信息。类型为openbpmntask时，配置信息生效
}

NotificationReocrdSetting

数据表记录配置信息

interface NotificationReocrdSetting {
	recordId:string;//记录ID
	moduleId:string;//模块ID
}

NotificationUrlSetting

链接配置信息

interface NotificationUrlSetting {
	url:string;//链接地址
	isAppURL:boolean;//是否应用内链接
}

SFTP

SftpFile

SFTP文件

interface SftpFile {
	filename:string;//文件名称
	longname:string;//长名称
	attrs:SftpFileAttr;//文件属性列表
}

共享存储

ConvertFormatResult

格式转换结果

interface ConvertFormatResult {
	endConvert:boolean;//是否转换完成
	error:number;//错误类型
	fileTyp:string;//转换文件的扩展名
	fileUrl:string;//文件url
	percent:number;//转换百分比
}

ConvertFormatSetting

格式转换配置

interface ConvertFormatSetting {
	fileType:string;//定义要转换的文档文件的类型。(必须)
	outputtype:string;//定义生成的转换文档类型。(必须)
	password:string;//如果文档文件受密码保护，则定义该文件的密码。(可选)
	region:string;//定义从电子表格格式转换为pdf时货币和日期和时间的默认显示格式。(可选)
	spreadsheetLayout:SpreadsheetLayout;//定义用于将电子表格转换为 pdf 的设置。(可选)
	thumbnail:Thumbnail;//将图像格式（bmp、gif、jpg、png）指定为outputtype时，定义缩略图的设置
	title:string;//定义转换后的文件名
}

SpreadsheetLayout

电子表格布局

interface SpreadsheetLayout {
	fitToHeight:number;//设置转换区域的高度，以页数为单位。默认值为0。
	fitToWidth:number;//设置转换区域的宽度，以页数为单位。默认值为0。
	gridLines:boolean;//允许在输出 PDF 文件中包含或不包含网格线。默认值为false。
	headings:boolean;//允许在输出 PDF 文件中包含或不包含标题。默认值为false。
	ignorePrintArea:boolean;//确定是否忽略为电子表格文件选择的打印区域。默认值为true。
	margins:SpreadsheetLayoutMargins;//设置输出 PDF 文件的边距。
	orientation:string;//设置输出 PDF 文件的方向。可能是landscape，portrait。默认值为portrait。
	pageSize:SpreadsheetLayoutPageSize;//设置输出 PDF 文件的尺寸
	scale:number;//允许设置输出 PDF 文件的比例。默认值为100。
}

SpreadsheetLayoutMargins

电子表格边距

interface SpreadsheetLayoutMargins {
	bottom:string;//设置输出 PDF 文件的下边距。默认值为19.1 毫米。
	left:string;//设置输出 PDF 文件的左边距。默认值为17.8 毫米。
	right:string;//设置输出 PDF 文件的右边距。默认值为17.8 毫米。
	top:string;//设置输出 PDF 文件的上边距。默认值为19.1 毫米。
}

SpreadsheetLayoutPageSize

电子表格尺寸

interface SpreadsheetLayoutPageSize {
	height:string;//设置输出 PDF 文件的页面高度。默认值为297 毫米。
	width:string;//设置输出 PDF 文件的页面宽度。默认值为210 毫米。
}

Thumbnail

略缩图

interface Thumbnail {
	aspect:number;//定义使图像适合指定的高度和宽度的模式。
	first:boolean;//定义是仅为第一页还是为所有文档页面生成缩略图。默认值为true
	height:number;//以像素为单位定义缩略图高度。默认值为100。
	width:number;//以像素为单位定义缩略图宽度。默认值为100
}

问卷调查

SurveyField

问卷调查字段

interface SurveyField {
	id:string;//字段ID
	icon:string;//字段图标
	group:string;//字段分组
	type:string;//字段类型
	name:string;//字段名称
	setting:Map;//字段配置
}

SurveyItem

调查问卷

interface SurveyItem {
	applicationId:string;//应用ID
	moduleId:string;//模块ID
	id:string;//调查问卷ID
	tableId:string;//问卷表ID
	name:string;//调查问卷名称
	remark:string;//备注
	startTime:Date;//开始时间
	endTime:Date;//终止时间
	submitCount:number;//填写数量
	lastSubmitTime:Date;//最后填写时间
	createAccountId:string;//创建者账号ID
	updateAccountId:string;//更新账号ID
	sourceId:string;//源ID
	createTime:Date;//创建时间
	updateTime:Date;//更新时间
	uuid:string;//UUID
	isEnable:boolean;//是否启用
	rowNumber:number;//排序
	fieldList:array<SurveyItemField>;//问卷字段
	createAccountAvatar:string;//创建者头像
	createAccountName:string;//创建者名称
	defineId:string;//调查问卷定义ID
}

SurveyItemDefine

调查问卷定义

interface SurveyItemDefine {
	id:string;//ID
	key:string;//标识符
	scope:string;//范围
	name:string;//名称
	remark:string;//备注
	createTime:string;//创建时间
	tableId:string;//数据表ID
	fieldList:array<SurveyField>;//字段列表
	submitEdit:boolean;//提交后能否编辑
	allowResubmit:boolean;//允许重复提交
	openIdFieldId:string;//存储微信openId
	finishText:string;//提交完成后的提示
	authType:string;//鉴权方式
	hideSupport:boolean;//隐藏支持
}

系统

LoginForm

登录表单

interface LoginForm {
	userName:string;//用户名
	password:string;//密码
	type:string;//登录类型
	ip:string;//IP
}

LoginResult

登录结果

interface LoginResult {
	errorCode:number;//错误码
	errorMessage:string;//错误信息
	token:string;//token
	accountId:string;//账号ID
	companyId:string;//团队ID
	defaultApplicationId:string;//默认应用ID
}

ProcessRunArgs

运行参数

interface ProcessRunArgs {
	cmds:String[];//命令
	timeout:number;//超时时间,毫秒数,0表示忽略超时
}

ProcessRunResult

运行结果

interface ProcessRunResult {
	exitValue:number;//退出码
	out:string;//标准输出
	err:string;//错误输出
}

RunNodeJSArgs

NodeJS运行参数

interface RunNodeJSArgs {
	script:string;//执行的脚本文件 例如:test/helloworld.js
	cmdline:array<String>;//操作系统对命令行参数的长度有限制，linux下最长131071，如果需要传递大量数据需要使用stdin传递
	stdin:string;//标准输入
	env:Map;//环境变量
}

数据表

Condition

查询条件

interface Condition {
	fieldId:string;//字段ID
	opt:string;//比较类型
	value:object;//比较值
	func:string;//函数
	var:boolean;//true是表达式
	formula:boolean;//是否是函数
	ignoreNull:boolean;//是否忽略NULL
}

DataAutomaticVar

自动化参数

interface DataAutomaticVar {
	value:string;//参数值
}

DefaultValue

数据表默认值

interface DefaultValue {
	fieldId:string;//字段ID
	value:string;//表达式
}

DeleteRecordConfig

删除记录配置

interface DeleteRecordConfig {
	disableCalculateRollupField:boolean;//是否不计算查找汇总字段,默认false表示计算汇总字段
}

FilterCondition

过滤条件

interface FilterCondition {
	opt:string;//操作符
	conditionList:array<Condition>;//过滤器
	children:array<FilterCondition>;//子过滤器
}

InsertRecordConfig

记录插入配置

interface InsertRecordConfig {
	disableCalculateRollupField:boolean;//是否不计算查找汇总字段,默认false表示计算汇总字段
}

Table

数据表

interface Table {
	id:string;//ID
	name:string;//名称
	key:string;//标识符
}

TableAccountSimple

账号

interface TableAccountSimple {
	id:string;//ID
	name:string;//名称
	avatar:string;//头像
}

TableAttachment

附件

interface TableAttachment {
	name:string;//名称
	size:number;//大小
	id:string;//ID
	thumbnail:string;//略缩图
	path:string;//路径
	md5:string;//MD5值
}

TableChangeLog

变更日志

interface TableChangeLog {
	id:string;//ID
	recordId:string;//记录ID
	fieldName:string;//字段名称
	beforeValue:string;//变更前的值
	afterValue:string;//变更后的值
}

TableComment

评论

interface TableComment {
	comment:string;//内容
	createTime:Date;//创建时间
	createUserAvatar:string;//创建者头像
	createUserId:string;//创建者用户ID
	createUserName:string;//创建者用户名称
	id:number;//ID
	isDelete:boolean;//是否删除
	parentId:number;//父评论ID
	recordId:string;//记录ID
}

TableCommentForm

评论表单

interface TableCommentForm {
	recordId:string;//记录ID
	parentId:number;//父评论ID
	content:string;//内容
	createUserId:string;//创建者账号ID
}

TableCommentItem

评论

interface TableCommentItem {
	type:string;//类型
	text:string;//评论值
	content:array<TableCommentItem>;//子评论
}

TableField

数据表字段

interface TableField {
	id:string;//ID
	name:string;//字段名称
	key:string;//标识符
	type:string;//字段类型
}

TableFieldInfo

数据表字段信息

interface TableFieldInfo {
	id:string;//ID
	name:string;//字段名称
	key:string;//标识符
	type:string;//字段类型
	icon:string;//图标
	group:string;//分组
	displayWidth:number;//显示宽度
	readonly:boolean;//是否只读
	editableExpression:string;//可修改条件表达式
	hidden:boolean;//是否隐藏
	visibleExpression:string;//可见条件表达式
	attachmentSetting:InformatAttachmentSetting;//附件配置
	treeSetting:InformatTreeSetting;//树形选择配置
	cascaderSetting:InformatCascaderSetting;//级联选择配置
	checkboxSetting:InformatCheckboxSetting;//复选框配置
	childrenSetting:InformatChildrenSetting;//子对象配置
	colorSetting:InformatColorSetting;//颜色配置
	coordinateSetting:InformatCoordinateSetting;//地理位置坐标配置
	createTimeSetting:InformatCreateTimeSetting;//创建时间配置
	createUserSetting:InformatCreateUserSetting;//创建人配置
	customSetting:InformatCustomSetting;//自定义组件配置
	dateSetting:InformatDateSetting;//日期配置
	departmentSetting:InformatDepartmentSetting;//部门选择配置
	doubleSetting:InformatDoubleSetting;//小数
	formulaSetting:InformatFormulaSetting;//函数
	iDSetting:InformatIDSetting;//编号
	indexNumberSetting:InformatIndexNumberSetting;//子对象编号
	integerSetting:InformatIntegerSetting;//整数配置
	lastModifyTimeSetting:InformatLastModifyTimeSetting;//最后修改时间配置
	lastModifyUserSetting:InformatLastModifyUserSetting;//最后修改用户配置
	memberSetting:InformatUserSetting;//成员配置
	multiTextSetting:InformatMultiTextSetting;//多行文本配置
	rateSetting:InformatRateSetting;//评分
	relationRecordFieldSetting:InformatRelationRecordFieldSetting;//关联记录字段配置
	lookupListSetting:InformatLookupListSetting;//查找列表配置
	lookupRollupSetting:InformatLookupRollupSetting;//查找汇总配置
	relationRecordSetting:InformatRelationRecordSetting;//关联记录配置
	relationRollupSetting:InformatRelationRollupSetting;//关联汇总配置
	relationSetting:InformatRelationSetting;//关联列表配置
	richTextSetting:InformatRichTextSetting;//富文本配置
	signatureSetting:InformatSignatureSetting;//签名配置
	listSelectSetting:InformatListSelectSetting;//列表选择配置
	singleTextSetting:InformatSingleTextSetting;//单行文本配置
	staticTextSetting:InformatStaticTextSetting;//静态文本配置
	timeSetting:InformatTimeSetting;//时间配置
	userSetting:InformatUserSetting;//用户配置
	uUIDSetting:InformatUUIDSetting;//UUID配置
	seqSetting:InformatSeqSetting;//序列号配置
	validateRuleList:array<ValidateRule>;//校验规则
	defaultValueExpression:string;//创建时使用 动态取值
	defaultValueRuleList:array<DefaultValueRule>;//默认值动态取值，字段变化时使用
	appId:string;//应用ID
	tableId:string;//数据表ID
	targetAppId:string;//目标应用ID，只有关联记录字段才会有值
	requiredExpression:string;//必填条件表达式
	enableChangeLog:boolean;//是否启用变更记录
	changeLogAccessRoleList:array<String>;//变更记录可访问角色列表
	disableTooltipExpression:string;//在表单中不可编辑时字段提示语
}

TableInfo

数据表信息

interface TableInfo {
	id:string;//ID
	table:InformatTable;//数据表
	tableFieldList:array<TableField>;//数据表字段列表
}

TableQuerySetting

数据表查询配置

interface TableQuerySetting {
	forUpdate:boolean;//是否锁定行
	returnOptionName:boolean;//如果有`列表选择`、`级联选择`、`树形选择`字段，同时会返回选项值名称
	includeFields:LinkedHashSet;//返回包括字段
}

TableRecordQuery

数据表查询条件

interface TableRecordQuery {
	filter:InformatFilter;//过滤条件
	pageIndex:number;//分页页码
	pageSize:number;//分页大小
	orderByList:array<OrderBy>;//排序方式
	groupByList:array<String>;//分组查询
	returnOptionName:boolean;//返回optionName
	aggregationQueryList:array<AggregationQuery>;//聚合查询
	includeFields:LinkedHashSet;//返回字段列表
}

TableSearchSetting

数据表搜索配置

interface TableSearchSetting {
	searchChildrenFieldId:string;//搜索子对象ID
	searchTableIndex:boolean;//显示序号
	searchTableBorderStyle:string;//表格边框样式
	searchTableStripe:boolean;//显示条纹
	searchTableHideHeader:boolean;//隐藏表头
	searchChildrenFullPath:boolean;//显示子对象全路径
	searchChildrenDefaultLevel:number;//子对象默认层级为1
	searchColumnList:array<TableColumnSetting>;//可搜索字段列表
	searchFilterId:string;//表单内可选数据过滤器
	searchFilterConditionList:array<ConditionSetting>;//过滤条件
	searchOrderByList:array<OrderBy>;//排序方式
	searchTableCellStyleList:array<TableViewSettingCellStyle>;//单元格样式
	searchTableSelectionDisableExpression:string;//行记录隐藏表达式
	filterSearchFilterId:string;//筛选条件可选数据过滤器
	searchFilterVarList:array<SearchFilterVar>;//筛选条件
}

TableSignature

手写签名

interface TableSignature {
	id:string;//ID
	accountId:string;//账户ID
	accountName:string;//账户名称
	uploadTime:Date;//上传时间
	path:string;//路径
}

UpdateRecordConfig

记录更新配置

interface UpdateRecordConfig {
	enableChangeLog:boolean;//是否启用变更记录,默认false
	disableCalculateRollupField:boolean;//是否不计算查找汇总字段,默认false表示计算汇总字段
}

SearchFilterVar

筛选条件

interface SearchFilterVar {
	id:string;//ID
	valueExpression:string;//条件表达式
}

用户

User

用户

interface User {
	id:string;//ID
	name:string;//名称
	avatar:string;//头像
	roleList:array<String>;//角色
	departmentList:array<String>;//所属部门
	leaderList:array<String>;//直接上级
	companyRoleList:array<String>;//团队角色列表
	weworkUserId:string;//企业微信账户ID
	dingtalkUserId:string;//钉钉账号ID
	feishuUserId:string;//飞书账号ID
	userInfo:object;//自动化扩展信息
}

UserInfo

用户信息

interface UserInfo {
	userName:string;//用户名
	mobileNo:string;//手机号
	email:string;//邮箱
	oid:string;//OID
	remark:string;//备注
	id:string;//ID
	name:string;//名称
	avatar:string;//头像
	roleList:array<String>;//角色
	departmentList:array<String>;//所属部门
	leaderList:array<String>;//直接上级
	companyRoleList:array<String>;//团队角色列表
	weworkUserId:string;//企业微信账户ID
	dingtalkUserId:string;//钉钉账号ID
	feishuUserId:string;//飞书账号ID
	userInfo:object;//自动化扩展信息
}

UserRole

应用角色

interface UserRole {
	id:string;//ID
	name:string;//名称
	isAdmin:boolean;//是否为管理员
	permissionList:array<String>;//权限列表
}

网站

WebsiteResource

网站资源

interface WebsiteResource {
	id:string;//ID
	name:string;//名称
	path:string;//路径
	isDirectory:boolean;//是否为目录
	fileId:string;//文件ID
}

Word

WordPicture

Word图片

interface WordPicture {
	url:string;//链接
	path:string;//路径
	storagePath:string;//存储路径
	width:number;//宽度
	height:number;//高度
}