Запрос: GET /groups
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
| Параметр | Описание |
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000 |
| pageToken (необязательный) | Токен для перехода на следующую страницу. Возвращается в ответе, если количество групп > pageSize. Можно отправить повторный запрос с этим параметром и получить информацию по следующим группам |
Параметры ответа
| Параметр | Описание |
|---|---|
| group | Массив с данными о группе |
| groupdId | ID группы |
| name | Название группы |
| isSmart | Является ли группа смарт-группой. Возможные значения:
|
Коды ответов
Код | Текст | Description |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о группах в xml |
| 400 | Bad Request | Ошибка в запросе |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Permission Denied | У пользователя недостаточно прав для получения списка групп |
Пример запроса
GET /groups?pageSize=1&pageToken=MmFhNmM1ZDItZmE1MS0xMWU5LWIzYmYtMGE1ODBhZjQwYTgz https/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Пример ответа
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<groups>
<group>
<groupId>84855bf6-06ac-11ea-9eea-0a580af40786</groupId>
<name>string</name>
<isSmart>0</isSmart>
</group>
<group>
...
</group>
</groups>
<nextPageToken>string</nextPageToken>
</response>