Записи таймлайна

Scope: rpa Права на выполнение: для всех

Набор методов для работы с записями таймлайна

Подробнее о структуре таблицы читайте в документации по rpa.

rpa.timeline.*

Метод	Описание	С версии
`rpa.timeline.listForItem({typeId: number, itemId: number, start: ?number = 0})`	Метод возвращает массив записей таймлайна для элемента с идентификатором `itemId` процесса с идентификатором `itemId`, отсортированные по убыванию даты создания (сверху самые новые). Параметры: `typeId` - идентификатор процесса `itemId` - идентификатор элемента `start` - сдвиг для постраничной навигации Пример ответа { "timeline": [ { "id": 321, "typeId": 24, "itemId": 10, "createdTime": "2020-03-26T20:28:57+02:00", "userId": 1, "title": "Выполнено задание", "description": "", "action": "task_complete", "isFixed": false, "data": { "item": { "name": "New name" }, "scope": "task", "stageFrom": { "id": 30, "name": "Утверждение бухгалтером" }, "stageTo": { "id": 31, "name": "Утверждено" }, "fields": [ { "name": "UF_RPA_24_NAME", "title": "Название" } ], "task": { "ID": "91", "USER_ID": "1", "WORKFLOW_ID": "5e7cf3e91ef413.27314358", "ACTIVITY": "RpaRequestActivity", "ACTIVITY_NAME": "A79985_79846_49104_50661", "NAME": "Task", "DESCRIPTION": "", "PARAMETERS": { "DOCUMENT_ID": [ "rpa", "Bitrix\\Rpa\\Integration\\Bizproc\\Document\\Item", "24:10" ], "TASK_EDIT_URL": "/rpa/task/id/#ID#/", "ACTIONS": [ { "color": "3bc8f5", "stageId": "31", "label": "Сохранить" } ], "FIELDS_TO_SHOW": [ "UF_RPA_24_NAME", "UF_RPA_24_STRING_MANDATORY" ], "RESPONSIBLE_TYPE": null, "APPROVE_TYPE": null, "FIELDS_TO_SET": [ "UF_RPA_24_NAME" ] }, "USERS": [ 1 ], "INCOMPLETE_USERS": [ ] } }, "createdTimestamp": 1585247337000, "users": { "1": { "id": "1", "name": "Anton", "secondName": "", "lastName": "Gorbylev", "title": null, "workPosition": "", "fullName": "Anton Gorbylev", "link": "/company/personal/user/1/" } } }, ] } `id` - идентификатор записи `typeId` - идентификатор процесса `itemId` - идентификатор элемента `createdTime` - время создания записи `userId` - идентификатор пользователя, который инициировал действие `title` - заголовок записи `description` - текстовое содержимое записи `action` - код типа действия `isFixed` - флаг прикрепления записи `data` - сериализованные данные о выполненном действии и связанных сущностях на момент создания записи. В зависимости от типа действия может содержать разный набор данных. Основные параметры это: `item` - данные об элементе `item[name]` - название элемента на момент выполнения действия `scope` - код источника действия, может принимать одно из следующих значений: `manual` - вручную `task` - при выполнении задания `automation` - роботом `rest` - приложением `stageFrom` - данные об исходной стадии на момент выполнения действия `id` - идентификатор `name` - название `stageTo` - данные о новой стадии (если она была изменена при выполнении действия) `fields` - массив данных о полях, значения которых были изменены при выполнении действия `name` - код поля `title` - заголовок поля `task` - данные о задании (если действие было выполнено при выполнении задания) `users` - данные о пользователях, которые имели отношение к действию
`rpa.timeline.updateIsFixed({id: number, isFixed: string})`	Метод обновляет флаг прикрепления записи. Параметры: `id` - идентификатор записи `isFixed` - флаг прикрепления записи. Если `y` - запись будет прикреплена, иначе - нет Метод вернет данные об обновленной записи таймлайна { "timeline": { "id": 322, ... } }
`rpa.timeline.add({typeId: number, itemId: number, fields: {}})`	Метод создаст новую запись таймлайна у элемента с идентификатором `itemId` процесса с идентификатором `typeId`. Параметры: `typeId` - идентификатор процесса `itemId` - идентификатор элемента `fields` - поля записи. `title` - заголовок записи `description` - описание записи (можно использовать html) Этот метод позволяет изменять только поля `title` и `description` Пример выполнения { "timeline": { "id": 325, "typeId": 24, "itemId": 10, "createdTime": "2020-03-26T21:55:25+02:00", "userId": 1, "title": "rest update", "description": "<h5>small header</h5>", "action": false, "isFixed": false, "data": { "scope": "rest" }, "createdTimestamp": 1585252525000, "users": { "1": { "id": "1", "name": "Anton", "secondName": "", "lastName": "", "title": null, "workPosition": "", "fullName": "Anton", "link": "/company/personal/user/1/" } } } }
`rpa.timeline.update({id: number, fields: {}})`	Метод обновит запись таймлайна с идентификатором `id`. Параметры: `id` - идентификатор записи `fields` - поля записи. `title` - заголовок записи `description` - описание записи (можно использовать html) Этот метод позволяет изменять только поля `title` и `description` Этот метод позволяет изменять только те записи, которые были созданы этим же пользователем и с помощью приложения.
`rpa.timeline.delete({id: number})`	Метод удалит запись таймлайна с идентификатором `id`. Параметры: `id` - идентификатор записи Этот метод позволяет удалять только те записи, которые были созданы этим же пользователем и с помощью приложения.

Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.