workplaces.workplace.add

Scope: workplaces

Кто может вызывать: Администратор раздела комнаты

Создаёт элемент рабочего места.

HTTP: POST

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
name string да Название
roomId int да ID комнаты
typeId int нет enum id (приоритет над type)
type string нет xmlId типа
linkedUserId int нет 0 — снять закрепление
info string[] нет xmlId иконок INFO
size string нет
previewText string нет
pathSvg string нет Рекомендуется передавать
pathSvgPc string нет
active bool нет По умолчанию true

Возвращаемые данные

result.result: { "id": 1287 }

Обработка ошибок

Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
ACCESS_DENIED Нет прав на операцию или объект
VALIDATION_ERROR Пустое name; roomId не указан; некорректные поля
NOT_FOUND Комната (roomId) не найдена
USER_NOT_FOUND Пользователь (linkedUserId) не найден

Примеры кода

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.workplace.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"name": "Место API", "roomId": 110, "type": "with_PC", "pathSvg": "<path d=\"M0 0\"/>"}'

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

{
          "result": {
            "result": {
              "id": 1287
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
Предыдущая
workplaces.workplace.get
Следующая
workplaces.workplace.update