Standards and metrics APIs

Base: DOMAIN_BASE_URL=https://<host>/domain.

Provide published standards, reference values, and metric definitions to modeling, development, reporting, and analytics tools. Check state, revision, and effective scope before treating content as an enterprise standard.

Core interfaces

Method and complete path	Key inputs	Result
POST /domain/domains/domain/getPublicPage	Body currentPage, pageSize, categoryId, keyword; optional domainCode, lastModificationStart, lastModificationEnd	Published standards: content, totalItems
POST /domain/domains/domain/getDomainById	Body String domainId	Definition, domainCode, chineseName, description, dataType, state, version
POST /domain/domains/code/getPage	Body currentPage, pageSize; optional code, name, categoryId, state	Codes: data, total
POST /domain/domains/code/getCode	Body String code	Code and values, state, revision
POST /domain/metricManagement/mapping/details	Required query String metricId	Dimensions, formula, source/table, metricMappings
POST /domain/querytheme/page	Required body currentPage, pageSize; optional keyword, categoryId	Metric query topics: content, totalItems

Time filters use date-time; follow supported format and timezone. Obtain catalog categoryId values from the deployment.

Read a definition

Submit to /domain/domains/domain/getDomainById:

{
  "domainId": "example-domain-id"
}

domainId is an internal identifier, distinct from the business code. Retain version, state, lastModification, and applicable takeEffectDate, expireDate, and referenceCode.

Example body for /domain/domains/code/getPage:

{
  "currentPage": 1,
  "pageSize": 20,
  "name": "Customer status"
}

The name is illustrative. Read values with getCode using the actual code. List entries are not necessarily published. Confirm deployment meanings for state values A, C, D, and X rather than inferring them.

Supply standards to development tools

1. Read applicable published definitions and details.
2. Read associated codes and values into a consistent revision snapshot.
3. Display definition, type, length/precision, nullability, and value constraints.
4. Use metadata APIs to verify field mappings; reading a definition does not create them.
5. Compare revisions and references after changes and have owners assess model, interface, and rule impacts.

For modification-time scans, overlap windows and deduplicate by domainId + version. Assess retirement, withdrawal, and lost visibility separately; absence from one incremental response does not establish deletion.

Explain metric sources

Read the definition, then query mappings with metricId to check modelId, tableId, dimensions, and formula. Use lineage when needed. Definitions, mappings, and actual metric values are separate.

Dynamic SQL metric queries are not a general-purpose data retrieval API in this guide. Deliver values through an approved method such as Data Services, with access, scope, performance, and audit requirements.

Integration validation

Code pagination returns data, total, currentPage, and pageSize. Validate standards pagination, permissions, business errors, definitions, values, and metric results with known customer samples rather than fabricated success responses.