Модуль com.unidata.mdm.rest.v1.classifiers¶

Модуль предоставляет доступ к работе с классификаторами посредством REST API.

Переиндексация классификатора¶

REST эндпоинт: POST /api/v1/classifiers/model/reindex

Примечание

В текущей реализации запуск переиндексации возможен только через отправку запроса вручную или Swagger

Тело запроса: com.unidata.mdm.rest.v1.classifiers.ro.ReindexClassifierRequestRO

Поле	Описание	Значение	Примечание
classifier	Системное имя классификатора		Обязательно для заполнения
storageId	Имя хранилища		Если пустое, то будет использоваться текущее хранилище пользователя
versions	Версии классификатора, которые необходимо переиндексировать	Список строк	Если пустое, то будут переиндексированы все версии

Пример:

{
 "classifier": "classifierTest",
  "storageId": "default",
  "versions": [
    "classifierTest",
    "cloneVersion"
    ]
}

Тело ответа: com.unidata.mdm.rest.v1.classifiers.ro.ReindexClassifierResultRO

Поле	Описание	Значение
classifier	Системное имя классификатора, который был переиндексирован
storageId	Имя хранилища, в котором был переиндексирован классификатор
indexedNodesByVersion	Количество узлов в версиях, которые были проиндексированы	Карта Имя версии - количество проиндексированных узлов

Пример:

{
  "details": {
    "info": [],
    "warning": [],
    "error": []
  },
  "classifier": "NewMaterials",
  "storageId": "default",
  "indexedNodesByVersion": {
    "clone": 12455,
    "NewMaterials": 12455
  }
}

Возможные ошибки:

Не заполнено имя классификатора для переиндексации
- Тип: CLASSIFIERS_EXCEPTION
- Код: EX_CLSF_MODEL_REINDEX_CLASSIFIER_NAME_ABSENT
Не найден указанный классификатор в указанном хранилище
- Тип: CLASSIFIERS_EXCEPTION
- Код: EX_CLSF_MODEL_REINDEX_CLASSIFIER_NOT_FOUND_IN_SPECIFIED_STORAGE
Запрашиваемые версии не найдены в указанном классификаторе в указанном хранилище
- Тип: CLASSIFIERS_EXCEPTION
- Код: EX_CLSF_MODEL_REINDEX_VERSIONS_NOT_FOUND

Поиск классификаций полученных записей¶

REST эндпоинт: POST api/v1/classifiers/classification/search

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

{
    "query": {
        "entity": "UN-24156",
        "count": 10,
        "formFields": [
            {
                "name": "$classified_id",
                "type": "STRING",
                "searchType": "EXACT",
                "inverted": false,
                "values": [
                    "f2bd944c-718a-11ee-9c59-6300f5fcd27a",
                    "ad77dea5-78b2-11ee-b1a1-6300f5fcd27a"
                ]
            }
        ],
        "returnFields": [
            "$classified_id",
            "$deleted",
            "$etalon_id",
            "$attributes",
            "$node",
            "$classifier",
            "$version"
        ]
    }
}