Skip to content
Datablau DAMData governance documentation

Quality and job APIs ​

Use QUALITY_BASE_URL=https://<host>/quality for quality and the relevant /base or /job service for cross-module execution state. Retrieve rules, run instances, issue lists, and verification separately. Successful execution does not mean issue-free data.

Quality queries ​

Method and complete pathKey inputsResult
POST /quality/quality/rules/tech/pageBody currentPage, pageSize; optional keyword, modelCategoryId, buRuleId, hasProblemruleList, total
GET /quality/quality/rule/tech/{ruleId}Long rule IDTargets, type, publication state
POST /quality/quality/jobsBody currentPage, pageSize; optional name, modelCategoryId, jobIdDefinitions: content, totalElements
GET /quality/quality/jobs/{jobInstanceId}/eventsLong instance IDtimestamp, message, status, percent
GET /quality/quality/rule/tasksNo required inputsIssue lists with rule, result, and verification; array unsuitable for frequent full polling
POST /quality/quality/rules/tasks/{taskId}/dataPath ID; required query currentPage, pageSize, starting at 1; filter bodyrowNames, rowData, totalRow

Both quality path segments are required by the definition.

Build a quality dashboard ​

  1. Retrieve rules and tasks by system and retain ruleId, jobId, and scope.
  2. Read events for actual run instances and confirm completion or failure.
  3. Associate issues by ruleId, jobResultId, modelCategoryId, and batchNum.
  4. Display execution, issue, and verification state separately. Do not mix counts from different batches.
  5. Compare one batch's rules, instances, issues, and verification with the UI.

Issue status includes INIT, NOT_START, CONFIRM, ACCEPT, FIXED, VERIFIED, CLOSED, END. verifyStatus includes NOT_VERIFIED_YET, VERIFIED_ALL_PASSED, VERIFIED_PARTIALLY_PASSED, VERIFIED_NO_PASSED, NOT_AVAILABLE. Retain both; closed issues are not necessarily fully verified.

Synchronize tickets ​

Example detail body for a confirmed taskId:

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

Example path: /quality/quality/rules/tasks/2001/data?currentPage=1&pageSize=20. The ID is fictional. Interpret rowData using rowNames order rather than fixed row object fields.

Retain issue list, rule, batch, and available record key to prevent duplicate tickets. Prefer summary, owner, and a DAM link. Synchronize raw issue data only with explicit data authorization and business need.

Ticket closure does not close or verify a DAM issue. Design bidirectional mappings, ownership, and audit separately. See remediation and verification.

Job systems and asynchronous results ​

Method and complete pathJob systemInputs and result
POST /base/instantJob/getJobStatusBase instant jobsString query jobId; stage, percent, msg
POST /base/instantJob/getJobResultBase instant jobsString query jobId; jobStatus, errorMessage, resultType
GET /metadata/simplejobs/statusMetadata simple jobsLong query jobId; jobStatus, result, errorMessage
POST /sqlink/job/getJobResultSQLink instanceLong query jobInstanceId, minimum 1; state, times, result
POST /job/main/query/jobs/byCriteriaGeneric definitionsJSON criteria; content, totalElements
POST /job/main/query/jobResults/byCriteriaGeneric resultsCriteria linked to task and instance
POST /job/main/query/jobEvents/byCriteriaGeneric eventsCriteria linked to instance

Generic criteria require @type and nested page with currentPage and pageSize. Obtain a confirmed DTO example; the schema does not enumerate every concrete type. Prefer module-specific queries until the contract is known.

Base stages are IN_QUEUE, RUNNING, FAILED, FINISHED; metadata and SQLink enums differ. Use the system returned by the initiating endpoint rather than sending every jobId to /job.

Scheduling controls ​

Call an administrator-approved business entry point, retain the instance ID, poll to a terminal state, then verify business output. Store definition and instance IDs separately.

The /job/main/startJob definition uses a Chinese query name represented in Unicode escape notation as \u4efb\u52a1ID, with a String body. Decode that name if required by the verified contract. This guide provides no untested one-click harvesting command and does not recommend restart, forced stop, or state reset as routine governance APIs.

Use bounded backoff, total timeout, and alerts. Verify actual instance state after failure before repeating execution. Validate read responses in the target deployment; integration checks should not inadvertently run tasks, modify issues, or download business data.