Skip to content
Datablau DAM数据治理产品手册
REST API 集成指南 模块手册下载 PDF

质量与任务 API ​

本页质量接口使用 QUALITY_BASE_URL=https://<host>/quality;跨模块任务状态可使用 BASE_BASE_URL=https://<host>/base 或 JOB_BASE_URL=https://<host>/job,以接口定义为准。

把质量平台接入运营看板或工单系统时,应分别获取规则、运行实例、问题清单和核验结果。任务运行成功只说明本次任务完成,不能直接解释为数据没有质量问题。

质量查询接口 ​

方法与路径关键输入用途及结果
POST /quality/quality/rules/tech/pageBody:currentPage、pageSize;可选 keyword、modelCategoryId、buRuleId、hasProblem规则清单;返回 ruleList、total
GET /quality/quality/rule/tech/{ruleId}Path:ruleId(Long)规则详情,包含目标表字段、类型及发布状态
POST /quality/quality/jobsBody:currentPage、pageSize;可选 name、modelCategoryId、jobId检核任务定义;返回 content、totalElements
GET /quality/quality/jobs/{jobInstanceId}/eventsPath:jobInstanceId(Long)运行事件,包含 timestamp、message、status、percent
GET /quality/quality/rule/tasks无必填参数问题清单,包含规则、运行结果关联及核验状态;当前定义为数组,不适合高频全量轮询
POST /quality/quality/rules/tasks/{taskId}/dataPath:taskId;Query:currentPage、pageSize 均必填,从 1 开始;Body 为问题筛选问题明细,包含 rowNames、rowData、totalRow

完整路径中出现两次 quality 是当前真实定义:第一个为服务前缀,第二个为控制器路径,不能擅自删掉。

场景:构建质量运营看板 ​

  1. 按应用系统获取规则及检核任务定义,记录 ruleId、jobId 及对象范围。
  2. 按实际任务实例获取运行事件;结合通用任务执行结果判断是否完成或失败。
  3. 读取问题清单,关联 ruleId、jobResultId、modelCategoryId 和 batchNum,汇总待处理项。
  4. 分别展示“执行状态”“问题状态”和“核验状态”。不能将不同批次的规则数、异常数和检查行数直接混算。
  5. 与质量页面对照一个具体批次,验证规则、实例、问题数量及核验结论一致。

问题清单的 status 包含 INIT、NOT_START、CONFIRM、ACCEPT、FIXED、VERIFIED、CLOSED、END;verifyStatus 则包含 NOT_VERIFIED_YET、VERIFIED_ALL_PASSED、VERIFIED_PARTIALLY_PASSED、VERIFIED_NO_PASSED、NOT_AVAILABLE。接入时保留两个状态,特别区分“问题已关闭”与“核验全部通过”。

场景:向工单系统同步问题 ​

对已经确认的 taskId,以下 JSON 为问题明细 Body:

json
{
  "assignStatus": "ALL",
  "solveStatus": "NOT_SOLVED"
}

调用路径示例为 /quality/quality/rules/tasks/2001/data?currentPage=1&pageSize=20,其中 2001 是虚构问题清单标识。按响应 rowNames 的顺序解释 rowData,不能把行数组当作字段名固定的对象。

工单关联键至少保留问题清单标识、规则、批次和可用的记录主键,避免同一异常重复建单。同步状态摘要通常已能满足运营需要;只有获得数据授权且确有业务需要时才同步原始问题明细,避免把身份证、联系方式等带入工单。

工单关闭不自动等于 DAM 问题关闭或核验通过。双向回写必须另行设计状态映射、责任人及审计;本文不将确认、关闭、修复接口列为可直接批量执行的默认操作。完整业务处理见问题整改与核验。

通用任务与异步结果 ​

方法与路径适用任务体系关键输入与结果
POST /base/instantJob/getJobStatusbase 即时任务Query:jobId(String);返回 stage、percent、msg
POST /base/instantJob/getJobResultbase 即时任务Query:jobId(String);返回 jobStatus、errorMessage、resultType
GET /metadata/simplejobs/status元数据简单任务Query:jobId(Long);返回 jobStatus、result、errorMessage
POST /sqlink/job/getJobResultSQLink 任务实例Query:jobInstanceId(Long,至少 1);返回 status、时间与 result
POST /job/main/query/jobs/byCriteria通用调度任务定义JSON 查询条件;返回 content、totalElements
POST /job/main/query/jobResults/byCriteria通用调度执行结果JSON 查询条件,关联具体任务及实例
POST /job/main/query/jobEvents/byCriteria通用调度事件JSON 查询条件,关联执行实例

/job 的条件查询 DTO 要求 @type,并使用嵌套 page(含 currentPage、pageSize)。当前 Schema 未给出这里所有可用的具体条件类型和取值,实施前需由管理员提供与目标任务匹配的 DTO 示例;不要填入猜测的 Java 类名。未得到确认前,可优先采用对应业务模块的任务查询接口。

各任务体系标识和状态不通用。base 即时任务 stage 为 IN_QUEUE、RUNNING、FAILED、FINISHED;metadata 简单任务与 SQLink 实例使用的枚举不同。以发起接口返回的任务体系选择查询路径,不把任何 jobId 都发往 /job。

调度集成的控制点 ​

外部编排应调用经管理员批准的业务任务入口,保留返回的实例标识并轮询至终态,再核对业务结果。任务定义 ID 与一次执行的实例 ID 必须分别保存。

当前 /job/main/startJob 定义的 Query 名称为中文“任务ID”,并有 String Body;条件查询存在多态类型要求。因此本指南不提供未经联调的“一键启动采集”命令,也不把服务重启、强制停止、重置状态接口作为常规治理 API。

轮询采用有上限的退避间隔、总超时和告警策略;失败后先核对该实例是否实际已完成。不能因请求超时就重复运行整个采集或检核任务。

集成边界 ​

质量技术规则分页通常返回 ruleList、total 等字段;其他质量、问题明细和任务接口应在目标部署用只读样本确认。集成测试不应直接执行任务、修改问题或下载业务数据。