From 21c00a05b63739ddd577b9f51b9b44bed8b6ce59 Mon Sep 17 00:00:00 2001 From: Andrey Zelenin Date: Wed, 5 Feb 2025 20:10:10 +0300 Subject: [PATCH 1/3] =?UTF-8?q?crm:=20timeline:=20=D0=B4=D0=B5=D0=B9=D1=81?= =?UTF-8?q?=D1=82=D0=B2=D0=B8=D1=8F=20=D1=81=20=D0=B7=D0=B0=D0=BF=D0=B8?= =?UTF-8?q?=D1=81=D1=8F=D0=BC=D0=B8=20=D0=B2=20=D1=82=D0=B0=D0=B9=D0=BC?= =?UTF-8?q?=D0=BB=D0=B0=D0=B9=D0=BD=D0=B5:=20=D0=BD=D0=BE=D0=B2=D0=B0?= =?UTF-8?q?=D1=8F=20=D1=81=D1=82=D1=80=D1=83=D0=BA=D1=82=D1=83=D1=80=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-reference/crm/timeline/actions/b24-toc.yaml | 9 +++++++++ .../crm/timeline/actions/crm-timeline-item-pin.md | 0 .../timeline/actions/crm-timeline-item-unpin.md | 0 api-reference/crm/timeline/actions/index.md | 15 +++++++++++++++ api-reference/crm/timeline/b24-toc.yaml | 4 ++++ api-reference/crm/timeline/index.md | 8 ++++++++ 6 files changed, 36 insertions(+) create mode 100644 api-reference/crm/timeline/actions/b24-toc.yaml create mode 100644 api-reference/crm/timeline/actions/crm-timeline-item-pin.md create mode 100644 api-reference/crm/timeline/actions/crm-timeline-item-unpin.md create mode 100644 api-reference/crm/timeline/actions/index.md diff --git a/api-reference/crm/timeline/actions/b24-toc.yaml b/api-reference/crm/timeline/actions/b24-toc.yaml new file mode 100644 index 00000000..68be35b3 --- /dev/null +++ b/api-reference/crm/timeline/actions/b24-toc.yaml @@ -0,0 +1,9 @@ +title: Действия с записями в таймлайне +href: index.md +items: + - name: Обзор методов + href: index.md + - name: Закрепить запись + href: crm-timeline-item-pin.md + - name: Открепить запись + href: crm-timeline-item-unpin.md diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md new file mode 100644 index 00000000..e69de29b diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md b/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md new file mode 100644 index 00000000..e69de29b diff --git a/api-reference/crm/timeline/actions/index.md b/api-reference/crm/timeline/actions/index.md new file mode 100644 index 00000000..300618a4 --- /dev/null +++ b/api-reference/crm/timeline/actions/index.md @@ -0,0 +1,15 @@ +# Обзор методов + +> Scope: [`crm`](../../../scopes/permissions.md) +> +> Кто может выполнять метод: `любой пользователь` + +#| +|| **Метод** | **Описание** || +|| [crm.timeline.item.pin](./crm-timeline-item-pin.md) | Закрепляет запись в таймлайне || +|| [crm.timeline.item.unpin](./crm-timeline-item-unpin.md) | Открепляет запись в таймлайне || +|# + +## Дополнительно + +- [Таймлайн в элементе CRM](https://helpdesk.bitrix24.ru/open/16749348/) diff --git a/api-reference/crm/timeline/b24-toc.yaml b/api-reference/crm/timeline/b24-toc.yaml index bce90d58..7b44e3cc 100644 --- a/api-reference/crm/timeline/b24-toc.yaml +++ b/api-reference/crm/timeline/b24-toc.yaml @@ -27,3 +27,7 @@ items: include: path: layout-blocks/b24-toc.yaml mode: link + - name: Действия с записями + include: + path: actions/b24-toc.yaml + mode: link diff --git a/api-reference/crm/timeline/index.md b/api-reference/crm/timeline/index.md index 7889441a..0bb32a5f 100644 --- a/api-reference/crm/timeline/index.md +++ b/api-reference/crm/timeline/index.md @@ -123,3 +123,11 @@ || [crm.timeline.icon.*](./logmessage/icons/index.md) | Управляют иконками записей || || [crm.timeline.logo.*](./logmessage/logo/index.md) | Управляют логотипами записей || |# + +### Действия с записями в таймлайне + +#| +|| **Метод** | **Описание** || +|| [crm.timeline.item.pin](./actions/crm-timeline-item-pin.md) | Закрепляет запись в таймлайне || +|| [crm.timeline.item.unpin](./actions/crm-timeline-item-unpin.md) | Открепляет запись в таймлайне || +|# From 2a769f39a7b6f199a3e60148bdb44263166f97ca Mon Sep 17 00:00:00 2001 From: Andrey Zelenin Date: Wed, 5 Feb 2025 20:30:41 +0300 Subject: [PATCH 2/3] =?UTF-8?q?crm:=20timeline:=20=D0=B4=D0=B5=D0=B9=D1=81?= =?UTF-8?q?=D1=82=D0=B2=D0=B8=D1=8F=20=D1=81=20=D0=B7=D0=B0=D0=BF=D0=B8?= =?UTF-8?q?=D1=81=D1=8F=D0=BC=D0=B8=20=D0=B2=20=D1=82=D0=B0=D0=B9=D0=BC?= =?UTF-8?q?=D0=BB=D0=B0=D0=B9=D0=BD=D0=B5:=20=20crm.timeline.item.pin?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../timeline/actions/crm-timeline-item-pin.md | 130 ++++++++++++++++++ api-reference/crm/timeline/actions/index.md | 2 + 2 files changed, 132 insertions(+) diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md index e69de29b..e850134c 100644 --- a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md +++ b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md @@ -0,0 +1,130 @@ +# Закрепить запись в таймлайне crm.timeline.item.pin + +> Scope: [`crm`](../../../scopes/permissions.md) +> +> Кто может выполнять метод: `любой пользователь` + +Метод закрепляет запись в таймлайне. + +## Параметры метода + +{% include [Сноска об обязательных параметрах](../../../../_includes/required.md) %} + +#| +|| **Название** +`тип` | **Описание** || +|| **id*** +[`integer`](../../../data-types.md) | Целочисленный идентификатор дела (например, `999`) || +|| **ownerTypeId*** +[`integer`](../../data-types.md#object_type) | [Целочисленный идентификатор типа сущности CRM](../../data-types.md#object_type), к которому привязано дело (например, `2` для сделки) || +|| **ownerId*** +[`integer`](../../../data-types.md) | Целочисленный идентификатор элемента CRM, к которому привязано дело (например, `10`) || +|# + +## Примеры кода + +{% include [Сноска о примерах](../../../../_includes/examples.md) %} + +{% list tabs %} + +- cURL (Webhook) + + ```bash + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Accept: application/json" \ + -d '{"id": 999, "ownerTypeId": 2, "ownerId": 10}' \ + https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.bindings.bind + ``` + +- cURL (OAuth) + + ```bash + ``` + +- JS + + ```js + BX24.callMethod( + "crm.timeline.item.pin", + { + id: 999, + ownerTypeId: 2, + ownerId: 10, + }, result => { + if (result.error()) + console.error(result.error()); + else + console.dir(result.data()); + } + ); + ``` + +- PHP + + ```php + ``` + +{% endlist %} + +## Обработка ответа + +HTTP-статус: **200** + +```json +{ + "result": null, + "time": { + "start": 1712132792.910734, + "finish": 1712132793.530359, + "duration": 0.6196250915527344, + "processing": 0.032338857650756836, + "date_start": "2024-04-03T10:26:32+02:00", + "date_finish": "2024-04-03T10:26:33+02:00", + "operating_reset_at": 1705765533, + "operating": 3.3076241016387939 + } +} +``` + +### Возвращаемые данные + +#| +|| **Название** +`тип` | **Описание** || +|| **result** +[`null`](../../../data-types.md) | Результат операции. Всегда возвращает `null` || +|| **time** +[`time`](../../../data-types.md) | Информация о времени выполнения запроса || +|# + +## Обработка ошибок + +HTTP-статус: **400** + +```json +{ + "error": "NOT_FOUND", + "error_description": "Not found." +} +``` + +{% include notitle [обработка ошибок](../../../../_includes/error-info.md) %} + +### Возможные коды ошибок + +#| +|| **Код** | **Описание** || +|| `0` | Только три события можно добавить в избранное || +|| `100` | Не переданы обязательные поля || +|| `ACCESS_DENIED` | Недостаточно прав для выполнения операции || +|| `NOT_FOUND` | Элемент не найден || +|| `OWNER_NOT_FOUND` | Владелец элемента не найден || +|| `CAN_NOT_CHANGE_PINNED` | Невозможно выполнить операцию || +|# + +{% include [системные ошибки](../../../../_includes/system-errors.md) %} + +## Продолжите изучение + +- [{#T}](./crm-timeline-item-unpin.md) diff --git a/api-reference/crm/timeline/actions/index.md b/api-reference/crm/timeline/actions/index.md index 300618a4..af72299e 100644 --- a/api-reference/crm/timeline/actions/index.md +++ b/api-reference/crm/timeline/actions/index.md @@ -4,6 +4,8 @@ > > Кто может выполнять метод: `любой пользователь` +Чтобы важная запись в таймлайне не потерялась, можно закрепить её вверху таймлайна. В таймлайне можно одновременно закрепить не более трех событий. + #| || **Метод** | **Описание** || || [crm.timeline.item.pin](./crm-timeline-item-pin.md) | Закрепляет запись в таймлайне || From 19c9e2c8bcc9c8ce366a8d15f45ca9126debfb7e Mon Sep 17 00:00:00 2001 From: Andrey Zelenin Date: Wed, 5 Feb 2025 20:34:46 +0300 Subject: [PATCH 3/3] =?UTF-8?q?crm:=20timeline:=20=D0=B4=D0=B5=D0=B9=D1=81?= =?UTF-8?q?=D1=82=D0=B2=D0=B8=D1=8F=20=D1=81=20=D0=B7=D0=B0=D0=BF=D0=B8?= =?UTF-8?q?=D1=81=D1=8F=D0=BC=D0=B8=20=D0=B2=20=D1=82=D0=B0=D0=B9=D0=BC?= =?UTF-8?q?=D0=BB=D0=B0=D0=B9=D0=BD=D0=B5:=20=20crm.timeline.item.unpin?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../timeline/actions/crm-timeline-item-pin.md | 2 +- .../actions/crm-timeline-item-unpin.md | 129 ++++++++++++++++++ 2 files changed, 130 insertions(+), 1 deletion(-) diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md index e850134c..73a01b15 100644 --- a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md +++ b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md @@ -34,7 +34,7 @@ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id": 999, "ownerTypeId": 2, "ownerId": 10}' \ - https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.bindings.bind + https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.item.pin ``` - cURL (OAuth) diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md b/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md index e69de29b..66825432 100644 --- a/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md +++ b/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md @@ -0,0 +1,129 @@ +# Открепить запись в таймлайне crm.timeline.item.unpin + +> Scope: [`crm`](../../../scopes/permissions.md) +> +> Кто может выполнять метод: `любой пользователь` + +Метод открепляет запись в таймлайне. + +## Параметры метода + +{% include [Сноска об обязательных параметрах](../../../../_includes/required.md) %} + +#| +|| **Название** +`тип` | **Описание** || +|| **id*** +[`integer`](../../../data-types.md) | Целочисленный идентификатор дела (например, `999`) || +|| **ownerTypeId*** +[`integer`](../../data-types.md#object_type) | [Целочисленный идентификатор типа сущности CRM](../../data-types.md#object_type), к которому привязано дело (например, `2` для сделки) || +|| **ownerId*** +[`integer`](../../../data-types.md) | Целочисленный идентификатор элемента CRM, к которому привязано дело (например, `10`) || +|# + +## Примеры кода + +{% include [Сноска о примерах](../../../../_includes/examples.md) %} + +{% list tabs %} + +- cURL (Webhook) + + ```bash + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Accept: application/json" \ + -d '{"id": 999, "ownerTypeId": 2, "ownerId": 10}' \ + https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.item.unpin + ``` + +- cURL (OAuth) + + ```bash + ``` + +- JS + + ```js + BX24.callMethod( + "crm.timeline.item.unpin", + { + id: 999, + ownerTypeId: 2, + ownerId: 10, + }, result => { + if (result.error()) + console.error(result.error()); + else + console.dir(result.data()); + } + ); + ``` + +- PHP + + ```php + ``` + +{% endlist %} + +## Обработка ответа + +HTTP-статус: **200** + +```json +{ + "result": null, + "time": { + "start": 1712132792.910734, + "finish": 1712132793.530359, + "duration": 0.6196250915527344, + "processing": 0.032338857650756836, + "date_start": "2024-04-03T10:26:32+02:00", + "date_finish": "2024-04-03T10:26:33+02:00", + "operating_reset_at": 1705765533, + "operating": 3.3076241016387939 + } +} +``` + +### Возвращаемые данные + +#| +|| **Название** +`тип` | **Описание** || +|| **result** +[`null`](../../../data-types.md) | Результат операции. Всегда возвращает `null` || +|| **time** +[`time`](../../../data-types.md) | Информация о времени выполнения запроса || +|# + +## Обработка ошибок + +HTTP-статус: **400** + +```json +{ + "error": "NOT_FOUND", + "error_description": "Not found." +} +``` + +{% include notitle [обработка ошибок](../../../../_includes/error-info.md) %} + +### Возможные коды ошибок + +#| +|| **Код** | **Описание** || +|| `100` | Не переданы обязательные поля || +|| `ACCESS_DENIED` | Недостаточно прав для выполнения операции || +|| `NOT_FOUND` | Элемент не найден || +|| `OWNER_NOT_FOUND` | Владелец элемента не найден || +|| `CAN_NOT_CHANGE_PINNED` | Невозможно выполнить операцию || +|# + +{% include [системные ошибки](../../../../_includes/system-errors.md) %} + +## Продолжите изучение + +- [{#T}](./crm-timeline-item-pin.md)