API - Рабочие группы

COMMUNITYCOREBUSINESSENTERPRISE

Внимание

Для выполнения запроса к API необходима дополнительная авторизация.

---

Используйте в запросе заголовок Authorization: Bearer <персональный токен>.

---

Где получить персональный токен?

Получение доступных рабочих групп

GET /api/public/sm/v2/rsm/work-groups

Запрос возвращает список моделей рабочих групп:

[
  {
    "id": 0,
    "name": "Name"
  }
]

---

Получение списка рабочих групп по фильтру

POST /api/public/pl/v2/work-groups/filter

Запрос возвращает список найденных пользователей.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
page	integer	нет	null	Номер страницы
perPage	integer	нет	null	Количество записей на одну страницу. Если -1 - будут возвращены все объекты
search	string	нет	null	Строка поиска
sortCol	string	нет	null	Название поля, по которому выполняется сортировка
sortDir	string	нет	null	Направление сортировки (asc/desc)
skip	integer	нет	null	Количество записей, которое требуется пропустить
fieldMask	string []	нет	null	Маска полей

Тело запроса

{
  "ids": [
    0
  ],
  "names": [
    "string"
  ],
  "groupTypes": [
    "Private"
  ]
}

WorkGroupTypes

• Private
• Public
• Closed

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для выполнения операции

Модель ответа

[
  {
    "id": 0,
    "name": "string",
    "workGroupKey": "string",
    "description": "string",
    "manager": {
      "id": 0,
      "name": "string"
    },
    "type": "Private"
  }
]

---

Создание рабочих групп пакетно

POST /api/public/pl/v2/work-groups/batch

Запрос создает рабочие группы и возвращает их список.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
fieldMask	string []	нет	null	Маска полей

Тело запроса

