Изменить элемент процессса rpa.item.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
rpaКто может выполнять метод: пользователь с правом изменять элементы стадии или сменить стадию элементов, автор элемента с правом запускать процесс
DEPRECATED
Развитие метода остановлено. Используйте смарт-процессы как аналог функционала.
Метод обновляет элемент с идентификатором id процессса с идентификатором typeId.
Метод проверяет права в таком порядке.
-
Пользователь должен видеть элемент. Элементы видят все сотрудники портала, пользователям экстранета они недоступны. Без права просмотра метод возвращает ошибку и не отдает данные элемента. Код ошибки зависит от состава запроса:
RPA_ITEM_MOVE_ACCESS_DENIED— в запросе естьstageIdRPA_ITEM_MODIFY_ACCESS_DENIED— в запросе есть пользовательские поляRPA_ITEM_VIEW_ACCESS_DENIED— в остальных случаях
-
Если в запросе есть
stageId, проверяется право сменить стадию. Оно есть у пользователя, если выполнено одно из условий:- в настройках текущей стадии он указан в списке «Кто может сменить стадию элементов»
- он автор элемента и указан в списке «Кто может запускать процесс»
- он автор элемента, а элемент находится на первой стадии
-
Если запрос меняет значения пользовательских полей, проверяется право изменить элемент. Оно есть у пользователя, если выполнено одно из условий:
- в настройках текущей стадии он указан в списке «Кто может изменять элементы стадии»
- он автор элемента и указан в списке «Кто может запускать процесс». Тогда он может изменять свой элемент на любой стадии
Администратор портала проходит все проверки. Право запускать процесс не дает изменять и переносить чужие элементы.
Если запрос не меняет значения полей, например передает текущие значения, право изменить элемент не проверяется.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
typeId |
Идентификатор процесса |
|
id |
Идентификатор элемента |
|
fields* |
Объект со значениями пользовательских полей элемента |
Параметр fields
|
Название |
Описание |
|
stageId |
Идентификатор стадии |
|
UF_RPA_... |
Значения пользовательских полей. Формат передачи значений зависит от типа поля |
Примеры кода
-
Загрузить новый файл вместо старого (не множественное поле)
Чтобы заменить файл в не множественном поле, просто загрузите новый файл. Старый будет удален автоматически
JS{ "fields": { "UF_RPA_1_1585069397": [ "myfile.pdf", "...base64_encoded_file_content..." ] } } -
Удалить значение пользовательского поля типа файл
Для этого достаточно передать пустую строку
''вместо значения. -
Оставить значение не множественного поля типа файл без изменений
Самый простой вариант - не добавлять в
fieldsключ с этим полем. Но если надо и передать, и не изменить, то в качестве значения надо передать список, где по ключуidбудет идентификатор файла.JS{ "fields": { "UF_RPA_1_1585069397": { "id": 433 } } }Важно
Если в
idпередать отличное от текущего значения, то значение поля обнулится и файл будет стерт. -
Работа с множественным полем типа файл
Значение множественного поля — это массив. Каждый элемент массива подчинается тем же правилам, что и для не множественных значений.
-
Частичная перезапись значения множественного поля типа файл
Например, сейчас в множественном поле типа файл находится значение
[12, 255, 44].Необходимо оставить файла
12и44, а вместо255загрузить новый.Запрос должен выглядеть следующим образом:
JS{ "fields": { "UF_RPA_1_1585069397": [ { "id": 12 }, { "id": 44 }, [ "myNewFile.pdf", "...base64_encoded_file_content..." ] ] } }
Обработка ошибок
HTTP-статус: 400
{
"error": "RPA_ITEM_MODIFY_ACCESS_DENIED",
"error_description": "У вас нет прав на редактирование элементов в стадии Согласование"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
У вас нет прав на просмотр этого элемента |
Пользователь не видит элемент, а запрос не содержит |
|
|
|
У вас нет прав на смену стадии, когда элемент находится в стадии #STAGE# |
Нет права сменить стадию элемента. Если пользователь не видит элемент, описание ошибки — «У вас нет прав на просмотр этого элемента» |
|
|
|
У вас нет прав на редактирование элементов в стадии #STAGE# |
Нет права изменить элемент. Если пользователь не видит элемент, описание ошибки — «У вас нет прав на просмотр этого элемента» |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |