-

docs/integration/events.rst

@@ -284,3 +284,138 @@
 Минимальный набор передаваемых данных для всех событий типа
 ``event.projects.arrangement.*`` - это идентификатор мероприятия
 проекта.
+
+События по документам
+---------------------
+
+*   ``event.docflow.document.register`` Регистрация документа в
+    журнале
+
+Минимальный набор передаваемых данных в сообщении для события
+``event.docflow.document.register`` - идентификатор документа.
+
+В свойствах сообщения (ключ ``registerID``) передаётся
+идентификатор журнала.
+
+События по формам
+-----------------
+
+*   ``event.form.formdata.change`` Создание и сохранение данных по форме
+
+Минимальный набор передаваемых данных в сообщении для события
+``event.form.formdata.change``:
+
+    *   ``dataUUID`` - идентификатор данных по форме;
+    *   ``formID`` - идентификатор формы;
+    *   ``isNew`` - сохранены ли данные:
+
+        *   true - новые;
+        *   false - существующие.
+
+В свойствах сообщения (ключ ``dataUUID``) также передаётся идентификатор данных
+по форме.
+
+События комментариев
+--------------------
+
+Данные события генерируются для каждого из нижеописанных случаев:
+
+**Комментарии к работе**
+
+*   ``event.comment.work.add`` Добавление нового комментария к работе
+
+*   ``event.comment.work.change`` Изменение комментария к работе
+
+*   ``event.comment.work.delete`` Удаление комментария к работе
+
+.. note:: При добавлении/изменении/удалении комментария к работе, аналогичное
+          событие для документов в очередь не добавляется.
+
+**Комментарии к документу**
+
+*   ``event.comment.document.add`` Добавление нового комментария к
+    документу
+
+*   ``event.comment.document.change`` Изменение комментария к
+    документу
+
+*   ``event.comment.document.delete`` Удаление комментария к
+    документу
+
+**Личные комментарии**
+
+*   ``event.comment.personal.add`` Добавление нового личного
+    комментария
+
+*   ``event.comment.personal.change`` Изменение личного
+    комментария
+
+*   ``event.comment.personal.delete`` Удаление личного
+    комментария
+
+**Комментарии к проекту/мероприятию**
+
+*   ``event.comment.action.add`` Добавление нового комментария к
+    мероприятию проекта
+
+*   ``event.comment.action.change`` Изменение комментария к
+    мероприятию проекта
+
+*   ``event.comment.action.delete`` Удаление комментария к
+    мероприятию проекта
+
+Для всех событий типа ``event.comment.*`` передаваемые данные зависят
+от типа комментария и выглядят следующим образом:
+
+*   Комментарий к работе:
+
+    *   идентификатор комментария (свойство с ключом ``message text``)
+    *   идентификатор автора комментария (свойство с ключом ``userID``)
+    *   идентификатор документа (свойство с ключом ``documentID``)
+    *   идентификатор работы (свойство с ключом ``actionID``)
+
+*   Комментарий к документу:
+
+    *   идентификатор комментария (свойство с ключом ``message text``)
+    *   идентификатор автора комментария (свойство с ключом ``userID``)
+    *   идентификатор документа (свойство с ключом ``documentID``)
+
+*   Личный комментарий:
+
+    *   идентификатор комментария (свойство с ключом ``message text``)
+    *   идентификатор автора комментария (свойство с ключом ``userID``)
+    *   идентификатор документа (свойство с ключом ``documentID``)
+    *   идентификатор работы (свойство с ключом ``actionID``)
+
+*   Комментарий к мероприятию:
+
+    *   идентификатор комментария (свойство с ключом ``message text``)
+    *   идентификатор автора комментария (свойство с ключом ``userID``)
+    *   идентификатор проекта (свойство с ключом ``projectID``)
+    *   идентификатор мероприятия (свойство с ключом ``actionID``)
+
+    .. note:: В случае, если объектом события является комментарий к проекту,
+              то параметры ``projectID`` и ``actionID`` будут равны.
+
+Генерация произвольных событий
+------------------------------
+
+В ARTA Synergy имеется метод API, позволяет генерировать
+произвольные события.
+
+URL метода: ``rest/api/events/create``. Тип запроса: ``POST``.
+
+Метод принимает следующие обязательные параметры:
+
+*   ``eventName`` - название события (строка);
+
+*   ``eventMsg`` - произвольный json (строка).
+
+В случае успешного выполнения метода сервер вернет сообщение «Событие
+успешно сгенерировано».
+
+*Пример:*
+
+Событие, генерируемое мобильным клиентом по координатам GPS::
+
+    eventName=event.ext.gps&eventMsg={\"lat\":333.333,\"lon\":222.222}