REST-сервис модуля проверки качества данных записей

Модуль предназначен для обогащения записей или проверки состояния записи на соответствие правилам качества.

Обогащение записей

POST-запрос /v2/data-quality/data/check-state/apply-enrichment принимает на вход сведения о записи, выбранной для обогащения.

Пример запроса:

{
    "etalonId": "5877a630-8a39-11ef-b000-85732ab458d3",
    "draftId": 435,
    "entityName": "rst", /*Имя реестра*/
    "phaseId": "DRAFT", /*Пока что обогащение работает только в DRAFT фазе*/
    "skipValidations": true
}

Создается запрос вставки текущего состояния записи без внесения в нее изменений.

Если phaseId = "DRAFT", тогда к вставке будет добавлен шаг DQ с прохождением валидации и обогащения. Обогащенная запись будет вставлена в указанный черновик.

В ответе возвращается облегченный вариант результата прохождения DQ. В нем отсутствует output и в него не попадают отчеты о необогащенных записях.

Результат хранит поля enrichments, содержащие информацию об обогащенных записях.

Пример ответа:

{
"blocks": [
    {
    "results": [
        {
        "setName": "enrichmentSet",
        "setDisplayName": "enrichmentSet",
        "rules": [
            {
            "ruleName": "enrichmentRool",
            "ruleDisplayName": "enrichmentRool",
            "executions": [
                {
                "skipped": false,
                "valid": true,
                "enriched": true,
                "enrichments": [ /*Информация об обогащенном поле*/
                    {
                    "path": "str1", /*Локальный путь до обогащенного атрибута*/
                    "nameSpace": "classification",
                    "typeName": "simpleClassic|simpleClassic|node1",
                    "recordId": "8e34610a-8bba-11ef-992a-85732ab458d3",
                    "periodId": "19223372036825200000",
                    "attributeName": "str1",
                    "beforeEnrichment": { /*Состояние атрибута до обогащения*/
                        "name": "str1",
                        "type": "String",
                        "displayValue": null,
                        "targetEtalonId": null,
                        "valueId": null,
                        "unitId": null,
                        "value": null
                    },
                    "afterEnrichment": { /*Состояние атрибута после обогащения*/
                        "name": "str1",
                        "type": "String",
                        "displayValue": null,
                        "targetEtalonId": null,
                        "valueId": null,
                        "unitId": null,
                        "value": "ENRICHED"
                    }
                    }
                ],
                "errors": [],
                "spots": []
                }
            ]
            }
        ]
        }
    ],
    "valid": true,
    "enriched": true,
    "output": {} /*Всегда пустой*/
    }
]
}