Метод «Получить список групﻶ

Endpoint: GET {hostname}/ldm-users-info-service/api/v1/groups

Метод позволяет получить массив объектов с данными о зарегистрированных группах в Системе.

Более подробное описание метода находится в yaml файле «users-info_service», который расположен в папке с документацией.

Маппинг параметров запроса

Входящие параметры	Способ передачи параметров	Требования к заполнению
page	Query	Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента
size	Query	Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента
fields	Query	- fields=name,description – возвращает в ответе только поля name,description; - fields=!name,!description – возвращает в ответе все остальные поля, но только не поля name, description; - fields= – возвращает в ответе все поля и поля по вложенным объектам; - fields=* – возвращает в ответе все поля родительского объекта и поля по вложенным объектам (на которых не настроена фильтрация); - 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/v1/groups?page=2&size=6&fields=name%2Cdescription' \
  -header 'accept: application/json'