Получить информацию об элементе rpa.item.get

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

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

Scope: rpa

Кто может выполнять метод: любой пользователь

DEPRECATED

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

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

Название
тип

Описание

typeId
integer

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

id
integer

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

Обработка ответа

HTTP-статус: 200

{
    "item": {
        "id": 43,
        "stageId": 4,
        "previousStageId": 3,
        "name": "Название элемента",
        "typeId": 1,
        "createdBy": 1,
        "updatedBy": 1,
        "createdTime": "19.03.2020 13:07:39",
        "updatedTime": "23.03.2020 18:34:05",
        "movedTime": "23.03.2020 18:34:05",
        "detailUrl": "/rpa/item/1/43/",
        "movedBy": 1,
        "UF_RPA_1_NAME": "Название элемента",
        "tasksCounter": 0,
        "tasksFaces": {
            "completed": [
                1
            ],
            "running": [],
            "all": [
                1
            ]
        },
        "permissions": {
            "draggable": true,
            "droppable": true,
            "canDelete": true,
            "canModify": true
        },
        "users": {
            "1": {
                "id": "1",
                "name": "Anton",
                "secondName": null,
                "lastName": "",
                "title": null,
                "workPosition": null,
                "fullName": "Anton",
                "link": "/company/personal/user/1/"
            }
        }
    }
}

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

Название

Описание

stageId

Идентификатор стадии, на которой находится элемент

previousStageId

Идентификатор предыдущей стадии элемента

name

Название элемента

typeId

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

createdBy

Идентификатор пользователя, создавшего элемент

updatedBy

Идентификатор пользователя, изменившего элемент

movedBy

Идентификатор пользователя, изменившего стадию элемента

createdTime

Время создания элемента

updatedTime

Время изменения элемента

movedTime

Время изменения стадии элемента

detailUrl

Ссылка на карточку элемента

tasksCounter

Количество заданий на элементе для пользователя

tasksFaces

Информация для отрисовки последовательности ответственных при утверждении:

  • completed — кто выполнил задание
  • running — кто выполняет задание
  • all — все участники

permissions

Права текущего пользователя на элемент:

  • draggable — может сменить стадию элемента
  • droppable — служебный признак для канбана
  • canDelete — может удалить элемент
  • canModify — может изменить значения полей элемента

users

Агрегированная информация о всех пользователях, имеющих отношение к элементу. Список, где ключ — идентификатор пользователя:

  • id — идентификатор
  • name — имя
  • secondName — отчество
  • lastName — фамилия
  • title — обращение
  • workPosition — должность
  • fullName — форматированное имя
  • link — ссылка на профиль

UF_RPA_...

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

Значения множественных полей отдаются в виде массива.

Значение поля типа Файл отдаются в виде списка:

  • id — идентификатор
  • url — ссылка на файл на портале
  • urlMachine — ссылка на файл для приложения

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

HTTP-статус: 400

{
    "error": "RPA_ITEM_VIEW_ACCESS_DENIED",
    "error_description": "У вас нет прав на просмотр этого элемента"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

RPA_ITEM_VIEW_ACCESS_DENIED

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

Пользователь не видит элемент. Элементы видят все сотрудники портала, пользователям экстранета они недоступны

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

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

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

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