Изменить элемент процессса rpa.item.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: rpa

Кто может выполнять метод: пользователь с правом изменять элементы стадии или сменить стадию элементов, автор элемента с правом запускать процесс

DEPRECATED

Развитие метода остановлено. Используйте смарт-процессы как аналог функционала.

Метод обновляет элемент с идентификатором id процессса с идентификатором typeId.

Метод проверяет права в таком порядке.

  1. Пользователь должен видеть элемент. Элементы видят все сотрудники портала, пользователям экстранета они недоступны. Без права просмотра метод возвращает ошибку и не отдает данные элемента. Код ошибки зависит от состава запроса:

    • RPA_ITEM_MOVE_ACCESS_DENIED — в запросе есть stageId
    • RPA_ITEM_MODIFY_ACCESS_DENIED — в запросе есть пользовательские поля
    • RPA_ITEM_VIEW_ACCESS_DENIED — в остальных случаях
  2. Если в запросе есть stageId, проверяется право сменить стадию. Оно есть у пользователя, если выполнено одно из условий:

    • в настройках текущей стадии он указан в списке «Кто может сменить стадию элементов»
    • он автор элемента и указан в списке «Кто может запускать процесс»
    • он автор элемента, а элемент находится на первой стадии
  3. Если запрос меняет значения пользовательских полей, проверяется право изменить элемент. Оно есть у пользователя, если выполнено одно из условий:

    • в настройках текущей стадии он указан в списке «Кто может изменять элементы стадии»
    • он автор элемента и указан в списке «Кто может запускать процесс». Тогда он может изменять свой элемент на любой стадии

Администратор портала проходит все проверки. Право запускать процесс не дает изменять и переносить чужие элементы.

Если запрос не меняет значения полей, например передает текущие значения, право изменить элемент не проверяется.

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

Обязательные параметры отмечены *

Название
тип

Описание

typeId
integer

Идентификатор процесса

id
integer

Идентификатор элемента

fields*
object

Объект со значениями пользовательских полей элемента

Параметр fields

Название
тип

Описание

stageId
integer

Идентификатор стадии

UF_RPA_...
any

Значения пользовательских полей. Формат передачи значений зависит от типа поля

Примеры кода

  1. Загрузить новый файл вместо старого (не множественное поле)

    Чтобы заменить файл в не множественном поле, просто загрузите новый файл. Старый будет удален автоматически

    {
        "fields": {
            "UF_RPA_1_1585069397": [
                "myfile.pdf", "...base64_encoded_file_content..."
            ]
        }
    }
    
  2. Удалить значение пользовательского поля типа файл

    Для этого достаточно передать пустую строку '' вместо значения.

  3. Оставить значение не множественного поля типа файл без изменений

    Самый простой вариант - не добавлять в fields ключ с этим полем. Но если надо и передать, и не изменить, то в качестве значения надо передать список, где по ключу id будет идентификатор файла.

    {
        "fields": {
            "UF_RPA_1_1585069397": {
                "id": 433    
            }
        }
    }
    

    Важно

    Если в id передать отличное от текущего значения, то значение поля обнулится и файл будет стерт.

  4. Работа с множественным полем типа файл

    Значение множественного поля — это массив. Каждый элемент массива подчинается тем же правилам, что и для не множественных значений.

  5. Частичная перезапись значения множественного поля типа файл

    Например, сейчас в множественном поле типа файл находится значение [12, 255, 44].

    Необходимо оставить файла 12 и 44, а вместо 255 загрузить новый.

    Запрос должен выглядеть следующим образом:

    {
        "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
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

RPA_ITEM_VIEW_ACCESS_DENIED

У вас нет прав на просмотр этого элемента

Пользователь не видит элемент, а запрос не содержит stageId и пользовательских полей

400

RPA_ITEM_MOVE_ACCESS_DENIED

У вас нет прав на смену стадии, когда элемент находится в стадии #STAGE#

Нет права сменить стадию элемента. Если пользователь не видит элемент, описание ошибки — «У вас нет прав на просмотр этого элемента»

400

RPA_ITEM_MODIFY_ACCESS_DENIED

У вас нет прав на редактирование элементов в стадии #STAGE#

Нет права изменить элемент. Если пользователь не видит элемент, описание ошибки — «У вас нет прав на просмотр этого элемента»

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение