Получить информацию об элементе rpa.item.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
rpaКто может выполнять метод: любой пользователь
DEPRECATED
Развитие метода остановлено. Используйте смарт-процессы как аналог функционала.
Метод получает информацию об элементе с идентификатором id процесса с идентификатором typeId.
|
Название |
Описание |
|
typeId |
Идентификатор процесса |
|
id |
Идентификатор элемента |
Обработка ответа
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 |
Информация для отрисовки последовательности ответственных при утверждении:
|
|
permissions |
Права текущего пользователя на элемент:
|
|
users |
Агрегированная информация о всех пользователях, имеющих отношение к элементу. Список, где ключ — идентификатор пользователя:
|
|
UF_RPA_... |
Значения пользовательских полей. Значения множественных полей отдаются в виде массива. Значение поля типа Файл отдаются в виде списка:
|
Обработка ошибок
HTTP-статус: 400
{
"error": "RPA_ITEM_VIEW_ACCESS_DENIED",
"error_description": "У вас нет прав на просмотр этого элемента"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
У вас нет прав на просмотр этого элемента |
Пользователь не видит элемент. Элементы видят все сотрудники портала, пользователям экстранета они недоступны |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |