Документация по iSpring Learn

Дерево страниц

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Запрос: POST /group/smart

Права для выполнения запроса 

Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют добавлять группы.

Заголовки и параметры запроса

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
name (обязательный)Название новой группы

attributeType (обязательный)

Может принимать значения:

  • 1— подразделение,

  • 2 — группа,

  • 3 — поле профиля

attributeId (необязательный)

Идентификатор поля профиля. Заполняется только для поля профиля (attributeType — 3)

operator (обязательный)

Для подразделений:

  • 1 — одно подразделение без его дочерних подразделений,
  • 2 — подразделение и все его дочерние подразделения.

Для групп и полей профиля:

  • всегда 1
value (обязательный)

Для подразделений:

  • ID подразделения

Для групп:

  • ID группы

Для поля профиля:

  • значение поля профиля (например, для поля Фамилия значение — Соколов)

Внимание: для поля Страна нужно использовать ID страны, а не название. ID страны можно получить при помощи метода Получение списка полей профиля пользователя

Заголовок

Описание

Вы можете добавить несколько групп условий для добавления пользователей в смарт-группу. Они будут работать по принципу «И», то есть должны будут сработать одновременно.

Внутри этих групп создайте любое число правил. Они, напротив, работают по принципу «ИЛИ», то есть достаточно выполнения одного из правил.

Подробнее о смарт-группах и их условиях читайте в статье Смарт-группы

Параметры ответа

ПараметрОписание
responseID добавленной смарт-группы

Коды ответов

201

Created

Новая смарт-группа добавлена
400 Bad RequestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission denied

У пользователя недостаточно прав для выполнения запроса

Код

Текст

Описание

Пример запроса

POST /group/smart https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
Content-Type:application/xml
  
<?xml version="1.0" encoding="UTF-8"?>
<request>
    <name>New Group</name>
    <rules>
        <and>
            <or>
                <rule>
                    <attributeType>1</attributeType>
                    <attributeId></attributeId>
                    <operator>1</operator>
                    <value>6f774f46-de00-11e9-bb11-0a580af40984</value>
                </rule>
            </or>
            <or>
                 <rule>
                    <attributeType>2</attributeType>
                    <attributeId></attributeId>
                    <operator>1</operator>
                    <value>eb53de1e-dea4-11e9-8de4-0a580af40738</value>
                </rule>
            </or>
            <or>
                <rule>
                     <attributeType>3</attributeType>
                     <attributeId>JOB_TITLE</attributeId>
                     <operator>1</operator>
                     <value>Sales Manager</value>
                </rule>
            </or>
        </and>
    </rules>
</request>

Пример ответа

https/1.1 201 Created

<?xml version="1.0" encoding="UTF-8"?>
<response>3fa85f64-5717-4562-b3fc-2c963f66afa6</response>