Документация для разработчиков
Темная тема

Комментарии

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

Набор методов для работы с комментариями в таймлайне элементов.

По факту комментарии - это те же записи таймлайна, но с другим отображением и возможностью редактирования пользователем.

Данные о комментариях можно получить методом rpa.timeline.listForItem - этот метод возвращает все записи, в том числе комментарии.

rpa.comment.*

Метод Описание С версии
rpa.comment.add({typeId: number, itemId: number, fields: {}}) Метод создаст новый комментарий в таймлайне элемента с идентификатором itemId процесса с идентификатором typeId. Параметры:
  • typeId - идентификатор процесса
  • itemId - идентификатор элемента
  • fields - поля комментария.
    • description - описание записи (можно использовать html и BB-code)
    • files - массив прикрепленных файлов, где каждый элемент - это массив с именем и закодированным в base64 содержимым

Пример запроса

{
	"typeId": 24,
	"itemId": 10,
	"fields": {
		"description": "Упоминание пользователя с ид 1 [USER=1]Anton[/USER]",
		"files": [
			[
				"document.pdf", "...base64_decoded_content..."
			]
		]	 
	}
}

Результат

{
	"comment": {
		"id": 350,
		"createdTime": "2020-03-27T16:00:59+02:00",
		"isFixed": false,
		"typeId": 24,
		"itemId": 10,
		"action": "comment",
		"description": "Упоминание пользователя с ид 1 [USER=1]Anton[/USER]",
		"userId": 1,
		"title": "Комментарий",
		"data": {
			"files": [
				15
			]
		},
		"createdTimestamp": 1585317659000,
		"htmlDescription": "Упоминание пользователя с ид 1 <a class=\"blog-p-user-name\" id=\"bp_K6r6vvp7\" href=\"/company/personal/user/1/\" bx-tooltip-user-id=\"1\">Anton Gorbylev</a> &nbsp;",
		"textDescription": "Упоминание пользователя с ид 1 Anton",
		"users": {
			"1": {
				"id": "1",
				"name": "Anton",
				"secondName": "",
				"lastName": "",
				"title": null,
				"workPosition": "",
				"fullName": "Anton",
				"link": "/company/personal/user/1/"
			}
		}
	}
}
rpa.comment.update({id: number, fields: {}}) Метод обновит запись таймлайна с идентификатором id. Параметры:
  • id - идентификатор комментария
  • fields - поля записи.
    • description - описание записи (можно использовать html и BB-code)
    • files - массив прикрепленных файлов, где каждый элемент - это массив с именем и закодированным в base64 содержимым

Этот метод позволяет изменять только поля title и description

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

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

Для загрузки новых надо также передать массив с именем и содержимым файла в base64

Пример

{
	"typeId": 24,
	"itemId": 10,
	"fields": {
		"description": "Упоминание пользователя с ид 1 [USER=1]Anton[/USER]",
		"files": [
			{
				"id": 15   
			},
			[
				"another_document.pdf", "...base64_decoded_content..."
			]
		]
	}
}
rpa.comment.delete({id: number}) Метод удалит комментарий с идентификатором id. Параметры:
  • id - идентификатор записи

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

© «Битрикс», 2001-2024, «1С-Битрикс», 2024