# 应用 API ## Docs - [开发指南](https://apifox.mingdao.com/6382453m0.md): - [字段类型对照表](https://apifox.mingdao.com/7271709m0.md): - [筛选器使用指南](https://apifox.mingdao.com/7271713m0.md): - [错误码](https://apifox.mingdao.com/7271715m0.md): - [ API 使用指南](https://apifox.mingdao.com/8387293m0.md): ## API Docs - 应用 [获取应用信息](https://apifox.mingdao.com/get_app_info.md): 获取应用信息,包含应用下分组、工作表、自定义页面信息 - 应用 [批量创建应用项分组](https://apifox.mingdao.com/478348307e0.md): 批量创建应用项分组,用于对应用下的工作表和自定义页面进行归组展示。 - 应用 [批量创建应用项](https://apifox.mingdao.com/478348308e0.md): 批量创建空白应用项(自定义页面或工作表)。 - 对话机器人 [新建对话机器人](https://apifox.mingdao.com/478348309e0.md): 在应用内创建 AI 助手(对话机器人)。 - 工作表 [获取工作表列表](https://apifox.mingdao.com/get_app_worksheets_list.md): 获取应用下的所有工作表或者指定的工作表列表 - 工作表 [新建工作表](https://apifox.mingdao.com/create_worksheet.md): 创建工作表,目前支持字段类型有Text|Number|SingleSelect|MultipleSelect|Date|DateTime|Collaborator|Relation|Attachment - 工作表 [获取工作表结构信息](https://apifox.mingdao.com/get_worksheet_structure.md): 获取工作表配置及其字段信息 - 工作表 [更新工作表结构](https://apifox.mingdao.com/update_worksheet.md): 更新工作表结构,包括新增、编辑、删除字段 - 工作表 [删除工作表](https://apifox.mingdao.com/delete_worksheet.md): 删除工作表 - 工作表 [批量创建自定义动作](https://apifox.mingdao.com/478348310e0.md): 批量创建自定义动作,返回动作id用于创建视图时使用 - 工作表行记录 [获取行记录列表](https://apifox.mingdao.com/get_record_list.md): 获取工作表记录列表,包含记录创建者、拥有者信息,各字段对应的值 - 工作表行记录 [获取行记录详情](https://apifox.mingdao.com/get_record_details.md): 获取记录详情信息,包括创建者、拥有者、字段信息、根据字段数据类型生成示例值 - 工作表行记录 [更新行记录](https://apifox.mingdao.com/update_record.md): 更新行记录 - 工作表行记录 [删除行记录](https://apifox.mingdao.com/delete_record.md): 删除行记录 - 工作表行记录 [新建行记录](https://apifox.mingdao.com/create_record.md): 新建行记录 - 工作表行记录 [批量新增行记录](https://apifox.mingdao.com/batch_create_records.md): 批量新建行记录 - 工作表行记录 [批量更新行记录详情](https://apifox.mingdao.com/batch_update_records.md): 批量更新行记录 - 工作表行记录 [批量删除行记录](https://apifox.mingdao.com/batch_delete_records.md): 批量删除行记录 - 工作表行记录 [获取关联记录](https://apifox.mingdao.com/get_record_relations.md): 获取关联记录列表,包括关联记录来源工作表信息,行记录信息,行记录详细信息,创建者信息 - 工作表行记录 [获取行记录透视数据](https://apifox.mingdao.com/get_record_pivot_data.md): 获取工作表记录透视表汇总数据,适用于数据分析统计场景,与统计中透视表功能一致 - 工作表行记录 [获取记录分享链接](https://apifox.mingdao.com/get_record_share_link.md): 获取记录分享链接 - 工作表行记录 [获取行记录日志](https://apifox.mingdao.com/get_record_logs.md): 获取行记录的操作日志信息 - 工作表行记录 [获取行记录讨论](https://apifox.mingdao.com/get_record_discussions.md): 获取行记录讨论 - 工作表行记录 [获取审批流程执行详情](https://apifox.mingdao.com/449200516e0.md): 获取指定工作表行记录下某条审批流程执行的详细信息 - 工作表行记录 [根据行记录获取审批流程执行列表](https://apifox.mingdao.com/get_approval_list_by_row.md): 获取指定工作表行记录关联的审批流程执行列表,可分页;complete 可筛选未完成/全部 - 自定义页面 [更新自定义页面](https://apifox.mingdao.com/449612271e0.md): 更新(创建或全量覆盖)自定义页面的组件列表。页面采用 48 列栅格布局。提交后页面上的全部已有组件会被本次传入的列表替换。 - 选项集 [获取选项集列表](https://apifox.mingdao.com/get_optionset_list.md): 获取应用下选项集列表 - 选项集 [创建选项集](https://apifox.mingdao.com/create_optionset.md): 创建选项集信息 - 选项集 [编辑选项集](https://apifox.mingdao.com/update_optionset.md): 编辑选项集 - 选项集 [停用选项集](https://apifox.mingdao.com/delete_optionset.md): 停用选项集 - 公共查询 [查找成员](https://apifox.mingdao.com/find_member.md): 根据输入的人员名称匹配用户,返回用户 ID、姓名、已脱敏的手机号和邮箱。 - 公共查询 [查找部门](https://apifox.mingdao.com/find_department.md): 根据输入的部门名称匹配部门,返回部门 ID 和名称。 - 公共查询 [获取地区信息](https://apifox.mingdao.com/get_regions.md): 获取地区信息,支持按ID查询或模糊搜索 - 知识库 [获取应用下知识库列表](https://apifox.mingdao.com/get_app_knowledge_list.md): 获取当前应用下的知识库列表 - 知识库 [知识库检索](https://apifox.mingdao.com/knowledge_search.md): 在指定知识库中按查询文本进行检索,支持向量/全文/混合模式 - 视图 [批量创建视图](https://apifox.mingdao.com/478348311e0.md): 为工作表批量创建视图。注意:所有需要填写字段的地方(如 config, filter 等),均优先使用字段 alias,如果没有 alias 则使用 fieldId/controlId。 - 统计图 [新建统计图](https://apifox.mingdao.com/449612270e0.md): 在工作表下新建统计图。支持柱图、条形图、折线图、饼图、雷达图、漏斗图、双轴图、透视表、行政区划图、数值图、对称条形图、散点图、词云、仪表盘、进度条、排行榜、世界地图等图表类型。创建成功后返回 chartId。若未指定 chartType,默认使用 columnChart(柱图);若未指定时间范围,默认使用 currentMonth(本月);若未指定时间字段,默认使用 ctime(创建时间)。 - 工作流 [获取触发流程列表](https://apifox.mingdao.com/get_workflow_list.md): 获取应用下触发流程列表,包括 webhook 与封装业务流程 - 工作流 [创建工作流](https://apifox.mingdao.com/478348312e0.md): 创建一条工作流(含触发器)。创建成功返回流程 processId。节点创建请使用 batch_create_process_nodes 工具。 - 工作流 [批量添加工作流节点](https://apifox.mingdao.com/478348313e0.md): 向已有工作流批量追加节点(不能新建触发器)。 - 工作流 [删除工作流节点](https://apifox.mingdao.com/478348314e0.md): 删除已有工作流中的一个节点。适用于 create_process / batch_create_process_nodes 创建后需要撤销某个业务节点的场景。 - 工作流 [触发流程](https://apifox.mingdao.com/trigger_workflow.md): 触发webhook/封装业务流程 - 工作流 [获取触发流程详情](https://apifox.mingdao.com/get_workflow_details.md): 获取触发流程详情,即 webhook/封装业务流程的请求参数,响应参数 - 工作流 [删除工作流](https://apifox.mingdao.com/478348315e0.md): 删除已有工作流。适用于调用方确认整条流程不再需要、需要从当前应用包下移除该流程的场景。 - 工作流 [获取工作流结构详情](https://apifox.mingdao.com/478348316e0.md): 拉取已有工作流的结构快照。只按 processId 查询当前流程;approval_block / sub_process 不内联返回 process.nodes,而是在块节点 config.process.processId 返回内部流程 ID。需要查看、校验或发布块内流程时,用该内部 processId 再调用 get_workflow_structure / validate_process / publish_process。 - 工作流 [发布工作流](https://apifox.mingdao.com/478348317e0.md): 对已有工作流跑一次发布前校验,但不真正发布。报告所有未填字段、悬空引用、不兼容枚举等问题。和 publish_process 共享校验链,区别只在于不写 published 状态。 - 工作流 [校验工作流](https://apifox.mingdao.com/478348318e0.md): 发布工作流,发布前自动跑一次完整校验。任一项失败即整体失败、不写 published 状态;error.code=PUBLISH_FAILED,error.message 多行列每条问题,按行 split 后逐条修,修完重发。 - 角色 [获取角色列表](https://apifox.mingdao.com/get_role_list.md): 获取应用下角色列表 - 角色 [创建角色](https://apifox.mingdao.com/create_role.md): 创建角色 - 角色 [获取角色详情](https://apifox.mingdao.com/get_role_details.md): 获取角色详情 - 角色 [删除角色](https://apifox.mingdao.com/delete_role.md): 删除角色 - 角色 [添加角色成员](https://apifox.mingdao.com/add_member_to_role.md): 添加角色成员信息 - 角色 [移除角色成员](https://apifox.mingdao.com/remove_member_from_role.md): 移出角色下成员 - 角色 [成员退出所有角色](https://apifox.mingdao.com/leave_all_roles.md): 将指定成员退出应用下所有角色 ## Schemas - Schemas [options](https://apifox.mingdao.com/197597298d0.md): - Schemas [relation](https://apifox.mingdao.com/197668333d0.md): - Schemas [obj_base_response](https://apifox.mingdao.com/195106204d0.md): - Schemas [obj_field](https://apifox.mingdao.com/195106205d0.md): - Schemas [obj_filter](https://apifox.mingdao.com/195106206d0.md): - Schemas [obj_record_row](https://apifox.mingdao.com/195106207d0.md): - Schemas [obj_record_log](https://apifox.mingdao.com/195106208d0.md): - Schemas [obj_record_discussion](https://apifox.mingdao.com/195106209d0.md): - Schemas [obj_pivot_meta](https://apifox.mingdao.com/195106210d0.md): - Schemas [obj_pivot_dimensions](https://apifox.mingdao.com/195106211d0.md): - Schemas [obj_pivot_data](https://apifox.mingdao.com/195106212d0.md): - Schemas [obj_process](https://apifox.mingdao.com/195106213d0.md): - Schemas [obj_process_detail](https://apifox.mingdao.com/195106214d0.md): - Schemas [obj_input](https://apifox.mingdao.com/195106215d0.md): - Schemas [obj_output](https://apifox.mingdao.com/195106216d0.md): - Schemas [obj_role](https://apifox.mingdao.com/195106217d0.md): - Schemas [obj_role_permission](https://apifox.mingdao.com/195106218d0.md): - Schemas [obj_user](https://apifox.mingdao.com/195106219d0.md): - Schemas [obj_user_desensitized](https://apifox.mingdao.com/195106220d0.md): - Schemas [obj_department](https://apifox.mingdao.com/195106221d0.md): - Schemas [obj_custom_page](https://apifox.mingdao.com/195106222d0.md): - Schemas [obj_optionset](https://apifox.mingdao.com/195106223d0.md): - Schemas [obj_filter_children](https://apifox.mingdao.com/195106224d0.md): - Schemas [obj_app](https://apifox.mingdao.com/195106225d0.md): - [鉴权信息](https://apifox.mingdao.com/157114741d0.md): - [人员对象](https://apifox.mingdao.com/157262690d0.md): - [自定义页面](https://apifox.mingdao.com/157344893d0.md): - [应用角色](https://apifox.mingdao.com/157354659d0.md): - [人员信息](https://apifox.mingdao.com/184507385d0.md): - [统计图数值字段参数](https://apifox.mingdao.com/268342623d0.md): - [FilterField](https://apifox.mingdao.com/275217385d0.md): - [FilterTarget](https://apifox.mingdao.com/275217737d0.md): - [ApiError](https://apifox.mingdao.com/268610848d0.md): - [BatchCreateViewsRequest](https://apifox.mingdao.com/268763616d0.md): - [DataScope](https://apifox.mingdao.com/268610849d0.md): - [ViewItem](https://apifox.mingdao.com/268763617d0.md): - [Aggregation](https://apifox.mingdao.com/268610850d0.md): - [BatchCreateViewsResponse](https://apifox.mingdao.com/268763618d0.md): - [TimeRange](https://apifox.mingdao.com/268610851d0.md): - [ChartType](https://apifox.mingdao.com/268610852d0.md): - [DynamicRangePoint](https://apifox.mingdao.com/268610853d0.md): - [DimensionItem](https://apifox.mingdao.com/268610856d0.md): - [MetricItem](https://apifox.mingdao.com/268610857d0.md): - [SortItem](https://apifox.mingdao.com/268610858d0.md): - [CreateChartData](https://apifox.mingdao.com/268610860d0.md): - [InlineChartConfig](https://apifox.mingdao.com/268610863d0.md): - [ViewConfig](https://apifox.mingdao.com/268610864d0.md): - [TextConfig](https://apifox.mingdao.com/268610865d0.md): - [HtmlConfig](https://apifox.mingdao.com/268610866d0.md): - [CarouselConfig](https://apifox.mingdao.com/268610867d0.md): - [ButtonActionItem](https://apifox.mingdao.com/268610868d0.md): - [ButtonConfig](https://apifox.mingdao.com/268610869d0.md): - [TabConfig](https://apifox.mingdao.com/268610871d0.md): - [ContainerConfig](https://apifox.mingdao.com/268610872d0.md): - [ChartComponent](https://apifox.mingdao.com/268610873d0.md): - [SectionComponent](https://apifox.mingdao.com/268610874d0.md): - [TextComponent](https://apifox.mingdao.com/268610875d0.md): - [HtmlComponent](https://apifox.mingdao.com/268610876d0.md): - [ViewComponent](https://apifox.mingdao.com/268610877d0.md): - [CarouselComponent](https://apifox.mingdao.com/268610878d0.md): - [ButtonComponent](https://apifox.mingdao.com/268610879d0.md): - [TabComponent](https://apifox.mingdao.com/268610880d0.md): - [ContainerComponent](https://apifox.mingdao.com/268610881d0.md): - [SaveCustomPageComponent](https://apifox.mingdao.com/268610882d0.md): - [SaveCustomPageData](https://apifox.mingdao.com/268610884d0.md): - [ComponentConfig](https://apifox.mingdao.com/268622781d0.md): - [SaveCustomPageRequest](https://apifox.mingdao.com/268610883d0.md): - [app](https://apifox.mingdao.com/288415054d0.md): - [CreateChartRequest](https://apifox.mingdao.com/268610859d0.md): - [SaveCustomPageResponseData](https://apifox.mingdao.com/268622783d0.md): - [CreateChartResponseData](https://apifox.mingdao.com/268622779d0.md): - [ButtonItem](https://apifox.mingdao.com/268622780d0.md): - [baseResponse](https://apifox.mingdao.com/257134463d0.md): - [DimensionField](https://apifox.mingdao.com/268622775d0.md): - [memberInfo](https://apifox.mingdao.com/257134464d0.md): - [ValueField](https://apifox.mingdao.com/268622776d0.md): - [department_with_path](https://apifox.mingdao.com/257134465d0.md): - [SortField](https://apifox.mingdao.com/268622777d0.md): - [departmentInfo](https://apifox.mingdao.com/257134466d0.md): - [TimePointDynamic](https://apifox.mingdao.com/268622778d0.md): - [regionInfo](https://apifox.mingdao.com/257134467d0.md): - [process](https://apifox.mingdao.com/257134468d0.md): - [process_detail](https://apifox.mingdao.com/257134469d0.md): - [CustomDynamicRange](https://apifox.mingdao.com/268610854d0.md): - [input](https://apifox.mingdao.com/257134470d0.md): - [CustomRange](https://apifox.mingdao.com/268610855d0.md): - [output](https://apifox.mingdao.com/257134471d0.md): - [role](https://apifox.mingdao.com/257134472d0.md): - [role_permission](https://apifox.mingdao.com/257134473d0.md): - [optionset](https://apifox.mingdao.com/257134475d0.md): - [field](https://apifox.mingdao.com/257134476d0.md): - [CreateChartResponse](https://apifox.mingdao.com/268610861d0.md): - [PageComponent](https://apifox.mingdao.com/268622782d0.md): - [Position](https://apifox.mingdao.com/268610862d0.md): - [filter_children](https://apifox.mingdao.com/257134479d0.md): - [ErrorResponse](https://apifox.mingdao.com/268622784d0.md): - [discussion](https://apifox.mingdao.com/257134481d0.md): - [TabItem](https://apifox.mingdao.com/268610870d0.md): - [SaveCustomPageResponse](https://apifox.mingdao.com/268610885d0.md): - [User](https://apifox.mingdao.com/288415055d0.md): - [WorkflowInputParameter](https://apifox.mingdao.com/288415056d0.md): - [WorkflowOutputParameter](https://apifox.mingdao.com/288415057d0.md): - [WorkflowNode](https://apifox.mingdao.com/288415058d0.md): - [WorkflowValidationError](https://apifox.mingdao.com/288415059d0.md): - [create_process_NodeRef](https://apifox.mingdao.com/288415060d0.md): - [create_process_ValueRef](https://apifox.mingdao.com/288415061d0.md): - [create_process_FieldValueRef](https://apifox.mingdao.com/288415062d0.md): - [create_process_Filter](https://apifox.mingdao.com/288415063d0.md): - [create_process_Condition](https://apifox.mingdao.com/288415064d0.md): - [create_process_WorksheetEventTriggerConfig](https://apifox.mingdao.com/288415065d0.md): - [create_process_ScheduleTriggerConfig](https://apifox.mingdao.com/288415066d0.md): - [create_process_DateFieldTriggerConfig](https://apifox.mingdao.com/288415067d0.md): - [create_process_WebhookTriggerConfig](https://apifox.mingdao.com/288415068d0.md): - [create_process_TriggerSpec](https://apifox.mingdao.com/288415069d0.md): - [batch_create_process_nodes_NodeRef](https://apifox.mingdao.com/288415070d0.md): - [batch_create_process_nodes_ValueRef](https://apifox.mingdao.com/288415071d0.md): - [batch_create_process_nodes_FieldValueRef](https://apifox.mingdao.com/288415072d0.md): - [batch_create_process_nodes_RecordValueRef](https://apifox.mingdao.com/288415073d0.md): - [batch_create_process_nodes_FieldPatch](https://apifox.mingdao.com/288415074d0.md): - [batch_create_process_nodes_Filter](https://apifox.mingdao.com/288415075d0.md): - [batch_create_process_nodes_Condition](https://apifox.mingdao.com/288415076d0.md): - [batch_create_process_nodes_PersonRef](https://apifox.mingdao.com/288415077d0.md): - [batch_create_process_nodes_AttachmentSpec](https://apifox.mingdao.com/288415078d0.md): - [batch_create_process_nodes_FormProperty](https://apifox.mingdao.com/288415079d0.md): - [batch_create_process_nodes_NodeSpec](https://apifox.mingdao.com/288415080d0.md): - [batch_create_process_nodes_SortSpec](https://apifox.mingdao.com/288415081d0.md): - [ApiResponseBase](https://apifox.mingdao.com/288415082d0.md): - [WorkflowListType](https://apifox.mingdao.com/288415083d0.md): - [WorkflowInstanceStatus](https://apifox.mingdao.com/288415084d0.md): - [FlowNodeType](https://apifox.mingdao.com/288415085d0.md): - [InstanceLogStatus](https://apifox.mingdao.com/288415086d0.md): - [WorkItemOperationType](https://apifox.mingdao.com/288415087d0.md): - [WorkItemLogAction](https://apifox.mingdao.com/288415088d0.md): - [ApprovalAuthType](https://apifox.mingdao.com/288415089d0.md): - [BatchRuleType](https://apifox.mingdao.com/288415090d0.md): - [CallbackType](https://apifox.mingdao.com/288415091d0.md): - [TriggerType](https://apifox.mingdao.com/288415092d0.md): - [AppType](https://apifox.mingdao.com/288415093d0.md): - [ApprovalResultBranchType](https://apifox.mingdao.com/288415094d0.md): - [FailureCause](https://apifox.mingdao.com/288415095d0.md): - [SignatureType](https://apifox.mingdao.com/288415096d0.md): - [AppBrief](https://apifox.mingdao.com/288415097d0.md): - [UserBrief](https://apifox.mingdao.com/288415098d0.md): - [ControlValue](https://apifox.mingdao.com/288415099d0.md): - [FlowNodeAuth](https://apifox.mingdao.com/288415100d0.md): - [SelectNodeObject](https://apifox.mingdao.com/288415101d0.md): - [FlowNode](https://apifox.mingdao.com/288415102d0.md): - [InstanceLog](https://apifox.mingdao.com/288415103d0.md): - [ProcessBrief](https://apifox.mingdao.com/288415104d0.md): - [FileInfo](https://apifox.mingdao.com/288415105d0.md): - [Signature](https://apifox.mingdao.com/288415106d0.md): - [WorkItem](https://apifox.mingdao.com/288415107d0.md): - [WorkItemLog](https://apifox.mingdao.com/288415108d0.md): - [ChangedField](https://apifox.mingdao.com/288415109d0.md): - [WorkflowInstance](https://apifox.mingdao.com/288415110d0.md): - [BatchApprovalRequest](https://apifox.mingdao.com/288415111d0.md): - [BatchApprovalInstance](https://apifox.mingdao.com/288415112d0.md): - [BatchApprovalResult](https://apifox.mingdao.com/288415113d0.md): - [OpinionRequest](https://apifox.mingdao.com/288415114d0.md): - [ReturnRequest](https://apifox.mingdao.com/288415115d0.md): - [bundled_2af3dc97c2fe](https://apifox.mingdao.com/288415116d0.md): - [bundled_da9b1112b2d5](https://apifox.mingdao.com/288415117d0.md): - [bundled_66310009f584](https://apifox.mingdao.com/288415118d0.md): - [custom_page](https://apifox.mingdao.com/257134474d0.md): - [worksheet](https://apifox.mingdao.com/257134477d0.md): - [filter](https://apifox.mingdao.com/257134478d0.md): - [record_row](https://apifox.mingdao.com/257134480d0.md):