Метод «Получить список маршрутов»¶
Endpoint: GET {hostname}/ldm-flex-approval-service/api/v1/routes
Метод позволяет получить агрегированные данные архивированного маршрута.
Более подробное описание метода находится в yaml файле «flex-approval -service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| states | Query | Фильтрация по списку состояния выполнения. Доступные значения: · DRAFT; · STARTING; · EXECUTING; · STOPPED; · FAILED; · COMPLETING; · COMPLETED; · CANCELED; · CANCELING; · PENDING |
| mainObjectUri | Query | Фильтрация по URI объекта, с которым связан маршрут (URI без секции FRAGMENT) |
| enrichResponse | Query | Признак обогащения выводимых данных краткой информацией о блоках, этапах, шагах |
| fields | Query | Фильтрация полей вывода. Работает только по полям на верхнем уровне. В итоговую DTO выводятся только поля, которые перечислены |
| page | Query | Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента |
| size | Query | Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента |
| sort | Query | Параметр сортировки. Значение согласно описанию в зависимости от потребностей клиента |
Пример запроса:
curl --location 'https://docshouse.ldm.lanit.ru/dh-gateway-api-service/ldm-flex-approval-service/api/v1/routes?fields=created-date&states=STARTING&enrichResponse=false&page=0&size=20' \
-header 'accept: application/json'