Формулировка проблемы: документирование ранее реализованного метода API.
Решение:
URL метода: rest/api/asforms/form/collatedData
Тип запроса: GET.
Метод принимает следующие входные параметры:
regID - UUID документа, из которого будут
браться данные (обяз.);
dataUUID - UUID данных, в которые будет
происходить сопоставление (обяз.);
collationGroup - UUID, по которому будет
происходить сопоставление (обяз.);
version - версия данных по форме (обяз.).
Передавать входные параметры необходимо в следующем порядке:
rest/api/asforms/form/collatedData/regID/dataUUID/collationGroup/?version=0
Пример запроса:
rest/api/asforms/form/collatedData/7fb464cc-f303-4f40-880f-37d3b5879581/f40b665c-f1f4-40b3-bdc5-291911def539/ff94d282-5da1-42fe-95f3-a3db09597ee1/?version=0
В случае успешного выполнения метод возвращает массив объектов JSON, состоящий из следующих полей:
collatedFormID - UUID сопоставленной формы;
name - название карточки;
uuid - UUID сопоставления;
collationGroup - UUID группы сопоставлений;
fields - список сопоставленных полей:
inField - поле-приемник формы;
outField - поле-исходник формы;
label - наименование;
uuid - UUID сопоставления;
collationType - способ сопоставления,
один из следующих вариантов: EQUAL, PREFIX, POSTFIX, HTD.
В случае же неуспешного выполнения (например, не переданы либо
переданы некорректные входные идентификаторы) метод возвращает
null.
Пример ответа:
[
{
"collatedFormID":"9b077c41-4efa-48ce-8ce9-af2fe6145e96",
"name":"PROCESS",
"uuid":"dfb986ca-6dd2-415f-9304-bfab19d6d4af",
"collationGroup":"ff94d282-5da1-42fe-95f3-a3db09597ee1",
"fields": [
{
"inField": "date1",
"outField": "date2",
"label": "Дата",
"uuid": "dfb986ca-6dd2-415f-9304-bfab19d6d4af",
"collationType": "EQUAL"
},
{
"inField": "text1",
"outField": "text2",
"label": "Текст",
"uuid": "dfb986ca-6dd2-415f-9304-bfab19d6d4af",
"collationType": "EQUAL"
}
]
}
]