diff --git a/api-reference/sonet-group/socialnetwork-api-workgroup-get.md b/api-reference/sonet-group/socialnetwork-api-workgroup-get.md index 9de631e2..87d7df07 100644 --- a/api-reference/sonet-group/socialnetwork-api-workgroup-get.md +++ b/api-reference/sonet-group/socialnetwork-api-workgroup-get.md @@ -28,16 +28,50 @@ ## Описание -Метод возвращает данные по рабочей группе +Метод возвращает информацию о рабочей группе (в т.ч. о проекте или о скраме) по идентификатору. Администратор может получить информацию о любой рабочей группе (в т.ч. о проекте и о скраме) на портале, даже если она секретная и он в ней не состоит. -## Параметры +## Параметры метода + +{% include [Сноска об обязательных параметрах](../../_includes/required.md) %} + +#| +|| **Название** `тип` | **Описание** || +|| **params*** [`object`](../data-types.md) | Параметры запроса для получения группы. || +|# + +### Параметр `params` + +{% include [Сноска об обязательных параметрах](../../_includes/required.md) %} #| -|| **Параметр** | **Описание** | **С версии** || -|| **groupId** | Идентификатор группы. Обязательный параметр, целое число. | || +|| **Название** `тип` | **Описание** || +|| **groupId*** [`integer`](../data-types.md) | Идентификатор группы. Значение для поля может быть получено методом [sonet_group.get](./sonet-group-get.md). || +|| **select** [`array`](../data-types.md) | Массив ключей дополнительно-извлекаемых полей. Доступные ключи [см. ниже](#paramsselect). || +|| **mode** [`string`](../data-types.md) | Режим запроса. Может принимать только значение `mobile`, с помощью которого можно получить дополнительные данные (см. ниже). || |# -{% include [Сноска о параметрах](../../_includes/required.md) %} +#### Параметр `params[select]` {#paramsselect} + +#| +|| **Название** | **Описание** || +|| **ACTIONS** | Данные о доступных текущему пользователю (т.е. владельцу вебхука или пользователю приложения) операциях над группой. || +|| **AVATAR** | URL аватара группы. || +|| **AVATAR_TYPES** | Массив типов шаблонных аватаров для групп. || +|| **AVATAR_DATA** | Массив данных аватара группы. || +|| **COUNTERS** | Счётчики активных запросов на приглашение и подтверждение вступления в группу. || +|| **DATE_CREATE** | Дата создания в более читаемом формате. || +|| **DEPARTMENTS** | Отделы, выбранные при добавлении участников в группу. || +|| **FEATURES** | Доступные группе возможности (инструменты), которые указываются в параметрах группы. || +|| **GROUP_MEMBERS_LIST** | Массив активных участников группы и пользователей, ожидающих подтверждения вступления в группу. || +|| **LIST_OF_MEMBERS** | Массив участников группы. || +|| **LIST_OF_MEMBERS_AWAITING_INVITE** | Массив пользователей, ожидающих подтверждения вступления в группу. || +|| **OWNER_DATA** | Массив данных о владельце группы. || +|| **PIN** | Закреплена ли группа у текущего пользователя. || +|| **PRIVACY_TYPE** | Уровень доступа к группе. || +|| **SUBJECT_DATA** | Массив данных о тематике группы, которая указывается в параметрах группы. || +|| **TAGS** | Теги группы (не теги задач группы), которые указываются в параметрах группы. || +|| **USER_DATA** | Данные о роли текущего пользователя в группе. || +|# ## Поля @@ -92,4 +126,4 @@ BX24.callMethod('socialnetwork.api.workgroup.get', { console.log(result); }); ``` -{% include [Сноска о примерах](../../_includes/examples.md) %} \ No newline at end of file +{% include [Сноска о примерах](../../_includes/examples.md) %}