Метод «Получить список пользователе黶
Endpoint: GET {hostname}/ldm-users-info-service/api/v1/users
Метод позволяет получить массив объектов с данными о зарегистрированных пользователях в Системе.
Более подробное описание метода находится в yaml файле «users-info_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| page | Query | Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента |
| size | Query | Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента |
| fields | Query | Фильтрация возвращаемых данных. Варианты использования фильтрации данных по полю «fields»: · fields=name,description – вернет в ответе только поля «name», «description»; · fields=!name,!description – вернет в ответе все остальные поля но только не поля «name», «description»; · fields= – вернет в ответе все поля и поля по вложенным объектам; · fields= – вернет в ответе значения примитивных полей и пустые поля-объекты родительского объекта; · fields=s. – вернет в ответе поля родительского объекта, оканчивающиеся на «'s'» и все поля их вложенных объектов; · fields=name,properties,properties.id – вернет поле «name» основного объекта и поле «id» у вложенного объекта «properties»; · fields=name,properties.**,!properties.name – вернет «name», и все поля вложенного объекта «properties» за исключением поля «properties.name» |
| search | Query | Значение согласно описанию в зависимости от потребностей клиента |
Пример запроса:
curl --location 'https://docshouse-test.k8s.lan.lanit.ru/dh-gateway-api-service/ldm-users-info-service/api/v2/users?page=4&size=6&fields=name%2Cdescription' \
-header 'accept: application/json'