Метод «Получить содержимое раздела справочника «Типовой перечень видов документов»

Endpoint: GET {hostname}/ldm-file-register-service/api/v1/document-types-sections/{id}/childs

Метод позволяет для указанного раздела получить его нижестоящие элементы (разделы и/или виды документов).

Сценарий выполнения:

  1. Верификация входящего сообщения. В запросе передаются параметры пагинации и сортировки.
  2. Осуществляется поиск раздела в таблице «dh_items», где значение параметра «id» равно {id}.
  3. Осуществляется получение нижестоящих разделов первого уровня – получение записей из таблицы «dh_items», где «class_name» равно «fr_dic_sections» и «fr_parent_section» равно {id}.
  4. Осуществляется получение видов документов, связанных с разделом – получение записей в таблице «dh_items», где «class_name» равно «fr_dic_standart_document_types» и «fr_section» равно {id}.
  5. По данным, полученным на этапах 3 и 4, формируется DocumentTypesContentDto в соответствии с маппингом, указанным в таблице, а также выполняется сортировка записей в массиве в соответствии с переданными параметрами.
  6. Сервис возвращает <200 OK> и массив DocumentTypesContentDto или пустой массив.

Маппинг параметров запроса «Получить содержимое раздела справочника «Типовой перечень документов»

Входящие параметры Тип данных Способ передачи параметров Требования к заполнению
id string($uuid) Path Идентификатор раздела (Id)
page integer($int32) Query Номер страницы, нумерация начинается с 0
size integer($int32) Query Количество возвращаемых записей для одной страницы, по умолчанию задано значение «20»
sort array[string] Query Параметр сортировки

Описание параметров в DocumentTypesContentDto приведено в таблице ниже.

Формирование параметров в DocumentTypesContentDto

Параметр в DocumentTypesContentDto Источник заполнения для раздела Источник заполнения для вида документа
id id id
name name объекта, полученного на этапе 3 name объекта, полученного на этапе 4
elementType SECTION DOCUMENT_TYPE
code fr_section_code объекта, полученного на этапе 3 -
item - fr_item объекта, полученного на этапе 4
frStoragePeriodType - fr_storage_period_types объекта, полученного на этапе 4
frStoragePeriod - fr_storage_period объекта, полученного на этапе 4
frExpertCommission - fr_expert_commission объекта, полученного на этапе 4
frComment - fr_comment объекта, полученного на этапе 4

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

curl -X 'GET' \
  'https://editor-next.swagger.io/api/v1/document-types-sections/3fa85f64-5717-4562-b3fc-2c963f66afa6/childs?page=0&size=20' \
  -H 'accept: text/plain'