Элементы
Scope: rpa Права на выполнение: для всех
Подробнее об элементах можно прочитать в документации по rpa.
Так как элементы каждого процесса хранятся в отдельной таблице - идентификаторы элементов разных процессов будут совпадать.
Поэтому во все методы необходимо передавать идентификатор процесса typeId
rpa.item.*
| Метод | Описание | С версии |
|---|---|---|
rpa.item.get({typeId: number, id: number}) |
Отдает информацию об элементе с идентификатором id процесса с идентификатором typeId. Параметры:
Ответ {
"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
]
},
"users": {
"1": {
"id": "1",
"name": "Anton",
"secondName": null,
"lastName": "",
"title": null,
"workPosition": null,
"fullName": "Anton",
"link": "/company/personal/user/1/"
}
}
}
}
Здесь
|
|
rpa.item.list({typeId: number, order: ?{} = null, filter: ?{} = null, start: ?number = 0}) |
Метод вернет массив элементов процесса с идентификатором typeId. Параметры:
В ответе будут только основные поля элементов, без данных о заданиях и пользователях элементов {
"items": [
{},
{}
]
}
Примеры фильтра
|
|
rpa.item.add({typeId: number, fields: ?{}) |
Метод создает новый элемент процесса с идентификатором typeId. Параметры:
После создания элемента роботы будут запущены автоматически Метод вернет результат аналогичный вызову метода Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент - это имя файла, а второй - это закодированный в base64 контент файла |
|
rpa.item.update({typeId: number, id: number, fields: {}) |
Метод обновляет элемент с идентификатором id процессса с идентификатором typeId. Параметры:
Чтобы заменить файл в не множественном поле, просто загрузите новый файл. Старый будет удален автоматически {
"fields": {
"UF_RPA_1_1585069397": [
"myfile.pdf", "...base64_encoded_file_content..."
]
}
}
Удалить значение пользовательского поля типа файл
Для этого достаточно передать пустую строку ( Самый простой вариант - не добавлять в {
"fields": {
"UF_RPA_1_1585069397": {
"id": 433
}
}
}
Если в Значение множественного поля - это массив. Каждый элемент массива подчинается тем же правилам, что и для не множественных значений. Частичная перезапись значения множественного поля типа файлНапример, сейчас в множественном поле типа файл находится значение Необходимо оставить файла Запрос должен выглядеть следующим образом: {
"fields": {
"UF_RPA_1_1585069397": [
{
"id": 12
},
{
"id": 44
},
[
"myNewFile.pdf",
"...base64_encoded_file_content..."
]
]
}
}
|
|
rpa.item.delete({typeId: number, id: number) |
Метод удалит элемент. Параметры:
|
|
rpa.item.getTasks({{typeId: number, id: number}) |
Метод вернет данные о текущих заданиях элемента с идентификатором id процесса с идентификатором typeId. Параметры:
Пример ответа {
"tasks": [
{
"id": "93",
"title": "asdf",
"description": "",
"userId": 1,
"data": {
"participantJoint": "or",
"isMine": true,
"controls": {
"BUTTONS": [
{
"TYPE": "submit",
"TARGET_USER_STATUS": 3,
"NAME": "complete",
"VALUE": "Y",
"TEXT": "Сохранить",
"COLOR": "3bc8f5"
}
]
},
"type": "RpaRequestActivity",
"url": "/rpa/task/id/93/",
"fieldsToShow": null,
"fieldsToSet": [
"Название"
],
"users": [
{
"id": 1,
"status": 0
}
]
},
"itemClassName": "BX.Rpa.Timeline.Task",
"users": {
"1": {
"id": "1",
"name": "Anton",
"secondName": "",
"lastName": "Gorbylev",
"title": null,
"workPosition": "",
"fullName": "Anton Gorbylev",
"link": "/company/personal/user/1/"
}
}
}
]
}
|
Сообщение не промодерировано, возможны ошибки и неточности.
|
|
Для изменения названия элемента вместо параметра name нужно использовать UF_RPA_1_NAME
(либо UF_RPA_2_NAME, UF_RPA_3_... и т.д., в зависимости от ID вашего процесса RPA). |
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.