[
  {
    "name": "string",
    "workGroupKey": "string",
    "description": "string",
    "managerId": 0,
    "type": "Private",
    "members": [
      {
        "memberId": 0,
        "type": "User"
      }
    ]
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
name	да	string	null	Название рабочей группы
workGroupKey	да	string	null	Ключ рабочей группы
description	нет	string	null	Описание рабочей группы
managerId	да	integer	null	Идентификатор владельца группы
type	нет	string::WorkGroupTypes	Closed	Тип рабочей группы
members	нет	object []	null	Список моделей пользователей или групп пользователей

WorkGroupTypes

• Private
• Public
• Closed

Модель участников РГ

...
"members": [
      {
        "memberId": 0,
        "type": "User"
      }
    ]
...

где, type может принимать следующие значения:

• User - означает, что в MemberId указан идентификатор пользователя
• Group - означает, что в MemberId указан идентификатор группы пользователей

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для выполнения операции

Модель ответа

{
  "workGroups": [
    {
      "id": 0,
      "name": "string",
      "workGroupKey": "string",
      "description": "string",
      "manager": {
        "id": 0,
        "name": "string"
      },
      "type": "Private"
    }
  ],
  "status": "Unknown",
  "errors": [
    {
      "entity": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Маска полей работает в рамках объекта workGroups.

---

Удаление рабочих групп пакетно

DELETE /api/public/pl/v2/work-groups/batch

Запрос удаляет рабочие группы и возвращает их список.

Параметры запроса

Отсутствуют

Тело запроса

[
  0
]

Поля тела запроса

Принимает на вход массив идентификаторов рабочих групп.

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для получения списка групп пользователей

Модель ответа

{
  "deletedGroups": [
    0
  ],
  "status": "Unknown",
  "errors": [
    {
      "entity": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

---

Частичное обновление рабочих групп пакетно

PATCH /api/public/pl/v2/work-groups/batch

Запрос выполняет частичное обновление информации о рабочих группах и возвращает их список.

Параметры запроса

Отсутствуют

Тело запроса

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "managerId": 0,
    "type": "Private"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
id	да	integer	null	Идентификатор рабочей группы
name	нет	string	null	Название рабочей группы
description	нет	string	null	Описание рабочей группы
managerId	нет	integer	null	Идентификатор владельца группы
type	нет	string::WorkGroupTypes	Closed	Тип рабочей группы

WorkGroupTypes

• Private
• Public
• Closed

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Неверная модель данных в теле запроса
401	Не удалось выполнить авторизацию пользователя
403	Недостаточно прав для выполнения операции

Модель ответа

{
  "workGroups": [
    {
      "id": 0,
      "name": "string",
      "workGroupKey": "string",
      "description": "string",
      "manager": {
        "id": 0,
        "name": "string"
      },
      "type": "Private"
    }
  ],
  "status": "Unknown",
  "errors": [
    {
      "entity": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

---

Получение списка ролей в рабочей группе

GET /api/public/pl/v2/work-groups/{id}/roles

Запрос возвращает список ролей рабочей группы.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
id	integer	нет	null	Идентификатор рабочей группы

Тело запроса

Отсутствует

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Недопустимое значение идентификатора рабочей группы
401	Не удалось выполнить авторизацию пользователя
404	Рабочая группа с идентификатором {id} не найдена
403	Недостаточно прав для выполнения операции

Модель ответа

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSystem": true,
    "isDefault": true
  }
]

---

Получение списка участников рабочей группы

GET /api/public/pl/v2/work-groups/{id}/members

Запрос возвращает список участников рабочей группы.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
id	integer	нет	null	Идентификатор рабочей группы

Тело запроса

Отсутствует

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Недопустимое значение идентификатора рабочей группы
401	Не удалось выполнить авторизацию пользователя
404	Рабочая группа с идентификатором {id} не найдена
403	Недостаточно прав для выполнения операции

Модель ответа

[
  {
    "memberId": 0,
    "type": "User",
    "roles": [
      {
        "id": 0,
        "name": "string",
        "isSystem": true,
        "isDefault": true
      }
    ]
  }
]

---

Добавление участников в рабочую группу

POST /api/public/pl/v2/work-groups/{id}/members

Запрос выполняет добавление пользователей в рабочую группу и возвращает их список.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
id	integer	нет	null	Идентификатор рабочей группы

Тело запроса

{
  "members": [
    {
      "memberId": 0,
      "type": "User"
    }
  ],
  "roleIds": [
    0
  ]
}

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
members	нет	object []	null	Список моделей пользователей или групп пользователей
roleIds	нет	integer []	null	Список идентификаторов ролей, которые будут назначены

Модель участников РГ

...
"members": [
      {
        "memberId": 0,
        "type": "User"
      }
    ]
...

где, type может принимать следующие значения:

• User - означает, что в MemberId указан идентификатор пользователя
• Group - означает, что в MemberId указан идентификатор группы пользователей

Коды ответов

Код ответа	Описание
200	Запрос выполнен успешно
400	Недопустимое значение идентификатора рабочей группы. Пустое тело запроса. Неверная модель данных в теле запроса.
401	Не удалось выполнить авторизацию пользователя
404	Рабочая группа с идентификатором {id} не найдена
403	Недостаточно прав для выполнения операции

Модель ответа

[
  {
    "memberId": 0,
    "type": "User",
    "roles": [
      {
        "id": 0,
        "name": "string",
        "isSystem": true,
        "isDefault": true
      }
    ]
  }
]

---

Удаление участников из рабочей группы

DELETE /api/public/pl/v2/work-groups/{id}/members

Запрос выполняет исключение пользователей из рабочей группы и возвращает их список.

Параметры запроса

Название параметра	Тип параметра	Обязательный параметр	Значение по умолчанию	Описание параметра
id	integer	нет	null	Идентификатор рабочей группы

Тело запроса

[
  {
    "memberId": 0,
    "type": "User"
  }
]

Поля тела запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
memberId	нет	integer	null	Идентификатор участника
type	нет	string	null	Тип участника

Коды ответов

Код ответа	Описание
204	Запрос выполнен успешно
400	Недопустимое значение идентификатора рабочей группы. Пустое тело запроса. Неверная модель данных в теле запроса.
401	Не удалось выполнить авторизацию пользователя
404	Рабочая группа с идентификатором {id} не найдена
403	Недостаточно прав для выполнения операции

Модель ответа

Отсутствует