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

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

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 24 Следующий »

Запрос: POST /group/smart/{group_id}

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

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

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

Заголовок

Описание

X-Auth-Account-Url (обязательный)Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru
X-Auth-Email (обязательный)Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения или пользователя с ролью с индивидуальными настройками, которые позволяют редактировать группы.
X-Auth-Password (обязательный)

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

group_id (обязательный)ID смарт-группы, которую вы хотите отредактировать.
ПараметрОписание
name (необязательный)Название смарт-группы.
attributeType (обязательный)

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

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

  • 2 - группа

  • 3 - поля профиля

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

Идентификатор поля профиля. Заполняется только для полей профиля.

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

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

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

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

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

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

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

Для групп:

  • ID группы

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

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

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

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

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

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

Коды ответов

Код

Текст

Описание

200OKСмарт-группа успешно изменена.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса.

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

POST /group/smart/b1496214-acab-11e9-8db0-120a62f268a9 https/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: https://myaccount.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password
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 200 OK
При выполнении команды старые правила перезапишутся.
  • Нет меток