From 27cc9e3d024ea7d79c7204814af18ab7e02419d2 Mon Sep 17 00:00:00 2001 From: Vitaly the Alpaca Date: Tue, 13 Aug 2024 10:24:12 +0000 Subject: [PATCH] =?UTF-8?q?=D0=A1=D0=BE=D0=B7=D0=B4=D0=B0=D0=BD=D0=B8?= =?UTF-8?q?=D0=B5=20MD=20=D1=84=D0=B0=D0=B9=D0=BB=D0=BE=D0=B2=20=D0=B4?= =?UTF-8?q?=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8?= =?UTF-8?q?=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Catalogs-managment/Create-subfolder.md | 166 +-- .../Catalogs-managment/Delete-folder.md | 128 +- .../Get-folder-external-link.md | 126 +- .../Get-folder-filter-structure.md | 122 +- .../Get-folder-information.md | 158 +-- .../Catalogs-managment/Get-folder-items.md | 200 +-- .../Catalogs-managment/Make-folder-copy.md | 174 +-- .../Mark-folder-as-deleted.md | 158 +-- .../Catalogs-managment/Move-folder.md | 172 +-- .../Catalogs-managment/Rename-folder.md | 168 +-- .../Catalogs-managment/Restore-folder.md | 158 +-- .../Add-users-to-chat.md | 142 +-- .../Change-chat-color.md | 142 +-- .../Change-chat-owner.md | 134 +- .../Change-chat-picture.md | 134 +- .../Change-chat-title.md | 138 +- .../Create-chat.md | 172 +-- .../Delete-user-from-chat.md | 134 +- .../Disable-chat-notifications.md | 128 +- .../Enable-chat-notifications.md | 128 +- .../Get-chat-files-folder.md | 132 +- .../Get-chat-members-list.md | 240 ++-- .../Get-chat-messages-list.md | 798 ++++++------ .../Get-chat-structure.md | 66 +- .../Get-chat-users.md | 134 +- .../Chats-and-dialogs-managment/Get-dialog.md | 266 ++-- .../Get-user-status.md | 104 +- .../Chats-and-dialogs-managment/Get-users.md | 188 +-- .../Chats-and-dialogs-managment/Leave-chat.md | 128 +- .../Chats-and-dialogs-managment/Read-all.md | 122 +- .../Send-writing-notification.md | 128 +- .../Set-user-status.md | 128 +- .../Add-task-comment.md | 136 +- .../Create-result-from-comment.md | 150 +-- .../Delete-result-from-comment.md | 128 +- .../Delete-task-comment.md | 132 +- .../Get-comment-structure.md | 66 +- .../Get-results-list.md | 176 +-- .../Get-task-comment.md | 148 +-- .../Get-task-comments-list.md | 164 +-- .../Update-task-comment.md | 142 +-- .../Add-custom-task-field.md | 150 +-- .../Delete-custom-task-field.md | 128 +- .../Get-custom-task-field.md | 372 +++--- .../Get-custom-task-fields-list.md | 314 ++--- .../Update-custom-task-field.md | 144 +-- .../Create-department.md | 142 +-- .../Delete-department.md | 128 +- .../Departments-managment/Get-departments.md | 152 +-- .../Update-department.md | 156 +-- .../Feed-posts-managment/Add-post-comment.md | 132 +- .../md/Bitrix24/File-managment/Delete-file.md | 128 +- .../File-managment/Get-file-external-link.md | 126 +- .../File-managment/Get-file-information.md | 164 +-- .../Bitrix24/File-managment/Make-file-copy.md | 178 +-- .../File-managment/Mark-file-as-deleted.md | 164 +-- .../File-managment/Move-file-to-folder.md | 178 +-- .../md/Bitrix24/File-managment/Rename-file.md | 174 +-- .../Bitrix24/File-managment/Restore-file.md | 164 +-- .../File-managment/Upload-file-to-folder.md | 162 +-- .../File-managment/Upload-file-to-storage.md | 184 +-- .../en/md/Bitrix24/Kanban/Add-kanban-stage.md | 148 +-- .../md/Bitrix24/Kanban/Delete-kanban-stage.md | 134 +- .../md/Bitrix24/Kanban/Get-kanban-stages.md | 1112 ++++++++--------- .../Kanban/Move-task-to-kanban-stage.md | 140 +-- .../Bitrix24/Kanban/Update-kanbans-stage.md | 148 +-- .../Message-management/Delete-message.md | 128 +- .../Message-management/Edit-message.md | 150 +-- .../Message-management/Get-file-block.md | 74 +- .../Message-management/Get-picture-block.md | 74 +- .../Mark-message-as-readed.md | 144 +-- .../Mark-message-as-unreaded.md | 134 +- .../Bitrix24/Message-management/Send-file.md | 286 ++--- .../Message-management/Send-message.md | 146 +-- .../Set-message-reaction.md | 128 +- .../Create-personal-notification.md | 152 +-- .../Create-system-notification.md | 152 +-- .../Delete-notification.md | 128 +- .../Create-storage-folder.md | 166 +-- .../Storages-managment/Get-app-sotrage.md | 130 +- .../Storages-managment/Get-storage-objects.md | 210 ++-- .../Storages-managment/Get-storage.md | 142 +-- .../Storages-managment/Get-storages-list.md | 250 ++-- .../Storages-managment/Rename-storage.md | 138 +- .../Add-tasks-checklist-element.md | 136 +- .../Complete-tasks-checklist-element.md | 136 +- .../Delete-tasks-checklist-element.md | 136 +- .../Get-tasks-checklist-element.md | 162 +-- .../Get-tasks-checklist.md | 186 +-- .../Renew-tasks-checklist-element.md | 136 +- .../Update-tasks-checklist-element.md | 140 +-- .../Tasks-managment/Attach-file-to-topic.md | 136 +- .../Tasks-managment/Check-task-accesses.md | 256 ++-- .../Create-tasks-dependencies.md | 144 +-- .../Delete-tasks-dependencies.md | 108 +- .../Tasks-managment/Get-daily-plan.md | 122 +- .../md/Bitrix24/Tasks-managment/Mute-task.md | 388 +++--- .../Bitrix24/Tasks-managment/Unmute-task.md | 388 +++--- .../Timekeeping/Add-task-time-accounting.md | 160 +-- .../Delete-task-time-accounting.md | 132 +- .../Get-task-time-accounting-list.md | 178 +-- .../Timekeeping/Get-task-time-accounting.md | 154 +-- .../Timekeeping/Get-timekeeping-settings.md | 146 +-- .../Timekeeping/Get-timekeeping-status.md | 158 +-- .../Bitrix24/Timekeeping/Pause-timekeeping.md | 158 +-- .../Bitrix24/Timekeeping/Start-timekeeping.md | 166 +-- .../Bitrix24/Timekeeping/Stop-timekeeping.md | 116 +- .../Update-task-time-accounting.md | 164 +-- .../Users-managment/Change-user-status.md | 124 +- .../Bitrix24/Users-managment/Create-user.md | 160 +-- .../md/Bitrix24/Users-managment/Find-users.md | 554 ++++---- .../Users-managment/Get-current-user.md | 164 +-- .../Get-user-fields-structure.md | 252 ++-- .../Get-user-filter-structure.md | 66 +- .../md/Bitrix24/Users-managment/Get-user.md | 172 +-- .../Bitrix24/Users-managment/Update-user.md | 158 +-- docs/en/md/Instructions/VKTeams.md | 94 +- .../Pause-advertising.md | 102 +- .../Add-product-to-collection.md | 94 +- .../Chat-management/Remove-chat-members.md | 38 + .../VKTeams/Chat-management/_category_.json | 4 + .../md/VKTeams/Common-methods/Check-token.md | 85 +- .../md/VKTeams/Common-methods/Get-events.md | 117 +- .../Common-methods/Get-file-information.md | 94 +- .../VKTeams/Message-sending/Delete-message.md | 90 +- .../Message-sending/Edit-message-text.md | 114 +- .../Message-sending/Forward-message.md | 113 +- .../md/VKTeams/Message-sending/Resend-file.md | 104 +- .../VKTeams/Message-sending/Resend-voice.md | 83 +- .../md/VKTeams/Message-sending/Send-file.md | 124 +- .../Message-sending/Send-text-message.md | 119 +- .../md/VKTeams/Message-sending/Send-voice.md | 124 +- docs/en/md/sidebars.js | 138 +- .../VKTeams/ИсключитьПользователейЧата.txt | 1 + .../Catalogs-managment/Create-subfolder.md | 166 +-- .../Catalogs-managment/Delete-folder.md | 128 +- .../Get-folder-external-link.md | 126 +- .../Get-folder-filter-structure.md | 122 +- .../Get-folder-information.md | 158 +-- .../Catalogs-managment/Get-folder-items.md | 200 +-- .../Catalogs-managment/Make-folder-copy.md | 174 +-- .../Mark-folder-as-deleted.md | 158 +-- .../Catalogs-managment/Move-folder.md | 172 +-- .../Catalogs-managment/Rename-folder.md | 168 +-- .../Catalogs-managment/Restore-folder.md | 158 +-- .../Add-users-to-chat.md | 142 +-- .../Change-chat-color.md | 142 +-- .../Change-chat-owner.md | 134 +- .../Change-chat-picture.md | 134 +- .../Change-chat-title.md | 138 +- .../Create-chat.md | 172 +-- .../Delete-user-from-chat.md | 134 +- .../Disable-chat-notifications.md | 128 +- .../Enable-chat-notifications.md | 128 +- .../Get-chat-files-folder.md | 132 +- .../Get-chat-members-list.md | 240 ++-- .../Get-chat-messages-list.md | 798 ++++++------ .../Get-chat-structure.md | 66 +- .../Get-chat-users.md | 134 +- .../Chats-and-dialogs-managment/Get-dialog.md | 266 ++-- .../Get-user-status.md | 104 +- .../Chats-and-dialogs-managment/Get-users.md | 188 +-- .../Chats-and-dialogs-managment/Leave-chat.md | 128 +- .../Chats-and-dialogs-managment/Read-all.md | 122 +- .../Send-writing-notification.md | 128 +- .../Set-user-status.md | 128 +- .../Add-task-comment.md | 136 +- .../Create-result-from-comment.md | 150 +-- .../Delete-result-from-comment.md | 128 +- .../Delete-task-comment.md | 132 +- .../Get-comment-structure.md | 66 +- .../Get-results-list.md | 176 +-- .../Get-task-comment.md | 148 +-- .../Get-task-comments-list.md | 164 +-- .../Update-task-comment.md | 142 +-- .../Add-custom-task-field.md | 150 +-- .../Delete-custom-task-field.md | 128 +- .../Get-custom-task-field.md | 372 +++--- .../Get-custom-task-fields-list.md | 314 ++--- .../Update-custom-task-field.md | 144 +-- .../Create-department.md | 142 +-- .../Delete-department.md | 128 +- .../Departments-managment/Get-departments.md | 152 +-- .../Update-department.md | 156 +-- .../Feed-posts-managment/Add-post-comment.md | 132 +- .../md/Bitrix24/File-managment/Delete-file.md | 128 +- .../File-managment/Get-file-external-link.md | 126 +- .../File-managment/Get-file-information.md | 164 +-- .../Bitrix24/File-managment/Make-file-copy.md | 178 +-- .../File-managment/Mark-file-as-deleted.md | 164 +-- .../File-managment/Move-file-to-folder.md | 178 +-- .../md/Bitrix24/File-managment/Rename-file.md | 174 +-- .../Bitrix24/File-managment/Restore-file.md | 164 +-- .../File-managment/Upload-file-to-folder.md | 162 +-- .../File-managment/Upload-file-to-storage.md | 184 +-- .../ru/md/Bitrix24/Kanban/Add-kanban-stage.md | 148 +-- .../md/Bitrix24/Kanban/Delete-kanban-stage.md | 134 +- .../md/Bitrix24/Kanban/Get-kanban-stages.md | 1112 ++++++++--------- .../Kanban/Move-task-to-kanban-stage.md | 140 +-- .../Bitrix24/Kanban/Update-kanbans-stage.md | 148 +-- .../Message-management/Delete-message.md | 128 +- .../Message-management/Edit-message.md | 150 +-- .../Message-management/Get-file-block.md | 74 +- .../Message-management/Get-picture-block.md | 74 +- .../Mark-message-as-readed.md | 144 +-- .../Mark-message-as-unreaded.md | 134 +- .../Bitrix24/Message-management/Send-file.md | 286 ++--- .../Message-management/Send-message.md | 146 +-- .../Set-message-reaction.md | 128 +- .../Create-personal-notification.md | 152 +-- .../Create-system-notification.md | 152 +-- .../Delete-notification.md | 128 +- .../Create-storage-folder.md | 166 +-- .../Storages-managment/Get-app-sotrage.md | 130 +- .../Storages-managment/Get-storage-objects.md | 210 ++-- .../Storages-managment/Get-storage.md | 142 +-- .../Storages-managment/Get-storages-list.md | 250 ++-- .../Storages-managment/Rename-storage.md | 138 +- .../Add-tasks-checklist-element.md | 136 +- .../Complete-tasks-checklist-element.md | 136 +- .../Delete-tasks-checklist-element.md | 136 +- .../Get-tasks-checklist-element.md | 162 +-- .../Get-tasks-checklist.md | 186 +-- .../Renew-tasks-checklist-element.md | 136 +- .../Update-tasks-checklist-element.md | 140 +-- .../Tasks-managment/Attach-file-to-topic.md | 136 +- .../Tasks-managment/Check-task-accesses.md | 256 ++-- .../Create-tasks-dependencies.md | 144 +-- .../Delete-tasks-dependencies.md | 108 +- .../Tasks-managment/Get-daily-plan.md | 122 +- .../md/Bitrix24/Tasks-managment/Mute-task.md | 388 +++--- .../Bitrix24/Tasks-managment/Unmute-task.md | 388 +++--- .../Timekeeping/Add-task-time-accounting.md | 160 +-- .../Delete-task-time-accounting.md | 132 +- .../Get-task-time-accounting-list.md | 178 +-- .../Timekeeping/Get-task-time-accounting.md | 154 +-- .../Timekeeping/Get-timekeeping-settings.md | 146 +-- .../Timekeeping/Get-timekeeping-status.md | 158 +-- .../Bitrix24/Timekeeping/Pause-timekeeping.md | 158 +-- .../Bitrix24/Timekeeping/Start-timekeeping.md | 166 +-- .../Bitrix24/Timekeeping/Stop-timekeeping.md | 116 +- .../Update-task-time-accounting.md | 164 +-- .../Users-managment/Change-user-status.md | 124 +- .../Bitrix24/Users-managment/Create-user.md | 160 +-- .../md/Bitrix24/Users-managment/Find-users.md | 554 ++++---- .../Users-managment/Get-current-user.md | 164 +-- .../Get-user-fields-structure.md | 252 ++-- .../Get-user-filter-structure.md | 66 +- .../md/Bitrix24/Users-managment/Get-user.md | 172 +-- .../Bitrix24/Users-managment/Update-user.md | 158 +-- .../Pause-advertising.md | 102 +- .../Add-product-to-collection.md | 94 +- .../Chat-management/Remove-chat-members.md | 38 + .../VKTeams/Chat-management/_category_.json | 4 + .../md/VKTeams/Common-methods/Check-token.md | 85 +- .../md/VKTeams/Common-methods/Get-events.md | 117 +- .../Common-methods/Get-file-information.md | 94 +- .../VKTeams/Message-sending/Delete-message.md | 90 +- .../Message-sending/Edit-message-text.md | 114 +- .../Message-sending/Forward-message.md | 113 +- .../md/VKTeams/Message-sending/Resend-file.md | 104 +- .../VKTeams/Message-sending/Resend-voice.md | 83 +- .../md/VKTeams/Message-sending/Send-file.md | 124 +- .../Message-sending/Send-text-message.md | 119 +- .../md/VKTeams/Message-sending/Send-voice.md | 124 +- service/tests_set.json | 675 +++++----- 266 files changed, 22116 insertions(+), 22138 deletions(-) create mode 100644 docs/en/md/VKTeams/Chat-management/Remove-chat-members.md create mode 100644 docs/en/md/VKTeams/Chat-management/_category_.json create mode 100644 docs/ru/cli/VKTeams/ИсключитьПользователейЧата.txt create mode 100644 docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md create mode 100644 docs/ru/md/VKTeams/Chat-management/_category_.json diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md index 5031544a44..e51e426cea 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 2 ---- - -# Create new subfolder - Create new folder inside another folder - - - -`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Parent folder identifier | - | Name | --title | String | Name of new folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) -::: -
- - -```bsl title="Code example" - FolderID = "5016"; - Name = "New subfolder"; - Filename2 = "New subfolder 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateSubfolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 850, - "NAME": "New subfolder", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 850, - "PARENT_ID": "846", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-06-27T07:19:57+00:00", - "UPDATE_TIME": "2024-06-27T07:19:57+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" - }, - "time": { - "start": 1719472797.42827, - "finish": 1719472797.50854, - "duration": 0.080265998840332, - "processing": 0.0455958843231201, - "date_start": "2024-06-27T07:19:57+00:00", - "date_finish": "2024-06-27T07:19:57+00:00", - "operating_reset_at": 1719473397, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Create new subfolder + Create new folder inside another folder + + + +`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Parent folder identifier | + | Name | --title | String | Name of new folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
+ + +```bsl title="Code example" + FolderID = "5016"; + Name = "New subfolder"; + Filename2 = "New subfolder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateSubfolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 850, + "NAME": "New subfolder", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 850, + "PARENT_ID": "846", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-27T07:19:57+00:00", + "UPDATE_TIME": "2024-06-27T07:19:57+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" + }, + "time": { + "start": 1719472797.42827, + "finish": 1719472797.50854, + "duration": 0.080265998840332, + "processing": 0.0455958843231201, + "date_start": "2024-06-27T07:19:57+00:00", + "date_finish": "2024-06-27T07:19:57+00:00", + "operating_reset_at": 1719473397, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md index ae06d9aaa3..b98cdb9258 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 5 ---- - -# Delete folder - Remove folder with subfolders - - - -`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | ID of folder to be deleted | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5014"; - - Result = OPI_Bitrix24.DeleteFolder(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - FolderID = "5016"; - - Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1719047257.50616, - "finish": 1719047257.55445, - "duration": 0.048285961151123, - "processing": 0.0174880027770996, - "date_start": "2024-06-22T09:07:37+00:00", - "date_finish": "2024-06-22T09:07:37+00:00", - "operating_reset_at": 1719047857, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Delete folder + Remove folder with subfolders + + + +`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | ID of folder to be deleted | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5014"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + FolderID = "5016"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1719047257.50616, + "finish": 1719047257.55445, + "duration": 0.048285961151123, + "processing": 0.0174880027770996, + "date_start": "2024-06-22T09:07:37+00:00", + "date_finish": "2024-06-22T09:07:37+00:00", + "operating_reset_at": 1719047857, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md index 3ab7b5e819..5170c0868a 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 6 ---- - -# Get external link for folder - Get external link to folder - - - -`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5016"; - - Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFolderExternalLink --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": "https://b24-ar17wx.bitrix24.by/~hWalI", - "time": { - "start": 1719472796.12325, - "finish": 1719472796.16843, - "duration": 0.0451798439025879, - "processing": 0.0110611915588379, - "date_start": "2024-06-27T07:19:56+00:00", - "date_finish": "2024-06-27T07:19:56+00:00", - "operating_reset_at": 1719473396, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Get external link for folder + Get external link to folder + + + +`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5016"; + + Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFolderExternalLink --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": "https://b24-ar17wx.bitrix24.by/~hWalI", + "time": { + "start": 1719472796.12325, + "finish": 1719472796.16843, + "duration": 0.0451798439025879, + "processing": 0.0110611915588379, + "date_start": "2024-06-27T07:19:56+00:00", + "date_finish": "2024-06-27T07:19:56+00:00", + "operating_reset_at": 1719473396, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md index 53041d9e57..e99071618c 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 11 ---- - -# Get fields structure for folder items filter - Returns filter structure for child folder items - - - -`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Structure of KeyAndValue - Fields structure - -
- -:::tip -Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetFolderFilterStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFolderFilterStructure --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "ID": "", - "NAME": "", - "TYPE": "", - "CODE": "", - "STORAGE_ID": "", - "PARENT_ID": "", - "CREATE_TIME": "", - "UPDATE_TIME": "", - "DELETE_TIME": "", - "DELETED_TYPE": "" -} -``` +--- +sidebar_position: 11 +--- + +# Get fields structure for folder items filter + Returns filter structure for child folder items + + + +`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ +:::tip +Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetFolderFilterStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFolderFilterStructure --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "ID": "", + "NAME": "", + "TYPE": "", + "CODE": "", + "STORAGE_ID": "", + "PARENT_ID": "", + "CREATE_TIME": "", + "UPDATE_TIME": "", + "DELETE_TIME": "", + "DELETED_TYPE": "" +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md index cd16957b9c..d3e9c829fa 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 1 ---- - -# Get information about folder - Get folder information - - - -`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5016"; - - Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFolderInformation --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1722", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "1722", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-03T14:42:37+00:00", - "UPDATE_TIME": "2024-07-03T14:42:37+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1720017760.63451, - "finish": 1720017760.68628, - "duration": 0.0517730712890625, - "processing": 0.0117180347442627, - "date_start": "2024-07-03T14:42:40+00:00", - "date_finish": "2024-07-03T14:42:40+00:00", - "operating_reset_at": 1720018360, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Get information about folder + Get folder information + + + +`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5016"; + + Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFolderInformation --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1722", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "1722", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-03T14:42:37+00:00", + "UPDATE_TIME": "2024-07-03T14:42:37+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1720017760.63451, + "finish": 1720017760.68628, + "duration": 0.0517730712890625, + "processing": 0.0117180347442627, + "date_start": "2024-07-03T14:42:40+00:00", + "date_finish": "2024-07-03T14:42:40+00:00", + "operating_reset_at": 1720018360, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md index 658934b7c1..6c09bf32c2 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md @@ -1,100 +1,100 @@ ---- -sidebar_position: 7 ---- - -# Get folder child elements - Get folder child elements - - - -`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5016"; - - Result = OPI_Bitrix24.GetFolderItems(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFolderItems(URL, FolderID,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFolderItems --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "848", - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "848", - "PARENT_ID": "846", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-06-27T07:19:56+00:00", - "UPDATE_TIME": "2024-06-27T07:19:58+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2" - }, - { - "ID": "850", - "NAME": "New subfolder", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "850", - "PARENT_ID": "846", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-06-27T07:19:57+00:00", - "UPDATE_TIME": "2024-06-27T07:19:58+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" - } - ], - "total": 2, - "time": { - "start": 1719472801.3139, - "finish": 1719472801.36215, - "duration": 0.0482509136199951, - "processing": 0.0148689746856689, - "date_start": "2024-06-27T07:20:01+00:00", - "date_finish": "2024-06-27T07:20:01+00:00", - "operating_reset_at": 1719473401, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Get folder child elements + Get folder child elements + + + +`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5016"; + + Result = OPI_Bitrix24.GetFolderItems(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFolderItems(URL, FolderID,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFolderItems --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "848", + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "848", + "PARENT_ID": "846", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-06-27T07:19:56+00:00", + "UPDATE_TIME": "2024-06-27T07:19:58+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2" + }, + { + "ID": "850", + "NAME": "New subfolder", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "850", + "PARENT_ID": "846", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-06-27T07:19:57+00:00", + "UPDATE_TIME": "2024-06-27T07:19:58+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder" + } + ], + "total": 2, + "time": { + "start": 1719472801.3139, + "finish": 1719472801.36215, + "duration": 0.0482509136199951, + "processing": 0.0148689746856689, + "date_start": "2024-06-27T07:20:01+00:00", + "date_finish": "2024-06-27T07:20:01+00:00", + "operating_reset_at": 1719473401, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md index 730665b4a0..69414085b2 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Copy folder - Copy one folder to another - - - -`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | DestinationID | --tagetid | String, Number | ID of target folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) -::: -
- - -```bsl title="Code example" - DestinationID = "5018"; - FolderID = "5020"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID); - - DestinationID = "5020"; - FolderID = "5018"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token); - - Check_BitrixObject(Result); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MakeFolderCopy --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 1732, - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 1732, - "PARENT_ID": "1726", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-07-03T14:42:46+00:00", - "UPDATE_TIME": "2024-07-03T14:42:46+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2" - }, - "time": { - "start": 1720017765.97028, - "finish": 1720017766.08005, - "duration": 0.109767913818359, - "processing": 0.0799601078033447, - "date_start": "2024-07-03T14:42:45+00:00", - "date_finish": "2024-07-03T14:42:46+00:00", - "operating_reset_at": 1720018366, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Copy folder + Copy one folder to another + + + +`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "5018"; + FolderID = "5020"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID); + + DestinationID = "5020"; + FolderID = "5018"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token); + + Check_BitrixObject(Result); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MakeFolderCopy --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 1732, + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 1732, + "PARENT_ID": "1726", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-07-03T14:42:46+00:00", + "UPDATE_TIME": "2024-07-03T14:42:46+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2" + }, + "time": { + "start": 1720017765.97028, + "finish": 1720017766.08005, + "duration": 0.109767913818359, + "processing": 0.0799601078033447, + "date_start": "2024-07-03T14:42:45+00:00", + "date_finish": "2024-07-03T14:42:46+00:00", + "operating_reset_at": 1720018366, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md index 745698c207..6d9c91dab6 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 8 ---- - -# Mark folder as deleted - Move folder to recycle bin - - - -`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5016"; - - Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MarkFolderAsDeleted --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "936", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:06+00:00", - "DELETE_TIME": "2024-07-01T13:44:12+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1719841453.13782, - "finish": 1719841453.17717, - "duration": 0.0393478870391846, - "processing": 0.00959300994873047, - "date_start": "2024-07-01T13:44:13+00:00", - "date_finish": "2024-07-01T13:44:13+00:00", - "operating_reset_at": 1719842053, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Mark folder as deleted + Move folder to recycle bin + + + +`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5016"; + + Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkFolderAsDeleted --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "936", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:06+00:00", + "DELETE_TIME": "2024-07-01T13:44:12+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1719841453.13782, + "finish": 1719841453.17717, + "duration": 0.0393478870391846, + "processing": 0.00959300994873047, + "date_start": "2024-07-01T13:44:13+00:00", + "date_finish": "2024-07-01T13:44:13+00:00", + "operating_reset_at": 1719842053, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md index 8e744e9c67..d6d1371eab 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 4 ---- - -# Move folder - Moves one folder inside another - - - -`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | DestinationID | --tagetid | String, Number | ID of target folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) -::: -
- - -```bsl title="Code example" - DestinationID = "5014"; - FolderID = "5020"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID); - - FolderID = "5018"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token); - - Check_BitrixObject(Result); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MoveFolder --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "938", - "NAME": "New subfolder 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "938", - "PARENT_ID": 934, - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:06+00:00", - "UPDATE_TIME": "2024-07-01T13:44:07+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2" - }, - "time": { - "start": 1719841451.89089, - "finish": 1719841451.95846, - "duration": 0.0675740242004394, - "processing": 0.0360250473022461, - "date_start": "2024-07-01T13:44:11+00:00", - "date_finish": "2024-07-01T13:44:11+00:00", - "operating_reset_at": 1719842051, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Move folder + Moves one folder inside another + + + +`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "5014"; + FolderID = "5020"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID); + + FolderID = "5018"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token); + + Check_BitrixObject(Result); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MoveFolder --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "938", + "NAME": "New subfolder 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "938", + "PARENT_ID": 934, + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:06+00:00", + "UPDATE_TIME": "2024-07-01T13:44:07+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2" + }, + "time": { + "start": 1719841451.89089, + "finish": 1719841451.95846, + "duration": 0.0675740242004394, + "processing": 0.0360250473022461, + "date_start": "2024-07-01T13:44:11+00:00", + "date_finish": "2024-07-01T13:44:11+00:00", + "operating_reset_at": 1719842051, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md index 8da7a4348b..58969b531f 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 10 ---- - -# Rename folder - Change folder name - - - -`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Name | --title | String | New folders name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New catalog"; - Filename2 = "New folder 2"; - - FolderID2 = "5014"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2); - - FolderID = "5016"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RenameFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "936", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:01+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1719841443.11172, - "finish": 1719841443.16013, - "duration": 0.0484049320220947, - "processing": 0.0123419761657715, - "date_start": "2024-07-01T13:44:03+00:00", - "date_finish": "2024-07-01T13:44:03+00:00", - "operating_reset_at": 1719842043, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Rename folder + Change folder name + + + +`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New catalog"; + Filename2 = "New folder 2"; + + FolderID2 = "5014"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2); + + FolderID = "5016"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenameFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "936", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:01+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1719841443.11172, + "finish": 1719841443.16013, + "duration": 0.0484049320220947, + "processing": 0.0123419761657715, + "date_start": "2024-07-01T13:44:03+00:00", + "date_finish": "2024-07-01T13:44:03+00:00", + "operating_reset_at": 1719842043, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md index 543503d396..7313c055e7 100644 --- a/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md +++ b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 9 ---- - -# Restore folder - Resotre folder form recycle bin - - - -`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FolderID | --folderid | String, Number | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FolderID = "5016"; - - Result = OPI_Bitrix24.RestoreFolder(URL, FolderID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RestoreFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "936", - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:13+00:00", - "DELETE_TIME": "2024-07-01T13:44:12+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1719841454.36238, - "finish": 1719841454.40451, - "duration": 0.0421350002288818, - "processing": 0.00979709625244141, - "date_start": "2024-07-01T13:44:14+00:00", - "date_finish": "2024-07-01T13:44:14+00:00", - "operating_reset_at": 1719842054, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Restore folder + Resotre folder form recycle bin + + + +`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FolderID = "5016"; + + Result = OPI_Bitrix24.RestoreFolder(URL, FolderID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RestoreFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "936", + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:13+00:00", + "DELETE_TIME": "2024-07-01T13:44:12+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1719841454.36238, + "finish": 1719841454.40451, + "duration": 0.0421350002288818, + "processing": 0.00979709625244141, + "date_start": "2024-07-01T13:44:14+00:00", + "date_finish": "2024-07-01T13:44:14+00:00", + "operating_reset_at": 1719842054, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md index ff0a0ba0a3..b85e8311ef 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 5 ---- - -# Add users to chat - Adds users to the chat by ID array - - - -`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserIDs | --users | Array of string, number | New members IDs | - | HideHistory | --hide | Boolean | Hide old messages from new members | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - UserIDs = New Array; - UserIDs.Add(10); - UserIDs.Add(12); - - Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - UserID = 10; - - Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddUsersToChat --url %url% --chat %chat% --users %users% --hide %hide% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865686.43672, - "finish": 1720865686.52541, - "duration": 0.0886859893798828, - "processing": 0.0491659641265869, - "date_start": "2024-07-13T10:14:46+00:00", - "date_finish": "2024-07-13T10:14:46+00:00", - "operating_reset_at": 1720866286, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Add users to chat + Adds users to the chat by ID array + + + +`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserIDs | --users | Array of string, number | New members IDs | + | HideHistory | --hide | Boolean | Hide old messages from new members | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + UserIDs = New Array; + UserIDs.Add(10); + UserIDs.Add(12); + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + UserID = 10; + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddUsersToChat --url %url% --chat %chat% --users %users% --hide %hide% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865686.43672, + "finish": 1720865686.52541, + "duration": 0.0886859893798828, + "processing": 0.0491659641265869, + "date_start": "2024-07-13T10:14:46+00:00", + "date_finish": "2024-07-13T10:14:46+00:00", + "operating_reset_at": 1720866286, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md index 668fe46fee..2fb39f6f8d 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 8 ---- - -# Change chat color - Chat chat color for mobile app - - - -`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Color | --color | String | New chat color | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) - - Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Color = "AZURE"; - - Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Color = "PURPLE"; - - Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ChangeChatColor --url %url% --chat %chat% --color %color% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865688.95778, - "finish": 1720865689.02493, - "duration": 0.0671589374542236, - "processing": 0.0428512096405029, - "date_start": "2024-07-13T10:14:48+00:00", - "date_finish": "2024-07-13T10:14:49+00:00", - "operating_reset_at": 1720866288, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Change chat color + Chat chat color for mobile app + + + +`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Color | --color | String | New chat color | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Color = "AZURE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Color = "PURPLE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatColor --url %url% --chat %chat% --color %color% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865688.95778, + "finish": 1720865689.02493, + "duration": 0.0671589374542236, + "processing": 0.0428512096405029, + "date_start": "2024-07-13T10:14:48+00:00", + "date_finish": "2024-07-13T10:14:49+00:00", + "operating_reset_at": 1720866288, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md index d0cbe2e8e1..1849817115 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 10 ---- - -# Change chat owner - Change chat owner - - - -`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserID | --user | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - UserID = 10; - - Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ChangeChatOwner --url %url% --chat %chat% --user %user% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865697.10595, - "finish": 1720865697.13924, - "duration": 0.0332820415496826, - "processing": 0.0104668140411377, - "date_start": "2024-07-13T10:14:57+00:00", - "date_finish": "2024-07-13T10:14:57+00:00", - "operating_reset_at": 1720866297, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Change chat owner + Change chat owner + + + +`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + UserID = 10; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatOwner --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865697.10595, + "finish": 1720865697.13924, + "duration": 0.0332820415496826, + "processing": 0.0104668140411377, + "date_start": "2024-07-13T10:14:57+00:00", + "date_finish": "2024-07-13T10:14:57+00:00", + "operating_reset_at": 1720866297, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md index 787b6fb050..e96cb970e1 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 9 ---- - -# Change chat picture - Setup new chat picture - - - -`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Image | --picture | String, BinaryData | Picture data | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Image = "https://openintegrations.dev/test_data/picture2.jpg"; - - Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ChangeChatPicture --url %url% --chat %chat% --picture %picture% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865692.90718, - "finish": 1720865693.81896, - "duration": 0.91178297996521, - "processing": 0.884725093841553, - "date_start": "2024-07-13T10:14:52+00:00", - "date_finish": "2024-07-13T10:14:53+00:00", - "operating_reset_at": 1720866292, - "operating": 0.884703874588013 - } -} -``` +--- +sidebar_position: 9 +--- + +# Change chat picture + Setup new chat picture + + + +`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Image | --picture | String, BinaryData | Picture data | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Image = "https://openintegrations.dev/test_data/picture2.jpg"; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatPicture --url %url% --chat %chat% --picture %picture% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865692.90718, + "finish": 1720865693.81896, + "duration": 0.91178297996521, + "processing": 0.884725093841553, + "date_start": "2024-07-13T10:14:52+00:00", + "date_finish": "2024-07-13T10:14:53+00:00", + "operating_reset_at": 1720866292, + "operating": 0.884703874588013 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md index 794c390c71..1e548fc436 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 7 ---- - -# Change chat title - Change text of chat title - - - -`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Title | --title | String | New title | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Title = "New chat title"; - - Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Title = "Another title"; - - Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ChangeChatTitle --url %url% --chat %chat% --title %title% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865687.70928, - "finish": 1720865687.78107, - "duration": 0.0717928409576416, - "processing": 0.0479631423950195, - "date_start": "2024-07-13T10:14:47+00:00", - "date_finish": "2024-07-13T10:14:47+00:00", - "operating_reset_at": 1720866287, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Change chat title + Change text of chat title + + + +`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Title | --title | String | New title | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Title = "New chat title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Title = "Another title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatTitle --url %url% --chat %chat% --title %title% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865687.70928, + "finish": 1720865687.78107, + "duration": 0.0717928409576416, + "processing": 0.0479631423950195, + "date_start": "2024-07-13T10:14:47+00:00", + "date_finish": "2024-07-13T10:14:47+00:00", + "operating_reset_at": 1720866287, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md index 455933a24c..02a53ca449 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 1 ---- - -# Create chat - Creates a new chat based on the field structure - - - -`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) -::: -
- - -```bsl title="Code example" - Image = "https://openintegrations.dev/test_data/picture.jpg"; - OPI_TypeConversion.GetBinaryData(Image); - - B64Image = GetBase64StringFromBinaryData(Image); - - MembersArray = New Array; - MembersArray.Add(10); - MembersArray.Add(1); - - ChatStructure = New Structure; - ChatStructure.Insert("TYPE", "OPEN"); - ChatStructure.Insert("TITLE", "New chat"); - ChatStructure.Insert("DESCRIPTION", "This is a new chat"); - ChatStructure.Insert("COLOR", "GREEN"); - ChatStructure.Insert("MESSAGE", "Welcome to new chat"); - ChatStructure.Insert("USERS", MembersArray); - ChatStructure.Insert("AVATAR", B64Image); - ChatStructure.Insert("OWNER_ID", 1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.CreateChat(URL, ChatStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - ChatStructure = New Structure; - ChatStructure.Insert("TYPE", "CHAT"); - ChatStructure.Insert("TITLE", "Private chat"); - ChatStructure.Insert("USERS", MembersArray); - - Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateChat --url %url% --fields %fields% --token %token% - -``` - -```json title="Result" -{ - "result": 26, - "time": { - "start": 1720816597.42171, - "finish": 1720816597.52933, - "duration": 0.107618093490601, - "processing": 0.081672191619873, - "date_start": "2024-07-12T20:36:37+00:00", - "date_finish": "2024-07-12T20:36:37+00:00", - "operating_reset_at": 1720817197, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Create chat + Creates a new chat based on the field structure + + + +`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Code example" + Image = "https://openintegrations.dev/test_data/picture.jpg"; + OPI_TypeConversion.GetBinaryData(Image); + + B64Image = GetBase64StringFromBinaryData(Image); + + MembersArray = New Array; + MembersArray.Add(10); + MembersArray.Add(1); + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE", "OPEN"); + ChatStructure.Insert("TITLE", "New chat"); + ChatStructure.Insert("DESCRIPTION", "This is a new chat"); + ChatStructure.Insert("COLOR", "GREEN"); + ChatStructure.Insert("MESSAGE", "Welcome to new chat"); + ChatStructure.Insert("USERS", MembersArray); + ChatStructure.Insert("AVATAR", B64Image); + ChatStructure.Insert("OWNER_ID", 1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE", "CHAT"); + ChatStructure.Insert("TITLE", "Private chat"); + ChatStructure.Insert("USERS", MembersArray); + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateChat --url %url% --fields %fields% --token %token% + +``` + +```json title="Result" +{ + "result": 26, + "time": { + "start": 1720816597.42171, + "finish": 1720816597.52933, + "duration": 0.107618093490601, + "processing": 0.081672191619873, + "date_start": "2024-07-12T20:36:37+00:00", + "date_finish": "2024-07-12T20:36:37+00:00", + "operating_reset_at": 1720817197, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md index 2de007f6c2..cc6f926b02 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 6 ---- - -# Delete user from chat - Deletes user from chat - - - -`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | UserID | --user | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - UserID = 10; - - Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteUserFromChat --url %url% --chat %chat% --user %user% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865685.25089, - "finish": 1720865685.32425, - "duration": 0.0733590126037598, - "processing": 0.0480890274047852, - "date_start": "2024-07-13T10:14:45+00:00", - "date_finish": "2024-07-13T10:14:45+00:00", - "operating_reset_at": 1720866285, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Delete user from chat + Deletes user from chat + + + +`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + UserID = 10; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteUserFromChat --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865685.25089, + "finish": 1720865685.32425, + "duration": 0.0733590126037598, + "processing": 0.0480890274047852, + "date_start": "2024-07-13T10:14:45+00:00", + "date_finish": "2024-07-13T10:14:45+00:00", + "operating_reset_at": 1720866285, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md index 8dc6e3a302..07b0e8fc3d 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 11 ---- - -# Disable chat notifications - Disable chat notifications - - - -`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DisableChatNotifications --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865694.86568, - "finish": 1720865694.9092, - "duration": 0.0435128211975098, - "processing": 0.0169928073883057, - "date_start": "2024-07-13T10:14:54+00:00", - "date_finish": "2024-07-13T10:14:54+00:00", - "operating_reset_at": 1720866294, - "operating": 0 - } -} -``` +--- +sidebar_position: 11 +--- + +# Disable chat notifications + Disable chat notifications + + + +`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DisableChatNotifications --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865694.86568, + "finish": 1720865694.9092, + "duration": 0.0435128211975098, + "processing": 0.0169928073883057, + "date_start": "2024-07-13T10:14:54+00:00", + "date_finish": "2024-07-13T10:14:54+00:00", + "operating_reset_at": 1720866294, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md index 6acc5939d9..4d7b3a964d 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 12 ---- - -# Enable chat notifications - Enable chat notifications - - - -`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 EnableChatNotifications --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720865695.99933, - "finish": 1720865696.04205, - "duration": 0.0427119731903076, - "processing": 0.0170090198516846, - "date_start": "2024-07-13T10:14:55+00:00", - "date_finish": "2024-07-13T10:14:56+00:00", - "operating_reset_at": 1720866296, - "operating": 0 - } -} -``` +--- +sidebar_position: 12 +--- + +# Enable chat notifications + Enable chat notifications + + + +`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 EnableChatNotifications --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865695.99933, + "finish": 1720865696.04205, + "duration": 0.0427119731903076, + "processing": 0.0170090198516846, + "date_start": "2024-07-13T10:14:55+00:00", + "date_finish": "2024-07-13T10:14:56+00:00", + "operating_reset_at": 1720866296, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md index d38fbe9128..4ab2c610f9 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 20 ---- - -# Get chat files folder - Get information about folder for chat files - - - -`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetChatFilesFolder --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": 3250 - }, - "time": { - "start": 1720969169.10256, - "finish": 1720969169.1584, - "duration": 0.0558350086212158, - "processing": 0.0327038764953613, - "date_start": "2024-07-14T14:59:29+00:00", - "date_finish": "2024-07-14T14:59:29+00:00", - "operating_reset_at": 1720969769, - "operating": 0 - } -} -``` +--- +sidebar_position: 20 +--- + +# Get chat files folder + Get information about folder for chat files + + + +`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatFilesFolder --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": 3250 + }, + "time": { + "start": 1720969169.10256, + "finish": 1720969169.1584, + "duration": 0.0558350086212158, + "processing": 0.0327038764953613, + "date_start": "2024-07-14T14:59:29+00:00", + "date_finish": "2024-07-14T14:59:29+00:00", + "operating_reset_at": 1720969769, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md index 9c2e385b89..31068b0f73 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -1,120 +1,120 @@ ---- -sidebar_position: 15 ---- - -# Get chat members list - Get chat members list - - - -`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - - Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetChatMembersList --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "bot_data": null - }, - { - "id": 1, - "active": true, - "name": "Anton Titovets", - "first_name": "Anton", - "last_name": "Titovets", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-14T09:00:58+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "bot_data": null - } - ], - "total": 2, - "time": { - "start": 1720969161.4388, - "finish": 1720969161.46946, - "duration": 0.0306570529937744, - "processing": 0.00571608543395996, - "date_start": "2024-07-14T14:59:21+00:00", - "date_finish": "2024-07-14T14:59:21+00:00", - "operating_reset_at": 1720969761, - "operating": 0 - } -} -``` +--- +sidebar_position: 15 +--- + +# Get chat members list + Get chat members list + + + +`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + + Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatMembersList --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Anton Titovets", + "first_name": "Anton", + "last_name": "Titovets", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1720969161.4388, + "finish": 1720969161.46946, + "duration": 0.0306570529937744, + "processing": 0.00571608543395996, + "date_start": "2024-07-14T14:59:21+00:00", + "date_finish": "2024-07-14T14:59:21+00:00", + "operating_reset_at": 1720969761, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md index a4fcd732cf..c75dfee949 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -1,399 +1,399 @@ ---- -sidebar_position: 13 ---- - -# Get chat messages list - Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified - - - -`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | LastID | --last | String, Number | Id of last message | - | FirstID | --first | String, Number | ID of first message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat4"; - - Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetChatMessagesList --url %url% --chat %chat% --last %last% --first %first% --token %token% - -``` - -```json title="Result" -{ - "result": { - "chat_id": 10, - "messages": [ - { - "id": 3854, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T14:54:43+00:00", - "text": "Write it!", - "unread": false, - "uuid": "700d361d-8324-47fb-b989-647949c1c899", - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4286, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T16:06:51+00:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4366, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T16:40:58+00:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4406, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:57:33+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4446, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:21:27+00:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4486, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:22:30+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4526, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:41:21+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4668, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:10:33+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4708, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:22:56+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4748, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:26:01+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4788, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:28:01+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4828, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:28:36+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4868, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:30:18+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4908, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:52:24+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4948, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:53:31+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4990, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:57:06+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5060, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:59:43+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5140, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T09:29:40+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5182, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T09:35:56+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5262, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T11:27:54+00:00", - "text": "This message was deleted", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - } - ], - "users": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "desktop_last_date": false - }, - { - "id": 1, - "active": true, - "name": "Anton Titovets", - "first_name": "Anton", - "last_name": "Titovets", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-14T09:00:58+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "desktop_last_date": false - } - ], - "files": [] - }, - "time": { - "start": 1720969156.38474, - "finish": 1720969156.42064, - "duration": 0.0358970165252686, - "processing": 0.0108029842376709, - "date_start": "2024-07-14T14:59:16+00:00", - "date_finish": "2024-07-14T14:59:16+00:00", - "operating_reset_at": 1720969756, - "operating": 0 - } -} -``` +--- +sidebar_position: 13 +--- + +# Get chat messages list + Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified + + + +`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | LastID | --last | String, Number | Id of last message | + | FirstID | --first | String, Number | ID of first message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat4"; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatMessagesList --url %url% --chat %chat% --last %last% --first %first% --token %token% + +``` + +```json title="Result" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T14:54:43+00:00", + "text": "Write it!", + "unread": false, + "uuid": "700d361d-8324-47fb-b989-647949c1c899", + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:06:51+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:40:58+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:57:33+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:21:27+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:22:30+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:41:21+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:10:33+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4708, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:22:56+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4748, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:26:01+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4788, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:01+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4828, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:36+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4868, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:30:18+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4908, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:52:24+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4948, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:53:31+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4990, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:57:06+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5060, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:59:43+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5140, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:29:40+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5182, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:35:56+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5262, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T11:27:54+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + } + ], + "users": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + }, + { + "id": 1, + "active": true, + "name": "Anton Titovets", + "first_name": "Anton", + "last_name": "Titovets", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + } + ], + "files": [] + }, + "time": { + "start": 1720969156.38474, + "finish": 1720969156.42064, + "duration": 0.0358970165252686, + "processing": 0.0108029842376709, + "date_start": "2024-07-14T14:59:16+00:00", + "date_finish": "2024-07-14T14:59:16+00:00", + "operating_reset_at": 1720969756, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md index c231d9a94e..57933775d8 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 21 ---- - -# Get chats structure - Get chat fields structure - - - -`Function GetChatStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - - - - -```sh title="CLI command example" - - oint bitrix24 GetChatStructure --empty %empty% - -``` - - +--- +sidebar_position: 21 +--- + +# Get chats structure + Get chat fields structure + + + +`Function GetChatStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + + + + +```sh title="CLI command example" + + oint bitrix24 GetChatStructure --empty %empty% + +``` + + diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md index 60bc71c5ae..44c5ad919e 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 2 ---- - -# Get chats users - Gets the list of chat users by ID - - - -`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Result = OPI_Bitrix24.GetChatUsers(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetChatUsers --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": [ - 1, - 10 - ], - "time": { - "start": 1720816598.61771, - "finish": 1720816598.64882, - "duration": 0.0311079025268555, - "processing": 0.00316882133483887, - "date_start": "2024-07-12T20:36:38+00:00", - "date_finish": "2024-07-12T20:36:38+00:00", - "operating_reset_at": 1720817198, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Get chats users + Gets the list of chat users by ID + + + +`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatUsers --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1720816598.61771, + "finish": 1720816598.64882, + "duration": 0.0311079025268555, + "processing": 0.00316882133483887, + "date_start": "2024-07-12T20:36:38+00:00", + "date_finish": "2024-07-12T20:36:38+00:00", + "operating_reset_at": 1720817198, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md index 197d0248fe..8c4d6cf35e 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -1,133 +1,133 @@ ---- -sidebar_position: 14 ---- - -# Get dialog - Get chat data by ID - - - -`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - - Result = OPI_Bitrix24.GetDialog(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.GetDialog(URL, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetDialog --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": { - "id": 10, - "parent_chat_id": 0, - "parent_message_id": 0, - "name": "", - "description": "", - "owner": 10, - "extranet": false, - "avatar": "", - "color": "#ab7761", - "type": "private", - "counter": 1, - "user_counter": 0, - "message_count": 24, - "unread_id": 3854, - "restrictions": { - "avatar": true, - "rename": true, - "extend": true, - "call": true, - "mute": true, - "leave": true, - "leave_owner": true, - "send": true, - "user_list": true - }, - "last_message_id": 5262, - "last_id": 3852, - "marked_id": 0, - "disk_folder_id": 0, - "entity_type": "", - "entity_id": "", - "entity_data_1": "", - "entity_data_2": "", - "entity_data_3": "", - "mute_list": [], - "date_create": "2024-06-15T16:48:49+00:00", - "message_type": "P", - "disappearing_time": 0, - "public": "", - "role": "member", - "entity_link": { - "type": "", - "url": "" - }, - "permissions": { - "manage_users_add": "member", - "manage_users_delete": "manager", - "manage_ui": "member", - "manage_settings": "owner", - "manage_messages": "member", - "can_post": "member" - }, - "is_new": false, - "readed_list": [ - { - "user_id": 10, - "user_name": "Techno Pizza", - "message_id": 3854, - "date": null - } - ], - "manager_list": [], - "last_message_views": { - "message_id": 5262, - "first_viewers": [], - "count_of_viewers": 0 - }, - "dialog_id": "10" - }, - "time": { - "start": 1720969160.19046, - "finish": 1720969160.22782, - "duration": 0.037362813949585, - "processing": 0.0134620666503906, - "date_start": "2024-07-14T14:59:20+00:00", - "date_finish": "2024-07-14T14:59:20+00:00", - "operating_reset_at": 1720969760, - "operating": 0 - } -} -``` +--- +sidebar_position: 14 +--- + +# Get dialog + Get chat data by ID + + + +`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + + Result = OPI_Bitrix24.GetDialog(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.GetDialog(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetDialog --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 1, + "user_counter": 0, + "message_count": 24, + "unread_id": 3854, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 5262, + "last_id": 3852, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T16:48:49+00:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 5262, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1720969160.19046, + "finish": 1720969160.22782, + "duration": 0.037362813949585, + "processing": 0.0134620666503906, + "date_start": "2024-07-14T14:59:20+00:00", + "date_finish": "2024-07-14T14:59:20+00:00", + "operating_reset_at": 1720969760, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md index 0c0ca4ce4a..4f2d4b4a31 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 17 ---- - -# Get user status - Gets the status (online) of the current user - - - -`Function GetUserStatus(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetUserStatus(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetUserStatus(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetUserStatus --url %url% --token %token% - -``` - -```json title="Result" -{ - "error": "expired_token", - "error_description": "The access token provided has expired." -} -``` +--- +sidebar_position: 17 +--- + +# Get user status + Gets the status (online) of the current user + + + +`Function GetUserStatus(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetUserStatus(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetUserStatus(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetUserStatus --url %url% --token %token% + +``` + +```json title="Result" +{ + "error": "expired_token", + "error_description": "The access token provided has expired." +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md index 4026e08a6a..3e23fa6e45 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md @@ -1,94 +1,94 @@ ---- -sidebar_position: 4 ---- - -# Get users - Get users information for dialog - - - -`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ArrayOfUsers = New Array; - - ArrayOfUsers.Add(1); - ArrayOfUsers.Add(10); - - Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserIDs = 10; - - Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetUsers --url %url% --users %users% --token %token% - -``` - -```json title="Result" -{ - "result": { - "10": { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false - } - }, - "time": { - "start": 1722083796.56495, - "finish": 1722083796.59641, - "duration": 0.031451940536499, - "processing": 0.00229191780090332, - "date_start": "2024-07-27T12:36:36+00:00", - "date_finish": "2024-07-27T12:36:36+00:00", - "operating_reset_at": 1722084396, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Get users + Get users information for dialog + + + +`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ArrayOfUsers = New Array; + + ArrayOfUsers.Add(1); + ArrayOfUsers.Add(10); + + Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserIDs = 10; + + Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetUsers --url %url% --users %users% --token %token% + +``` + +```json title="Result" +{ + "result": { + "10": { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false + } + }, + "time": { + "start": 1722083796.56495, + "finish": 1722083796.59641, + "duration": 0.031451940536499, + "processing": 0.00229191780090332, + "date_start": "2024-07-27T12:36:36+00:00", + "date_finish": "2024-07-27T12:36:36+00:00", + "operating_reset_at": 1722084396, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md index 7c08d5a55d..b89714667e 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Leave chat - Removes the current user from the chat room - - - -`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - - Result = OPI_Bitrix24.LeaveChat(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720816599.74716, - "finish": 1720816599.81746, - "duration": 0.0702948570251465, - "processing": 0.0438079833984375, - "date_start": "2024-07-12T20:36:39+00:00", - "date_finish": "2024-07-12T20:36:39+00:00", - "operating_reset_at": 1720817199, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Leave chat + Removes the current user from the chat room + + + +`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816599.74716, + "finish": 1720816599.81746, + "duration": 0.0702948570251465, + "processing": 0.0438079833984375, + "date_start": "2024-07-12T20:36:39+00:00", + "date_finish": "2024-07-12T20:36:39+00:00", + "operating_reset_at": 1720817199, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md index 3d24b6764c..4a05db82ca 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 19 ---- - -# Read all - Mark all message as readed - - - -`Function ReadAll(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.ReadAll(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.ReadAll(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ReadAll --url %url% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969176.30834, - "finish": 1720969176.34001, - "duration": 0.0316698551177978, - "processing": 0.00501918792724609, - "date_start": "2024-07-14T14:59:36+00:00", - "date_finish": "2024-07-14T14:59:36+00:00", - "operating_reset_at": 1720969776, - "operating": 0 - } -} -``` +--- +sidebar_position: 19 +--- + +# Read all + Mark all message as readed + + + +`Function ReadAll(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.ReadAll(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.ReadAll(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ReadAll --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969176.30834, + "finish": 1720969176.34001, + "duration": 0.0316698551177978, + "processing": 0.00501918792724609, + "date_start": "2024-07-14T14:59:36+00:00", + "date_finish": "2024-07-14T14:59:36+00:00", + "operating_reset_at": 1720969776, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md index 294d1c0cbc..4df3cee361 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 16 ---- - -# Send write notification - Send Writing... status to dialog... - - - -`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - - Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 SendWritingNotification --url %url% --chat %chat% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969162.6704, - "finish": 1720969162.69719, - "duration": 0.0267889499664307, - "processing": 0.000684022903442383, - "date_start": "2024-07-14T14:59:22+00:00", - "date_finish": "2024-07-14T14:59:22+00:00", - "operating_reset_at": 1720969762, - "operating": 0 - } -} -``` +--- +sidebar_position: 16 +--- + +# Send write notification + Send Writing... status to dialog... + + + +`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + + Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendWritingNotification --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969162.6704, + "finish": 1720969162.69719, + "duration": 0.0267889499664307, + "processing": 0.000684022903442383, + "date_start": "2024-07-14T14:59:22+00:00", + "date_finish": "2024-07-14T14:59:22+00:00", + "operating_reset_at": 1720969762, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md index f1927e2c85..22f2312830 100644 --- a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 18 ---- - -# Set user status - Sets the status (online) of the current user - - - -`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Status | --status | String, Number | Status value: online, dnd, away | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Status = "dnd"; - - Result = OPI_Bitrix24.SetUserStatus(URL, Status); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - Status = "away"; - - Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 SetUserStatus --url %url% --status %status% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722083795.3692, - "finish": 1722083795.39818, - "duration": 0.0289750099182129, - "processing": 0.00522208213806152, - "date_start": "2024-07-27T12:36:35+00:00", - "date_finish": "2024-07-27T12:36:35+00:00", - "operating_reset_at": 1722084395, - "operating": 0 - } -} -``` +--- +sidebar_position: 18 +--- + +# Set user status + Sets the status (online) of the current user + + + +`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Status | --status | String, Number | Status value: online, dnd, away | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Status = "dnd"; + + Result = OPI_Bitrix24.SetUserStatus(URL, Status); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + Status = "away"; + + Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SetUserStatus --url %url% --status %status% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722083795.3692, + "finish": 1722083795.39818, + "duration": 0.0289750099182129, + "processing": 0.00522208213806152, + "date_start": "2024-07-27T12:36:35+00:00", + "date_finish": "2024-07-27T12:36:35+00:00", + "operating_reset_at": 1722084395, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md index 1910f08398..ce8ba1cb14 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 3 ---- - -# Add comment to task - Create new comment to the task - - - -`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1082"; - - Text = "Task impossible, let's split up"; - - Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Text = "Task uninpossible, don't split up"; - - Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": 1376, - "time": { - "start": 1720186702.77405, - "finish": 1720186703.52768, - "duration": 0.753632068634033, - "processing": 0.724568128585816, - "date_start": "2024-07-05T13:38:22+00:00", - "date_finish": "2024-07-05T13:38:23+00:00", - "operating_reset_at": 1720187302, - "operating": 0.724542856216431 - } -} -``` +--- +sidebar_position: 3 +--- + +# Add comment to task + Create new comment to the task + + + +`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1082"; + + Text = "Task impossible, let's split up"; + + Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Text = "Task uninpossible, don't split up"; + + Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": 1376, + "time": { + "start": 1720186702.77405, + "finish": 1720186703.52768, + "duration": 0.753632068634033, + "processing": 0.724568128585816, + "date_start": "2024-07-05T13:38:22+00:00", + "date_finish": "2024-07-05T13:38:23+00:00", + "operating_reset_at": 1720187302, + "operating": 0.724542856216431 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md index 1ae3c8eb1a..8cf552bb74 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 7 ---- - -# Create result from comment - Create task result from comment - - - -`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - CommentID = "2932"; - - Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - CommentID = "2936"; - - Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "id": 130, - "taskId": 432, - "commentId": 1376, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:22+00:00", - "updatedAt": "2024-07-05T13:38:22+00:00", - "status": 0, - "text": "The task has been changed, let's split up", - "formattedText": "The task has been changed, let's split up", - "files": null - }, - "time": { - "start": 1720186706.85195, - "finish": 1720186706.92671, - "duration": 0.0747611522674561, - "processing": 0.0460391044616699, - "date_start": "2024-07-05T13:38:26+00:00", - "date_finish": "2024-07-05T13:38:26+00:00", - "operating_reset_at": 1720187306, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Create result from comment + Create task result from comment + + + +`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + CommentID = "2932"; + + Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + CommentID = "2936"; + + Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "id": 130, + "taskId": 432, + "commentId": 1376, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:22+00:00", + "updatedAt": "2024-07-05T13:38:22+00:00", + "status": 0, + "text": "The task has been changed, let's split up", + "formattedText": "The task has been changed, let's split up", + "files": null + }, + "time": { + "start": 1720186706.85195, + "finish": 1720186706.92671, + "duration": 0.0747611522674561, + "processing": 0.0460391044616699, + "date_start": "2024-07-05T13:38:26+00:00", + "date_finish": "2024-07-05T13:38:26+00:00", + "operating_reset_at": 1720187306, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md index 91cb784cf6..e8b5204eb2 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 8 ---- - -# Delete result from comment - Deletes task result, created from a comment - - - -`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - CommentID = "2932"; - - Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - CommentID = "2936"; - - Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": null, - "time": { - "start": 1720295536.04613, - "finish": 1720295536.09868, - "duration": 0.0525519847869873, - "processing": 0.0231878757476807, - "date_start": "2024-07-06T19:52:16+00:00", - "date_finish": "2024-07-06T19:52:16+00:00", - "operating_reset_at": 1720296136, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Delete result from comment + Deletes task result, created from a comment + + + +`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + CommentID = "2932"; + + Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + CommentID = "2936"; + + Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720295536.04613, + "finish": 1720295536.09868, + "duration": 0.0525519847869873, + "processing": 0.0231878757476807, + "date_start": "2024-07-06T19:52:16+00:00", + "date_finish": "2024-07-06T19:52:16+00:00", + "operating_reset_at": 1720296136, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md index 9bbe7f5cc2..d931188759 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 5 ---- - -# Delete comment - Delete task comment by ID - - - -`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | ID of comment to remove | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1082"; - CommentID = "2932"; - - Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - CommentID = "2936"; - - Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720295541.27592, - "finish": 1720295541.38076, - "duration": 0.104840040206909, - "processing": 0.0781040191650391, - "date_start": "2024-07-06T19:52:21+00:00", - "date_finish": "2024-07-06T19:52:21+00:00", - "operating_reset_at": 1720296141, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Delete comment + Delete task comment by ID + + + +`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | ID of comment to remove | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1082"; + CommentID = "2932"; + + Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + CommentID = "2936"; + + Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720295541.27592, + "finish": 1720295541.38076, + "duration": 0.104840040206909, + "processing": 0.0781040191650391, + "date_start": "2024-07-06T19:52:21+00:00", + "date_finish": "2024-07-06T19:52:21+00:00", + "operating_reset_at": 1720296141, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md index 80d08dc8a9..470ad1385d 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 9 ---- - -# Get comment structure - Get comment fields structure - - - -`Function GetCommentStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - - - - -```sh title="CLI command example" - - oint bitrix24 GetCommentStructure --empty %empty% - -``` - - +--- +sidebar_position: 9 +--- + +# Get comment structure + Get comment fields structure + + + +`Function GetCommentStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + + + + +```sh title="CLI command example" + + oint bitrix24 GetCommentStructure --empty %empty% + +``` + + diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md index cd6d3ab087..598c8f3d1a 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 6 ---- - -# Get results list - Gets results list for task - - - -`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1082"; - - Result = OPI_Bitrix24.GetResultsList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetResultsList --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": [ - { - "id": 130, - "taskId": 432, - "commentId": 1376, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:22+00:00", - "updatedAt": "2024-07-05T13:38:22+00:00", - "status": 0, - "text": "The task has been changed, let's split up", - "formattedText": "The task has been changed, let's split up", - "files": [] - }, - { - "id": 128, - "taskId": 432, - "commentId": 1374, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:21+00:00", - "updatedAt": "2024-07-05T13:38:21+00:00", - "status": 0, - "text": "The task has been changed, do not split up", - "formattedText": "The task has been changed, do not split up", - "files": [] - } - ], - "time": { - "start": 1720186708.49595, - "finish": 1720186708.54066, - "duration": 0.044705867767334, - "processing": 0.00980901718139648, - "date_start": "2024-07-05T13:38:28+00:00", - "date_finish": "2024-07-05T13:38:28+00:00", - "operating_reset_at": 1720187308, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Get results list + Gets results list for task + + + +`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1082"; + + Result = OPI_Bitrix24.GetResultsList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetResultsList --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "id": 130, + "taskId": 432, + "commentId": 1376, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:22+00:00", + "updatedAt": "2024-07-05T13:38:22+00:00", + "status": 0, + "text": "The task has been changed, let's split up", + "formattedText": "The task has been changed, let's split up", + "files": [] + }, + { + "id": 128, + "taskId": 432, + "commentId": 1374, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:21+00:00", + "updatedAt": "2024-07-05T13:38:21+00:00", + "status": 0, + "text": "The task has been changed, do not split up", + "formattedText": "The task has been changed, do not split up", + "files": [] + } + ], + "time": { + "start": 1720186708.49595, + "finish": 1720186708.54066, + "duration": 0.044705867767334, + "processing": 0.00980901718139648, + "date_start": "2024-07-05T13:38:28+00:00", + "date_finish": "2024-07-05T13:38:28+00:00", + "operating_reset_at": 1720187308, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md index 7f7924ca88..1129477f4c 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 2 ---- - -# Get task comment - Gets task comment data by ID - - - -`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | CommentID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - CommentID = "2932"; - TaskID = "1082"; - - Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - CommentID = "2936"; - - Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "POST_MESSAGE_HTML": null, - "ID": "1496", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Anton Titovets", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:08+00:00", - "POST_MESSAGE": "The task has been changed, let's split up" - }, - "time": { - "start": 1720295539.50621, - "finish": 1720295539.55446, - "duration": 0.0482499599456787, - "processing": 0.019589900970459, - "date_start": "2024-07-06T19:52:19+00:00", - "date_finish": "2024-07-06T19:52:19+00:00", - "operating_reset_at": 1720296139, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Get task comment + Gets task comment data by ID + + + +`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | CommentID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + CommentID = "2932"; + TaskID = "1082"; + + Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + CommentID = "2936"; + + Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "POST_MESSAGE_HTML": null, + "ID": "1496", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Anton Titovets", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:08+00:00", + "POST_MESSAGE": "The task has been changed, let's split up" + }, + "time": { + "start": 1720295539.50621, + "finish": 1720295539.55446, + "duration": 0.0482499599456787, + "processing": 0.019589900970459, + "date_start": "2024-07-06T19:52:19+00:00", + "date_finish": "2024-07-06T19:52:19+00:00", + "operating_reset_at": 1720296139, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md index 7f601d7919..5cfa73d79f 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 1 ---- - -# Get comments list for a task - Get user comments list for a task - - - -`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1082"; - - Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTaskCommentsList --url %url% --task %task% --filter %filter% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "POST_MESSAGE_HTML": null, - "ID": "1494", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Anton Titovets", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:07+00:00", - "POST_MESSAGE": "The task has been changed, do not split up" - }, - { - "POST_MESSAGE_HTML": null, - "ID": "1496", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Anton Titovets", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:08+00:00", - "POST_MESSAGE": "The task has been changed, let's split up" - } - ], - "time": { - "start": 1720295537.77876, - "finish": 1720295537.83513, - "duration": 0.0563700199127197, - "processing": 0.0240809917449951, - "date_start": "2024-07-06T19:52:17+00:00", - "date_finish": "2024-07-06T19:52:17+00:00", - "operating_reset_at": 1720296137, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Get comments list for a task + Get user comments list for a task + + + +`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1082"; + + Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskCommentsList --url %url% --task %task% --filter %filter% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "POST_MESSAGE_HTML": null, + "ID": "1494", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Anton Titovets", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:07+00:00", + "POST_MESSAGE": "The task has been changed, do not split up" + }, + { + "POST_MESSAGE_HTML": null, + "ID": "1496", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Anton Titovets", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:08+00:00", + "POST_MESSAGE": "The task has been changed, let's split up" + } + ], + "time": { + "start": 1720295537.77876, + "finish": 1720295537.83513, + "duration": 0.0563700199127197, + "processing": 0.0240809917449951, + "date_start": "2024-07-06T19:52:17+00:00", + "date_finish": "2024-07-06T19:52:17+00:00", + "operating_reset_at": 1720296137, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md index ec3c86a15e..719f86b69b 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 4 ---- - -# Update task comment - Changes task comment text - - - -`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | CommentID | --comment | Number, String | CommentID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1082"; - CommentID = "2932"; - - Text = "The task has been changed, do not split up"; - - Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - CommentID = "2936"; - - Text = "The task has been changed, let's split up"; - - Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720186705.11133, - "finish": 1720186705.21965, - "duration": 0.108311891555786, - "processing": 0.0788998603820801, - "date_start": "2024-07-05T13:38:25+00:00", - "date_finish": "2024-07-05T13:38:25+00:00", - "operating_reset_at": 1720187305, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Update task comment + Changes task comment text + + + +`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | CommentID | --comment | Number, String | CommentID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1082"; + CommentID = "2932"; + + Text = "The task has been changed, do not split up"; + + Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + CommentID = "2936"; + + Text = "The task has been changed, let's split up"; + + Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720186705.11133, + "finish": 1720186705.21965, + "duration": 0.108311891555786, + "processing": 0.0788998603820801, + "date_start": "2024-07-05T13:38:25+00:00", + "date_finish": "2024-07-05T13:38:25+00:00", + "operating_reset_at": 1720187305, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md index 2ed6a08321..8c883bb03f 100644 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 2 ---- - -# Add custom task field - Adds a new custom field to be added to the task - - - -`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Type | --type | String | Field type: string, double, date, boolean | - | Name | --fieldname | String | Text identifier (name) of the field | - | ExternalID | --externalid | String | Text identifier for external integration | - | Title | --title | String | Field title | - | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Type = "date"; - Name = "BIRTHDAY_FIELD"; - - Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Type = "string"; - Name = "TEXT_FIELD"; - ExternalID = "BITRIX_TEXT_FIELD"; - Title = "Text field"; - Signature = New Structure("en,ru", "Some field", "Nekotoroe pole"); - - Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% - -``` - -```json title="Result" -{ - "result": 261, - "time": { - "start": 1722114794.52732, - "finish": 1722114794.59725, - "duration": 0.0699310302734375, - "processing": 0.0470340251922607, - "date_start": "2024-07-27T21:13:14+00:00", - "date_finish": "2024-07-27T21:13:14+00:00", - "operating_reset_at": 1722115394, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Add custom task field + Adds a new custom field to be added to the task + + + +`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Type | --type | String | Field type: string, double, date, boolean | + | Name | --fieldname | String | Text identifier (name) of the field | + | ExternalID | --externalid | String | Text identifier for external integration | + | Title | --title | String | Field title | + | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Type = "date"; + Name = "BIRTHDAY_FIELD"; + + Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Type = "string"; + Name = "TEXT_FIELD"; + ExternalID = "BITRIX_TEXT_FIELD"; + Title = "Text field"; + Signature = New Structure("en,ru", "Some field", "Nekotoroe pole"); + + Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Result" +{ + "result": 261, + "time": { + "start": 1722114794.52732, + "finish": 1722114794.59725, + "duration": 0.0699310302734375, + "processing": 0.0470340251922607, + "date_start": "2024-07-27T21:13:14+00:00", + "date_finish": "2024-07-27T21:13:14+00:00", + "operating_reset_at": 1722115394, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md index 7c5a4c6eab..fc6e504300 100644 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 5 ---- - -# Delete custom task field - Deletes a custom task field - - - -`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for deletion | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FieldID = "255"; - - Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - FieldID = "257"; - - Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, ); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722114801.22925, - "finish": 1722114801.26696, - "duration": 0.0377130508422852, - "processing": 0.0185980796813965, - "date_start": "2024-07-27T21:13:21+00:00", - "date_finish": "2024-07-27T21:13:21+00:00", - "operating_reset_at": 1722115401, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Delete custom task field + Deletes a custom task field + + + +`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for deletion | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FieldID = "255"; + + Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + FieldID = "257"; + + Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, ); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722114801.22925, + "finish": 1722114801.26696, + "duration": 0.0377130508422852, + "processing": 0.0185980796813965, + "date_start": "2024-07-27T21:13:21+00:00", + "date_finish": "2024-07-27T21:13:21+00:00", + "operating_reset_at": 1722115401, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md index 1749f48e37..47eb2bafc6 100644 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md @@ -1,186 +1,186 @@ ---- -sidebar_position: 4 ---- - -# Gets a custom task field - Get custom task field data - - - -`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for retrieval | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FieldID = "255"; - - Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - FieldID = "257"; - - Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, ); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - }, - "EDIT_FORM_LABEL": { - "ar": "", - "br": "", - "de": "", - "en": "Updated field", - "fr": "", - "id": "", - "it": "", - "ja": "", - "la": "", - "ms": "", - "pl": "", - "ru": "Izmenennoe pole", - "sc": "", - "tc": "", - "th": "", - "tr": "", - "ua": "", - "vn": "" - }, - "LIST_COLUMN_LABEL": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "LIST_FILTER_LABEL": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "ERROR_MESSAGE": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - }, - "HELP_MESSAGE": { - "ar": "Text field", - "br": "Text field", - "de": "Text field", - "en": "Text field", - "fr": "Text field", - "id": "Text field", - "it": "Text field", - "ja": "Text field", - "la": "Text field", - "ms": "Text field", - "pl": "Text field", - "ru": "Text field", - "sc": "Text field", - "tc": "Text field", - "th": "Text field", - "tr": "Text field", - "ua": "Text field", - "vn": "Text field" - } - }, - "total": 0, - "time": { - "start": 1722114797.9059, - "finish": 1722114797.92375, - "duration": 0.0178542137145996, - "processing": 0.000695943832397461, - "date_start": "2024-07-27T21:13:17+00:00", - "date_finish": "2024-07-27T21:13:17+00:00", - "operating_reset_at": 1722115397, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Gets a custom task field + Get custom task field data + + + +`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for retrieval | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FieldID = "255"; + + Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + FieldID = "257"; + + Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, ); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + }, + "EDIT_FORM_LABEL": { + "ar": "", + "br": "", + "de": "", + "en": "Updated field", + "fr": "", + "id": "", + "it": "", + "ja": "", + "la": "", + "ms": "", + "pl": "", + "ru": "Izmenennoe pole", + "sc": "", + "tc": "", + "th": "", + "tr": "", + "ua": "", + "vn": "" + }, + "LIST_COLUMN_LABEL": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "LIST_FILTER_LABEL": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "ERROR_MESSAGE": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + }, + "HELP_MESSAGE": { + "ar": "Text field", + "br": "Text field", + "de": "Text field", + "en": "Text field", + "fr": "Text field", + "id": "Text field", + "it": "Text field", + "ja": "Text field", + "la": "Text field", + "ms": "Text field", + "pl": "Text field", + "ru": "Text field", + "sc": "Text field", + "tc": "Text field", + "th": "Text field", + "tr": "Text field", + "ua": "Text field", + "vn": "Text field" + } + }, + "total": 0, + "time": { + "start": 1722114797.9059, + "finish": 1722114797.92375, + "duration": 0.0178542137145996, + "processing": 0.000695943832397461, + "date_start": "2024-07-27T21:13:17+00:00", + "date_finish": "2024-07-27T21:13:17+00:00", + "operating_reset_at": 1722115397, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md index 1c4a74d4a3..3bee3b1626 100644 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md @@ -1,157 +1,157 @@ ---- -sidebar_position: 1 ---- - -# Get list of custom task fields - Gets list of custom task fields - - - -`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "11", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_CRM_TASK", - "USER_TYPE_ID": "crm", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "LEAD": "Y", - "CONTACT": "Y", - "COMPANY": "Y", - "DEAL": "Y", - "ORDER": "Y", - "SMART_INVOICE": "Y" - } - }, - { - "ID": "101", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TASK_WEBDAV_FILES", - "USER_TYPE_ID": "disk_file", - "XML_ID": "TASK_WEBDAV_FILES", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [] - }, - { - "ID": "117", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_MAIL_MESSAGE", - "USER_TYPE_ID": "mail_message", - "XML_ID": "", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "N", - "IS_SEARCHABLE": "N", - "SETTINGS": [] - }, - { - "ID": "259", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_BIRTHDAY_FIELD", - "USER_TYPE_ID": "date", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "DEFAULT_VALUE": { - "TYPE": "NONE", - "VALUE": "" - } - } - }, - { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - } - } - ], - "total": 0, - "time": { - "start": 1722114799.57, - "finish": 1722114799.58769, - "duration": 0.0176839828491211, - "processing": 0.000379085540771484, - "date_start": "2024-07-27T21:13:19+00:00", - "date_finish": "2024-07-27T21:13:19+00:00", - "operating_reset_at": 1722115399, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Get list of custom task fields + Gets list of custom task fields + + + +`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "11", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_CRM_TASK", + "USER_TYPE_ID": "crm", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "LEAD": "Y", + "CONTACT": "Y", + "COMPANY": "Y", + "DEAL": "Y", + "ORDER": "Y", + "SMART_INVOICE": "Y" + } + }, + { + "ID": "101", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TASK_WEBDAV_FILES", + "USER_TYPE_ID": "disk_file", + "XML_ID": "TASK_WEBDAV_FILES", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [] + }, + { + "ID": "117", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_MAIL_MESSAGE", + "USER_TYPE_ID": "mail_message", + "XML_ID": "", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "N", + "IS_SEARCHABLE": "N", + "SETTINGS": [] + }, + { + "ID": "259", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_BIRTHDAY_FIELD", + "USER_TYPE_ID": "date", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "DEFAULT_VALUE": { + "TYPE": "NONE", + "VALUE": "" + } + } + }, + { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + } + } + ], + "total": 0, + "time": { + "start": 1722114799.57, + "finish": 1722114799.58769, + "duration": 0.0176839828491211, + "processing": 0.000379085540771484, + "date_start": "2024-07-27T21:13:19+00:00", + "date_finish": "2024-07-27T21:13:19+00:00", + "operating_reset_at": 1722115399, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md index e02dc30546..3800fd5116 100644 --- a/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md +++ b/docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 3 ---- - -# Update custom task field - Updates a custom task field data - - - -`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldID | --fieldid | String, Number | Field ID for updating | - | ExternalID | --externalid | String | Text identifier for external integration | - | Title | --title | String | Field title | - | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - FieldID = "255"; - Title = "New title"; - - Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - FieldID = "257"; - ExternalID = "NEW_TEXT_FIELD"; - Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole"); - - Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID,, Signature, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722114796.23423, - "finish": 1722114796.26623, - "duration": 0.0319931507110596, - "processing": 0.0126721858978271, - "date_start": "2024-07-27T21:13:16+00:00", - "date_finish": "2024-07-27T21:13:16+00:00", - "operating_reset_at": 1722115396, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Update custom task field + Updates a custom task field data + + + +`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldID | --fieldid | String, Number | Field ID for updating | + | ExternalID | --externalid | String | Text identifier for external integration | + | Title | --title | String | Field title | + | Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + FieldID = "255"; + Title = "New title"; + + Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + FieldID = "257"; + ExternalID = "NEW_TEXT_FIELD"; + Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole"); + + Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID,, Signature, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722114796.23423, + "finish": 1722114796.26623, + "duration": 0.0319931507110596, + "processing": 0.0126721858978271, + "date_start": "2024-07-27T21:13:16+00:00", + "date_finish": "2024-07-27T21:13:16+00:00", + "operating_reset_at": 1722115396, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Create-department.md b/docs/en/md/Bitrix24/Departments-managment/Create-department.md index 114a63888e..bd875c955c 100644 --- a/docs/en/md/Bitrix24/Departments-managment/Create-department.md +++ b/docs/en/md/Bitrix24/Departments-managment/Create-department.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 1 ---- - -# Create department - Creates a new department - - - -`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | Department name | - | ParentID | --parentid | String, Number | ID of parent department | - | HeadID | --headid | String, Number | ID of department manager | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Name = "Main department"; - ParentID = 1; - - Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Name = "Subordinate department"; - ParentID = "68"; - HeadID = 1; - - Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Result" -{ - "result": 42, - "time": { - "start": 1722171476.78229, - "finish": 1722171477.19809, - "duration": 0.415800094604492, - "processing": 0.389212131500244, - "date_start": "2024-07-28T12:57:56+00:00", - "date_finish": "2024-07-28T12:57:57+00:00", - "operating_reset_at": 1722172076, - "operating": 0.389190912246704 - } -} -``` +--- +sidebar_position: 1 +--- + +# Create department + Creates a new department + + + +`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | Department name | + | ParentID | --parentid | String, Number | ID of parent department | + | HeadID | --headid | String, Number | ID of department manager | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Name = "Main department"; + ParentID = 1; + + Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Name = "Subordinate department"; + ParentID = "68"; + HeadID = 1; + + Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Result" +{ + "result": 42, + "time": { + "start": 1722171476.78229, + "finish": 1722171477.19809, + "duration": 0.415800094604492, + "processing": 0.389212131500244, + "date_start": "2024-07-28T12:57:56+00:00", + "date_finish": "2024-07-28T12:57:57+00:00", + "operating_reset_at": 1722172076, + "operating": 0.389190912246704 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Delete-department.md b/docs/en/md/Bitrix24/Departments-managment/Delete-department.md index c0d2e0d4e6..f231583c70 100644 --- a/docs/en/md/Bitrix24/Departments-managment/Delete-department.md +++ b/docs/en/md/Bitrix24/Departments-managment/Delete-department.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Delete department - Delets department by ID - - - -`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Department ID for deletion | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - DepartmentID = "70"; - - Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - DepartmentID = "68"; - - Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722171482.56495, - "finish": 1722171482.65313, - "duration": 0.0881810188293457, - "processing": 0.0624208450317383, - "date_start": "2024-07-28T12:58:02+00:00", - "date_finish": "2024-07-28T12:58:02+00:00", - "operating_reset_at": 1722172082, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Delete department + Delets department by ID + + + +`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Department ID for deletion | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + DepartmentID = "70"; + + Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + DepartmentID = "68"; + + Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722171482.56495, + "finish": 1722171482.65313, + "duration": 0.0881810188293457, + "processing": 0.0624208450317383, + "date_start": "2024-07-28T12:58:02+00:00", + "date_finish": "2024-07-28T12:58:02+00:00", + "operating_reset_at": 1722172082, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Get-departments.md b/docs/en/md/Bitrix24/Departments-managment/Get-departments.md index b0e0b278a6..affb439ca9 100644 --- a/docs/en/md/Bitrix24/Departments-managment/Get-departments.md +++ b/docs/en/md/Bitrix24/Departments-managment/Get-departments.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 3 ---- - -# Get departments - Gets a list of departments by ID or filter - - - -`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Selection by department ID | - | Name | --title | String | Filter by name | - | ParentID | --parentid | String, Number | Filter by parent ID | - | HeadID | --headid | String, Number | Filter by manager ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - DepartmentID = "70"; - - Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - HeadID = 1; - - Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "42", - "NAME": "Subordinate department", - "SORT": 500, - "PARENT": "40", - "UF_HEAD": "1" - } - ], - "total": 1, - "time": { - "start": 1722171478.80371, - "finish": 1722171478.83794, - "duration": 0.034229040145874, - "processing": 0.00419092178344727, - "date_start": "2024-07-28T12:57:58+00:00", - "date_finish": "2024-07-28T12:57:58+00:00", - "operating_reset_at": 1722172078, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Get departments + Gets a list of departments by ID or filter + + + +`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Selection by department ID | + | Name | --title | String | Filter by name | + | ParentID | --parentid | String, Number | Filter by parent ID | + | HeadID | --headid | String, Number | Filter by manager ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + DepartmentID = "70"; + + Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + HeadID = 1; + + Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "42", + "NAME": "Subordinate department", + "SORT": 500, + "PARENT": "40", + "UF_HEAD": "1" + } + ], + "total": 1, + "time": { + "start": 1722171478.80371, + "finish": 1722171478.83794, + "duration": 0.034229040145874, + "processing": 0.00419092178344727, + "date_start": "2024-07-28T12:57:58+00:00", + "date_finish": "2024-07-28T12:57:58+00:00", + "operating_reset_at": 1722172078, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Departments-managment/Update-department.md b/docs/en/md/Bitrix24/Departments-managment/Update-department.md index a2dd4acdf0..6ced9657e1 100644 --- a/docs/en/md/Bitrix24/Departments-managment/Update-department.md +++ b/docs/en/md/Bitrix24/Departments-managment/Update-department.md @@ -1,78 +1,78 @@ ---- -sidebar_position: 2 ---- - -# Update department - Update an existing department - - - -`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | DepartmentID | --depid | String, Number | Department ID | - | Name | --title | String | Department name | - | ParentID | --parentid | String, Number | ID of parent department | - | HeadID | --headid | String, Number | ID of department manager | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - DepartmentID = "68"; - ParentID = 7; - - Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - DepartmentID = "70"; - Name = "New department"; - ParentID = 1; - HeadID = 10; - - Result = OPI_Bitrix24.UpdateDepartment(URL -, DepartmentID -, Name -, ParentID -, HeadID -, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722171480.45996, - "finish": 1722171480.83957, - "duration": 0.37961220741272, - "processing": 0.347241878509522, - "date_start": "2024-07-28T12:58:00+00:00", - "date_finish": "2024-07-28T12:58:00+00:00", - "operating_reset_at": 1722172080, - "operating": 0.34721302986145 - } -} -``` +--- +sidebar_position: 2 +--- + +# Update department + Update an existing department + + + +`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | DepartmentID | --depid | String, Number | Department ID | + | Name | --title | String | Department name | + | ParentID | --parentid | String, Number | ID of parent department | + | HeadID | --headid | String, Number | ID of department manager | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + DepartmentID = "68"; + ParentID = 7; + + Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + DepartmentID = "70"; + Name = "New department"; + ParentID = 1; + HeadID = 10; + + Result = OPI_Bitrix24.UpdateDepartment(URL +, DepartmentID +, Name +, ParentID +, HeadID +, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722171480.45996, + "finish": 1722171480.83957, + "duration": 0.37961220741272, + "processing": 0.347241878509522, + "date_start": "2024-07-28T12:58:00+00:00", + "date_finish": "2024-07-28T12:58:00+00:00", + "operating_reset_at": 1722172080, + "operating": 0.34721302986145 + } +} +``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md index 0adb52f73d..5861b2d6b5 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 6 ---- - -# Add comment to post - Adds a comment to the post - - - -`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | PostID | --postid | String, Number | Post ID | - | Text | --text | String | Comment text | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) -::: -
- - -```bsl title="Code example" - Text = "Comment for post"; - PostID = "440"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text); - - Text = "Another comment"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddPostComment --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": 168, - "time": { - "start": 1720186639.67208, - "finish": 1720186639.77202, - "duration": 0.0999400615692139, - "processing": 0.0715811252593994, - "date_start": "2024-07-05T13:37:19+00:00", - "date_finish": "2024-07-05T13:37:19+00:00", - "operating_reset_at": 1720187239, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Add comment to post + Adds a comment to the post + + + +`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | PostID | --postid | String, Number | Post ID | + | Text | --text | String | Comment text | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) +::: +
+ + +```bsl title="Code example" + Text = "Comment for post"; + PostID = "440"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text); + + Text = "Another comment"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddPostComment --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": 168, + "time": { + "start": 1720186639.67208, + "finish": 1720186639.77202, + "duration": 0.0999400615692139, + "processing": 0.0715811252593994, + "date_start": "2024-07-05T13:37:19+00:00", + "date_finish": "2024-07-05T13:37:19+00:00", + "operating_reset_at": 1720187239, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Delete-file.md b/docs/en/md/Bitrix24/File-managment/Delete-file.md index 044a6ebfeb..2f021c57b5 100644 --- a/docs/en/md/Bitrix24/File-managment/Delete-file.md +++ b/docs/en/md/Bitrix24/File-managment/Delete-file.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Delete file - Delete file by ID - - - -`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | ID of removing file | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FileID = "5008"; - - Result = OPI_Bitrix24.DeleteFile(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - FileID = "5010"; - - Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1718783933.86753, - "finish": 1718783937.64223, - "duration": 3.77469992637634, - "processing": 3.73617887496948, - "date_start": "2024-06-19T07:58:53+00:00", - "date_finish": "2024-06-19T07:58:57+00:00", - "operating_reset_at": 1718784533, - "operating": 3.73615193367004 - } -} -``` +--- +sidebar_position: 4 +--- + +# Delete file + Delete file by ID + + + +`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | ID of removing file | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FileID = "5008"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + FileID = "5010"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1718783933.86753, + "finish": 1718783937.64223, + "duration": 3.77469992637634, + "processing": 3.73617887496948, + "date_start": "2024-06-19T07:58:53+00:00", + "date_finish": "2024-06-19T07:58:57+00:00", + "operating_reset_at": 1718784533, + "operating": 3.73615193367004 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md index 2451aebeb1..3582e796de 100644 --- a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md +++ b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 5 ---- - -# Get external link for a file - Get external link to file - - - -`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FileID = "5010"; - - Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFileExternalLink --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": "https://b24-ar17wx.bitrix24.by/~pT3DD", - "time": { - "start": 1720017752.7023, - "finish": 1720017752.74417, - "duration": 0.0418639183044434, - "processing": 0.00636386871337891, - "date_start": "2024-07-03T14:42:32+00:00", - "date_finish": "2024-07-03T14:42:32+00:00", - "operating_reset_at": 1720018352, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Get external link for a file + Get external link to file + + + +`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FileID = "5010"; + + Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFileExternalLink --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": "https://b24-ar17wx.bitrix24.by/~pT3DD", + "time": { + "start": 1720017752.7023, + "finish": 1720017752.74417, + "duration": 0.0418639183044434, + "processing": 0.00636386871337891, + "date_start": "2024-07-03T14:42:32+00:00", + "date_finish": "2024-07-03T14:42:32+00:00", + "operating_reset_at": 1720018352, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-information.md b/docs/en/md/Bitrix24/File-managment/Get-file-information.md index 3140edea45..05b4883aca 100644 --- a/docs/en/md/Bitrix24/File-managment/Get-file-information.md +++ b/docs/en/md/Bitrix24/File-managment/Get-file-information.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Get information about file - Get information about file by ID - - - -`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FileID = "5010"; - - Result = OPI_Bitrix24.GetFileInformation(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetFileInformation --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1716", - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" - }, - "time": { - "start": 1720017751.37945, - "finish": 1720017751.42512, - "duration": 0.0456681251525879, - "processing": 0.0131018161773682, - "date_start": "2024-07-03T14:42:31+00:00", - "date_finish": "2024-07-03T14:42:31+00:00", - "operating_reset_at": 1720018351, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Get information about file + Get information about file by ID + + + +`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FileID = "5010"; + + Result = OPI_Bitrix24.GetFileInformation(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetFileInformation --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1716", + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + }, + "time": { + "start": 1720017751.37945, + "finish": 1720017751.42512, + "duration": 0.0456681251525879, + "processing": 0.0131018161773682, + "date_start": "2024-07-03T14:42:31+00:00", + "date_finish": "2024-07-03T14:42:31+00:00", + "operating_reset_at": 1720018351, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Make-file-copy.md b/docs/en/md/Bitrix24/File-managment/Make-file-copy.md index 9361eb5c0e..f8faac68bf 100644 --- a/docs/en/md/Bitrix24/File-managment/Make-file-copy.md +++ b/docs/en/md/Bitrix24/File-managment/Make-file-copy.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 8 ---- - -# Copy file - Copy file from one destination to another - - - -`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | Original file ID | - | FolderID | --folderid | String, Number | ID of copy destination folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) -::: -
- - -```bsl title="Code example" - FolderID = "5014"; - FileID = "5010"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID); - - FolderID = "5016"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token); - - Check_BitrixObject(Result); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MakeFileCopy --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 1744, - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "1722", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 1146, - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:54+00:00", - "UPDATE_TIME": "2024-07-03T14:42:54+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" - }, - "time": { - "start": 1720017774.37632, - "finish": 1720017774.44715, - "duration": 0.07082200050354, - "processing": 0.0407531261444092, - "date_start": "2024-07-03T14:42:54+00:00", - "date_finish": "2024-07-03T14:42:54+00:00", - "operating_reset_at": 1720018374, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Copy file + Copy file from one destination to another + + + +`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | Original file ID | + | FolderID | --folderid | String, Number | ID of copy destination folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "5014"; + FileID = "5010"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID); + + FolderID = "5016"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token); + + Check_BitrixObject(Result); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MakeFileCopy --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 1744, + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "1722", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 1146, + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:54+00:00", + "UPDATE_TIME": "2024-07-03T14:42:54+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg" + }, + "time": { + "start": 1720017774.37632, + "finish": 1720017774.44715, + "duration": 0.07082200050354, + "processing": 0.0407531261444092, + "date_start": "2024-07-03T14:42:54+00:00", + "date_finish": "2024-07-03T14:42:54+00:00", + "operating_reset_at": 1720018374, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md index 94129bfebb..d99602d66a 100644 --- a/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md +++ b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 6 ---- - -# Mark file as deleted - Move file to recycle bin - - - -`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FileID = "5010"; - - Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MarkFileAsDeleted --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1716", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17200177547139i" - }, - "time": { - "start": 1720017755.36075, - "finish": 1720017755.40426, - "duration": 0.0435140132904053, - "processing": 0.0109550952911377, - "date_start": "2024-07-03T14:42:35+00:00", - "date_finish": "2024-07-03T14:42:35+00:00", - "operating_reset_at": 1720018355, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Mark file as deleted + Move file to recycle bin + + + +`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FileID = "5010"; + + Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkFileAsDeleted --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1716", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17200177547139i" + }, + "time": { + "start": 1720017755.36075, + "finish": 1720017755.40426, + "duration": 0.0435140132904053, + "processing": 0.0109550952911377, + "date_start": "2024-07-03T14:42:35+00:00", + "date_finish": "2024-07-03T14:42:35+00:00", + "operating_reset_at": 1720018355, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md index 5fe4c60de3..7d05e83abf 100644 --- a/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md +++ b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 9 ---- - -# Move file - Move file from one destination to another - - - -`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File ID | - | FolderID | --folderid | String, Number | ID of new destination folder | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) -::: -
- - -```bsl title="Code example" - FolderID = "5018"; - FileID = "5010"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID); - - FolderID = "5020"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token); - - Check_BitrixObject(Result); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MoveFileToFolder --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1716", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": 1726, - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:36+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg" - }, - "time": { - "start": 1720017764.56434, - "finish": 1720017764.63176, - "duration": 0.0674228668212891, - "processing": 0.0307409763336182, - "date_start": "2024-07-03T14:42:44+00:00", - "date_finish": "2024-07-03T14:42:44+00:00", - "operating_reset_at": 1720018364, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Move file + Move file from one destination to another + + + +`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File ID | + | FolderID | --folderid | String, Number | ID of new destination folder | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "5018"; + FileID = "5010"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID); + + FolderID = "5020"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token); + + Check_BitrixObject(Result); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MoveFileToFolder --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1716", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": 1726, + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:36+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg" + }, + "time": { + "start": 1720017764.56434, + "finish": 1720017764.63176, + "duration": 0.0674228668212891, + "processing": 0.0307409763336182, + "date_start": "2024-07-03T14:42:44+00:00", + "date_finish": "2024-07-03T14:42:44+00:00", + "operating_reset_at": 1720018364, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Rename-file.md b/docs/en/md/Bitrix24/File-managment/Rename-file.md index 1ade56f037..1971993e19 100644 --- a/docs/en/md/Bitrix24/File-managment/Rename-file.md +++ b/docs/en/md/Bitrix24/File-managment/Rename-file.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 10 ---- - -# Rename file - Changes the name of an existing file - - - -`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Name | --title | String | New folders name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New file name.jpg"; - Filename2 = "New file name 2.jpg"; - - FileID2 = "5008"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2); - - FileID = "5010"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RenameFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1716", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" - }, - "time": { - "start": 1720017754.0472, - "finish": 1720017754.09402, - "duration": 0.0468170642852783, - "processing": 0.0171689987182617, - "date_start": "2024-07-03T14:42:34+00:00", - "date_finish": "2024-07-03T14:42:34+00:00", - "operating_reset_at": 1720018354, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Rename file + Changes the name of an existing file + + + +`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New file name.jpg"; + Filename2 = "New file name 2.jpg"; + + FileID2 = "5008"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2); + + FileID = "5010"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenameFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1716", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" + }, + "time": { + "start": 1720017754.0472, + "finish": 1720017754.09402, + "duration": 0.0468170642852783, + "processing": 0.0171689987182617, + "date_start": "2024-07-03T14:42:34+00:00", + "date_finish": "2024-07-03T14:42:34+00:00", + "operating_reset_at": 1720018354, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Restore-file.md b/docs/en/md/Bitrix24/File-managment/Restore-file.md index ca7748a6d7..fbf625558a 100644 --- a/docs/en/md/Bitrix24/File-managment/Restore-file.md +++ b/docs/en/md/Bitrix24/File-managment/Restore-file.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 7 ---- - -# Restore file - Restore file from recycle bin - - - -`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FileID | --fileid | String, Number | File identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - FileID = "5010"; - - Result = OPI_Bitrix24.RestoreFile(URL, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RestoreFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "1716", - "NAME": "New file name.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:36+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" - }, - "time": { - "start": 1720017756.65038, - "finish": 1720017756.69349, - "duration": 0.0431070327758789, - "processing": 0.0107128620147705, - "date_start": "2024-07-03T14:42:36+00:00", - "date_finish": "2024-07-03T14:42:36+00:00", - "operating_reset_at": 1720018356, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Restore file + Restore file from recycle bin + + + +`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + FileID = "5010"; + + Result = OPI_Bitrix24.RestoreFile(URL, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RestoreFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "1716", + "NAME": "New file name.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:36+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg" + }, + "time": { + "start": 1720017756.65038, + "finish": 1720017756.69349, + "duration": 0.0431070327758789, + "processing": 0.0107128620147705, + "date_start": "2024-07-03T14:42:36+00:00", + "date_finish": "2024-07-03T14:42:36+00:00", + "operating_reset_at": 1720018356, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md index be2b866533..d9e3ed3a9c 100644 --- a/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md @@ -1,81 +1,81 @@ ---- -sidebar_position: 2 ---- - -# Upload file to the folder - Upload local file to the folder - - - -`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | File name with extension | - | File | --file | String, BinaryData | File for upload | - | FolderID | --folderid | String | Folder identifier | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) -::: -
- - -```bsl title="Code example" - Filename2 = "Picture2.jpg"; - Name = "Picture1.jpg"; - - Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data - Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data - - DestinationID = "5016"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UploadFileToFolder --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 1740, - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "1722", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 1142, - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:52+00:00", - "UPDATE_TIME": "2024-07-03T14:42:52+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg" - } -} -``` +--- +sidebar_position: 2 +--- + +# Upload file to the folder + Upload local file to the folder + + + +`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | FolderID | --folderid | String | Folder identifier | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = "5016"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UploadFileToFolder --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 1740, + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "1722", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 1142, + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:52+00:00", + "UPDATE_TIME": "2024-07-03T14:42:52+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg" + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md index 90b28b0416..5a5a323b8e 100644 --- a/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md @@ -1,92 +1,92 @@ ---- -sidebar_position: 1 ---- - -# Upload file to a storage - Upload file to storage root - - - -`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | File name with extension | - | File | --file | String, BinaryData | File for upload | - | StorageID | --storageid | String | Storage id | - | Rights | --rights | String | Rights array if required | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) -::: -
- - -```bsl title="Code example" - Filename2 = "Picture2.jpg"; - Name = "Picture1.jpg"; - - Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data - Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data - - DestinationID = 3; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UploadFileToStorage --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 356, - "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 404, - "SIZE": "26", - "CREATE_TIME": "2024-06-19T07:58:50+00:00", - "UPDATE_TIME": "2024-06-19T07:58:50+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" - }, - "time": { - "start": 1718783929.8197, - "finish": 1718783930.09911, - "duration": 0.279407024383545, - "processing": 0.227760076522827, - "date_start": "2024-06-19T07:58:49+00:00", - "date_finish": "2024-06-19T07:58:50+00:00", - "operating_reset_at": 1718784529, - "operating": 0.227726936340332 - } -} -``` +--- +sidebar_position: 1 +--- + +# Upload file to a storage + Upload file to storage root + + + +`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | StorageID | --storageid | String | Storage id | + | Rights | --rights | String | Rights array if required | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UploadFileToStorage --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 356, + "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 404, + "SIZE": "26", + "CREATE_TIME": "2024-06-19T07:58:50+00:00", + "UPDATE_TIME": "2024-06-19T07:58:50+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" + }, + "time": { + "start": 1718783929.8197, + "finish": 1718783930.09911, + "duration": 0.279407024383545, + "processing": 0.227760076522827, + "date_start": "2024-06-19T07:58:49+00:00", + "date_finish": "2024-06-19T07:58:50+00:00", + "operating_reset_at": 1718784529, + "operating": 0.227726936340332 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md index ce71c0e9d4..3bd001917b 100644 --- a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 1 ---- - -# Add kanban stage - Add new stage of kanban or My Plan - - - -`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | New stage name | - | Color | --color | String | HEX of new stage color | - | PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) | - | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) -::: -
- - -```bsl title="Code example" - Name = "New stage"; - Color = "0026FF"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6); - - PrevStageID = Result["result"]; - - Name = "New stage 2"; - Color = "0026FF"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID,, True, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddKanbanStage --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": 132, - "time": { - "start": 1720600360.58899, - "finish": 1720600360.679, - "duration": 0.0900149345397949, - "processing": 0.0587739944458008, - "date_start": "2024-07-10T08:32:40+00:00", - "date_finish": "2024-07-10T08:32:40+00:00", - "operating_reset_at": 1720600960, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Add kanban stage + Add new stage of kanban or My Plan + + + +`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | New stage name | + | Color | --color | String | HEX of new stage color | + | PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) | + | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
+ + +```bsl title="Code example" + Name = "New stage"; + Color = "0026FF"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6); + + PrevStageID = Result["result"]; + + Name = "New stage 2"; + Color = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID,, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddKanbanStage --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": 132, + "time": { + "start": 1720600360.58899, + "finish": 1720600360.679, + "duration": 0.0900149345397949, + "processing": 0.0587739944458008, + "date_start": "2024-07-10T08:32:40+00:00", + "date_finish": "2024-07-10T08:32:40+00:00", + "operating_reset_at": 1720600960, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md index 739ab401e6..64764946df 100644 --- a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 3 ---- - -# ID of the stage to be deleted - Removes a kanban (My Plan) stage, provided there are no tasks in it - - - -`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StageID | --stage | String, Number | ID of stage to dele | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) -::: -
- - -```bsl title="Code example" - StageID = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True); - - StageID = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteKanbanStage --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720600367.83205, - "finish": 1720600367.8709, - "duration": 0.0388522148132324, - "processing": 0.0057981014251709, - "date_start": "2024-07-10T08:32:47+00:00", - "date_finish": "2024-07-10T08:32:47+00:00", - "operating_reset_at": 1720600967, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# ID of the stage to be deleted + Removes a kanban (My Plan) stage, provided there are no tasks in it + + + +`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StageID | --stage | String, Number | ID of stage to dele | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
+ + +```bsl title="Code example" + StageID = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True); + + StageID = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteKanbanStage --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720600367.83205, + "finish": 1720600367.8709, + "duration": 0.0388522148132324, + "processing": 0.0057981014251709, + "date_start": "2024-07-10T08:32:47+00:00", + "date_finish": "2024-07-10T08:32:47+00:00", + "operating_reset_at": 1720600967, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md index c70a354858..3ec01c1649 100644 --- a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md +++ b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -1,556 +1,556 @@ ---- -sidebar_position: 4 ---- - -# Get kanban stages - Get kanban (My Plan) stages info - - - -`Function GetKanbanStages(Val URL, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | - | AsAdmin | --admin | Boolean | Allows you to get stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetKanbanStages(URL,, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetKanbanStages(URL,,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetKanbanStages --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "20": { - "ID": "20", - "TITLE": "New stage", - "SORT": "100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "NEW", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "24": { - "ID": "24", - "TITLE": "Name", - "SORT": "200", - "COLOR": "75d900", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "16": { - "ID": "16", - "TITLE": "New stage", - "SORT": "300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "18": { - "ID": "18", - "TITLE": "New stage 2", - "SORT": "400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "12": { - "ID": "12", - "TITLE": "New stage", - "SORT": "500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "14": { - "ID": "14", - "TITLE": "New stage 2", - "SORT": "600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "8": { - "ID": "8", - "TITLE": "New stage", - "SORT": "700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "10": { - "ID": "10", - "TITLE": "New stage 2", - "SORT": "800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "6": { - "ID": "6", - "TITLE": "New stage", - "SORT": "900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "130": { - "ID": "130", - "TITLE": "New stage", - "SORT": "1000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "132": { - "ID": "132", - "TITLE": "New stage 2", - "SORT": "1100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "122": { - "ID": "122", - "TITLE": "New stage", - "SORT": "1200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "124": { - "ID": "124", - "TITLE": "New stage 2", - "SORT": "1300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "120": { - "ID": "120", - "TITLE": "New stage 2", - "SORT": "1400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "114": { - "ID": "114", - "TITLE": "New stage", - "SORT": "1500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "116": { - "ID": "116", - "TITLE": "New stage 2", - "SORT": "1600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "112": { - "ID": "112", - "TITLE": "New stage 2", - "SORT": "1700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "108": { - "ID": "108", - "TITLE": "New stage 2", - "SORT": "1800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "104": { - "ID": "104", - "TITLE": "New stage 2", - "SORT": "1900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "100": { - "ID": "100", - "TITLE": "New stage 2", - "SORT": "2000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "96": { - "ID": "96", - "TITLE": "New stage 2", - "SORT": "2100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "90": { - "ID": "90", - "TITLE": "New stage", - "SORT": "2200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "92": { - "ID": "92", - "TITLE": "New stage 2", - "SORT": "2300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "74": { - "ID": "74", - "TITLE": "New stage", - "SORT": "2400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "76": { - "ID": "76", - "TITLE": "New stage 2", - "SORT": "2500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "70": { - "ID": "70", - "TITLE": "New stage", - "SORT": "2600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "72": { - "ID": "72", - "TITLE": "New stage 2", - "SORT": "2700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "66": { - "ID": "66", - "TITLE": "New stage", - "SORT": "2800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "68": { - "ID": "68", - "TITLE": "New stage 2", - "SORT": "2900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "62": { - "ID": "62", - "TITLE": "New stage", - "SORT": "3000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "64": { - "ID": "64", - "TITLE": "New stage 2", - "SORT": "3100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "46": { - "ID": "46", - "TITLE": "New stage", - "SORT": "3200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "48": { - "ID": "48", - "TITLE": "New stage 2", - "SORT": "3300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "42": { - "ID": "42", - "TITLE": "New stage", - "SORT": "3400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "44": { - "ID": "44", - "TITLE": "New stage 2", - "SORT": "3500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "38": { - "ID": "38", - "TITLE": "New stage", - "SORT": "3600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "40": { - "ID": "40", - "TITLE": "New stage 2", - "SORT": "3700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "34": { - "ID": "34", - "TITLE": "New stage", - "SORT": "3800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "36": { - "ID": "36", - "TITLE": "New stage 2", - "SORT": "3900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "2": { - "ID": "2", - "TITLE": "Not planned", - "SORT": "4000", - "COLOR": "00C4FB", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "4": { - "ID": "4", - "TITLE": "For this week", - "SORT": "4100", - "COLOR": "47D1E2", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - } - }, - "time": { - "start": 1720600362.36054, - "finish": 1720600362.39851, - "duration": 0.0379610061645508, - "processing": 0.00239396095275879, - "date_start": "2024-07-10T08:32:42+00:00", - "date_finish": "2024-07-10T08:32:42+00:00", - "operating_reset_at": 1720600962, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Get kanban stages + Get kanban (My Plan) stages info + + + +`Function GetKanbanStages(Val URL, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | EntityID | --entityid | String, Number | ID of kanban owner (group or user) | + | AsAdmin | --admin | Boolean | Allows you to get stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetKanbanStages(URL,, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetKanbanStages(URL,,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetKanbanStages --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "20": { + "ID": "20", + "TITLE": "New stage", + "SORT": "100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "NEW", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "24": { + "ID": "24", + "TITLE": "Name", + "SORT": "200", + "COLOR": "75d900", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "16": { + "ID": "16", + "TITLE": "New stage", + "SORT": "300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "18": { + "ID": "18", + "TITLE": "New stage 2", + "SORT": "400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "12": { + "ID": "12", + "TITLE": "New stage", + "SORT": "500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "14": { + "ID": "14", + "TITLE": "New stage 2", + "SORT": "600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "8": { + "ID": "8", + "TITLE": "New stage", + "SORT": "700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "10": { + "ID": "10", + "TITLE": "New stage 2", + "SORT": "800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "6": { + "ID": "6", + "TITLE": "New stage", + "SORT": "900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "130": { + "ID": "130", + "TITLE": "New stage", + "SORT": "1000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "132": { + "ID": "132", + "TITLE": "New stage 2", + "SORT": "1100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "122": { + "ID": "122", + "TITLE": "New stage", + "SORT": "1200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "124": { + "ID": "124", + "TITLE": "New stage 2", + "SORT": "1300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "120": { + "ID": "120", + "TITLE": "New stage 2", + "SORT": "1400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "114": { + "ID": "114", + "TITLE": "New stage", + "SORT": "1500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "116": { + "ID": "116", + "TITLE": "New stage 2", + "SORT": "1600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "112": { + "ID": "112", + "TITLE": "New stage 2", + "SORT": "1700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "108": { + "ID": "108", + "TITLE": "New stage 2", + "SORT": "1800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "104": { + "ID": "104", + "TITLE": "New stage 2", + "SORT": "1900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "100": { + "ID": "100", + "TITLE": "New stage 2", + "SORT": "2000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "96": { + "ID": "96", + "TITLE": "New stage 2", + "SORT": "2100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "90": { + "ID": "90", + "TITLE": "New stage", + "SORT": "2200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "92": { + "ID": "92", + "TITLE": "New stage 2", + "SORT": "2300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "74": { + "ID": "74", + "TITLE": "New stage", + "SORT": "2400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "76": { + "ID": "76", + "TITLE": "New stage 2", + "SORT": "2500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "70": { + "ID": "70", + "TITLE": "New stage", + "SORT": "2600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "72": { + "ID": "72", + "TITLE": "New stage 2", + "SORT": "2700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "66": { + "ID": "66", + "TITLE": "New stage", + "SORT": "2800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "68": { + "ID": "68", + "TITLE": "New stage 2", + "SORT": "2900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "62": { + "ID": "62", + "TITLE": "New stage", + "SORT": "3000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "64": { + "ID": "64", + "TITLE": "New stage 2", + "SORT": "3100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "46": { + "ID": "46", + "TITLE": "New stage", + "SORT": "3200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "48": { + "ID": "48", + "TITLE": "New stage 2", + "SORT": "3300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "42": { + "ID": "42", + "TITLE": "New stage", + "SORT": "3400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "44": { + "ID": "44", + "TITLE": "New stage 2", + "SORT": "3500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "38": { + "ID": "38", + "TITLE": "New stage", + "SORT": "3600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "40": { + "ID": "40", + "TITLE": "New stage 2", + "SORT": "3700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "34": { + "ID": "34", + "TITLE": "New stage", + "SORT": "3800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "36": { + "ID": "36", + "TITLE": "New stage 2", + "SORT": "3900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "2": { + "ID": "2", + "TITLE": "Not planned", + "SORT": "4000", + "COLOR": "00C4FB", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "4": { + "ID": "4", + "TITLE": "For this week", + "SORT": "4100", + "COLOR": "47D1E2", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + } + }, + "time": { + "start": 1720600362.36054, + "finish": 1720600362.39851, + "duration": 0.0379610061645508, + "processing": 0.00239396095275879, + "date_start": "2024-07-10T08:32:42+00:00", + "date_finish": "2024-07-10T08:32:42+00:00", + "operating_reset_at": 1720600962, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md index 11aa61516a..f4aae0fc61 100644 --- a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -1,70 +1,70 @@ ---- -sidebar_position: 5 ---- - -# Move task to kanban stage - Move task to another kanban stage - - - -`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task to move | - | StageID | --stage | String, Number | Stage ID | - | Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) | - | After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) -::: -
- - -```bsl title="Code example" - TaskID = "1086"; - StageID = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID); - - StageID = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID,,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MoveTaskToKanbanStage --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720600364.06058, - "finish": 1720600364.11507, - "duration": 0.0544910430908203, - "processing": 0.0175719261169434, - "date_start": "2024-07-10T08:32:44+00:00", - "date_finish": "2024-07-10T08:32:44+00:00", - "operating_reset_at": 1720600964, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Move task to kanban stage + Move task to another kanban stage + + + +`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task to move | + | StageID | --stage | String, Number | Stage ID | + | Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) | + | After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
+ + +```bsl title="Code example" + TaskID = "1086"; + StageID = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID); + + StageID = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID,,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MoveTaskToKanbanStage --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720600364.06058, + "finish": 1720600364.11507, + "duration": 0.0544910430908203, + "processing": 0.0175719261169434, + "date_start": "2024-07-10T08:32:44+00:00", + "date_finish": "2024-07-10T08:32:44+00:00", + "operating_reset_at": 1720600964, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md index bbf3bd38f8..c7edb55a00 100644 --- a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 2 ---- - -# Change kanban stage - Changes the properties of the existing kanban or My plan stage - - - -`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Name | --title | String | New stages name | - | StageID | --stage | String, Number | Stage ID for change | - | Color | --color | String | HEX of new stage color | - | PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted | - | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) -::: -
- - -```bsl title="Code example" - Name = "New stage name"; - Color = "000000"; - StageID = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color); - - Name = "New stage name 2"; - Color = "000000"; - StageID = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateKanbansStage --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720816577.57757, - "finish": 1720816577.66624, - "duration": 0.0886678695678711, - "processing": 0.059006929397583, - "date_start": "2024-07-12T20:36:17+00:00", - "date_finish": "2024-07-12T20:36:17+00:00", - "operating_reset_at": 1720817177, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Change kanban stage + Changes the properties of the existing kanban or My plan stage + + + +`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | New stages name | + | StageID | --stage | String, Number | Stage ID for change | + | Color | --color | String | HEX of new stage color | + | PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Code example" + Name = "New stage name"; + Color = "000000"; + StageID = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color); + + Name = "New stage name 2"; + Color = "000000"; + StageID = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateKanbansStage --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816577.57757, + "finish": 1720816577.66624, + "duration": 0.0886678695678711, + "processing": 0.059006929397583, + "date_start": "2024-07-12T20:36:17+00:00", + "date_finish": "2024-07-12T20:36:17+00:00", + "operating_reset_at": 1720817177, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Delete-message.md b/docs/en/md/Bitrix24/Message-management/Delete-message.md index 393d34ee84..2b2942f68f 100644 --- a/docs/en/md/Bitrix24/Message-management/Delete-message.md +++ b/docs/en/md/Bitrix24/Message-management/Delete-message.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Delete message - Deletes a dialog message - - - -`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | ID of the message to be deleted | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - MessageID = "8682"; - - Result = OPI_Bitrix24.DeleteMessage(URL, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - MessageID = "8684"; - - Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteMessage --url %url% --message %message% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969167.77137, - "finish": 1720969167.82331, - "duration": 0.051936149597168, - "processing": 0.0215229988098145, - "date_start": "2024-07-14T14:59:27+00:00", - "date_finish": "2024-07-14T14:59:27+00:00", - "operating_reset_at": 1720969767, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Delete message + Deletes a dialog message + + + +`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be deleted | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + MessageID = "8682"; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + MessageID = "8684"; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteMessage --url %url% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969167.77137, + "finish": 1720969167.82331, + "duration": 0.051936149597168, + "processing": 0.0215229988098145, + "date_start": "2024-07-14T14:59:27+00:00", + "date_finish": "2024-07-14T14:59:27+00:00", + "operating_reset_at": 1720969767, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Edit-message.md b/docs/en/md/Bitrix24/Message-management/Edit-message.md index 7724274410..7fcc2918f0 100644 --- a/docs/en/md/Bitrix24/Message-management/Edit-message.md +++ b/docs/en/md/Bitrix24/Message-management/Edit-message.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 2 ---- - -# Edit message - Edit dialog message content - - - -`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | ID of the message to be edited | - | Text | --text | String | New message text | - | Attachments | --blocks | Array of Structure | New blocks array | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - MessageID = "8682"; - - Text = "New message text"; - - Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - MessageID = "8684"; - - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); - - Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 EditMessage --url %url% --message %message% --text %text% --blocks %blocks% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969165.17314, - "finish": 1720969165.21621, - "duration": 0.0430619716644287, - "processing": 0.018265962600708, - "date_start": "2024-07-14T14:59:25+00:00", - "date_finish": "2024-07-14T14:59:25+00:00", - "operating_reset_at": 1720969765, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Edit message + Edit dialog message content + + + +`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be edited | + | Text | --text | String | New message text | + | Attachments | --blocks | Array of Structure | New blocks array | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + MessageID = "8682"; + + Text = "New message text"; + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + MessageID = "8684"; + + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 EditMessage --url %url% --message %message% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969165.17314, + "finish": 1720969165.21621, + "duration": 0.0430619716644287, + "processing": 0.018265962600708, + "date_start": "2024-07-14T14:59:25+00:00", + "date_finish": "2024-07-14T14:59:25+00:00", + "operating_reset_at": 1720969765, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-file-block.md b/docs/en/md/Bitrix24/Message-management/Get-file-block.md index 3ed6fc6b84..cb72de5521 100644 --- a/docs/en/md/Bitrix24/Message-management/Get-file-block.md +++ b/docs/en/md/Bitrix24/Message-management/Get-file-block.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 9 ---- - -# Get file block - Make file block for SendMessage method - - - -`Function GetFileBlock(Val Name, Val URL) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Picture name | - | URL | --url | String | File URL | - - - Returns: Structure - FileBlock - -
- -:::tip -Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - - - - -```sh title="CLI command example" - - oint bitrix24 GetFileBlock --title %title% --url %url% - -``` - - +--- +sidebar_position: 9 +--- + +# Get file block + Make file block for SendMessage method + + + +`Function GetFileBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | File URL | + + + Returns: Structure - FileBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="CLI command example" + + oint bitrix24 GetFileBlock --title %title% --url %url% + +``` + + diff --git a/docs/en/md/Bitrix24/Message-management/Get-picture-block.md b/docs/en/md/Bitrix24/Message-management/Get-picture-block.md index c61c052cc1..50dd39ab26 100644 --- a/docs/en/md/Bitrix24/Message-management/Get-picture-block.md +++ b/docs/en/md/Bitrix24/Message-management/Get-picture-block.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 8 ---- - -# Get picture block - Make picture block for SendMessage method - - - -`Function GetPictureBlock(Val Name, Val URL) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Name | --title | String | Picture name | - | URL | --url | String | URL of sending picture | - - - Returns: Structure - PictureBlock - -
- -:::tip -Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - - - - -```sh title="CLI command example" - - oint bitrix24 GetPictureBlock --title %title% --url %url% - -``` - - +--- +sidebar_position: 8 +--- + +# Get picture block + Make picture block for SendMessage method + + + +`Function GetPictureBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | URL of sending picture | + + + Returns: Structure - PictureBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="CLI command example" + + oint bitrix24 GetPictureBlock --title %title% --url %url% + +``` + + diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md index 456be230be..479128c688 100644 --- a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 6 ---- - -# Mark message as readed - Mark current and all previous messages as readed - - - -`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | MessageID | --message | String, Number | Id of last readed message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - MessageID = "8682"; - - Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - MessageID = "8684"; - - Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MarkMessageAsReaded --url %url% --chat %chat% --message %message% --token %token% - -``` - -```json title="Result" -{ - "result": { - "dialogId": 10, - "chatId": 10, - "lastId": 5262, - "counter": 0 - }, - "time": { - "start": 1720969157.61149, - "finish": 1720969157.65659, - "duration": 0.0451040267944336, - "processing": 0.0171201229095459, - "date_start": "2024-07-14T14:59:17+00:00", - "date_finish": "2024-07-14T14:59:17+00:00", - "operating_reset_at": 1720969757, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Mark message as readed + Mark current and all previous messages as readed + + + +`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | Id of last readed message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + MessageID = "8682"; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + MessageID = "8684"; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkMessageAsReaded --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 5262, + "counter": 0 + }, + "time": { + "start": 1720969157.61149, + "finish": 1720969157.65659, + "duration": 0.0451040267944336, + "processing": 0.0171201229095459, + "date_start": "2024-07-14T14:59:17+00:00", + "date_finish": "2024-07-14T14:59:17+00:00", + "operating_reset_at": 1720969757, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md index a372628bad..dd5b45cd7f 100644 --- a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 7 ---- - -# Mark message as unreaded - Mark current and all messages after as unreaded - - - -`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | MessageID | --message | String, Number | ID of last unreaded message | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - MessageID = "8682"; - - Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - MessageID = "8684"; - - Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MarkMessageAsUnreaded --url %url% --chat %chat% --message %message% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969158.8803, - "finish": 1720969158.91584, - "duration": 0.035538911819458, - "processing": 0.0112378597259521, - "date_start": "2024-07-14T14:59:18+00:00", - "date_finish": "2024-07-14T14:59:18+00:00", - "operating_reset_at": 1720969758, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Mark message as unreaded + Mark current and all messages after as unreaded + + + +`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | ID of last unreaded message | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + MessageID = "8682"; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + MessageID = "8684"; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkMessageAsUnreaded --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969158.8803, + "finish": 1720969158.91584, + "duration": 0.035538911819458, + "processing": 0.0112378597259521, + "date_start": "2024-07-14T14:59:18+00:00", + "date_finish": "2024-07-14T14:59:18+00:00", + "operating_reset_at": 1720969758, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-file.md b/docs/en/md/Bitrix24/Message-management/Send-file.md index 13e3e99c76..4ac984d6b0 100644 --- a/docs/en/md/Bitrix24/Message-management/Send-file.md +++ b/docs/en/md/Bitrix24/Message-management/Send-file.md @@ -1,143 +1,143 @@ ---- -sidebar_position: 5 ---- - -# Send file - Send disk file to chat - - - -`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID | - | FileID | --fileid | String, Number | File ID from UploadFileToFolder method | - | Description | --description | String | File description | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "450"; - File = "https://openintegrations.dev/test_data/document.docx"; // Binary Data, URL or path to file - Description = "Very important file"; - - Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); - FolderID = Directory["result"]["ID"]; - - UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID); - FileID = UploadedFile["result"]["ID"]; - - Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - ChatID = "452"; - - Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); - FolderID = Directory["result"]["ID"]; - - UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token); - FileID = UploadedFile["result"]["ID"]; - - Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 SendFile --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% - -``` - -```json title="Result" -{ - "result": { - "FILES": { - "upload3254": { - "id": 3254, - "chatId": 254, - "date": {}, - "type": "file", - "name": "Imortant doc.docx", - "extension": "docx", - "size": 24071, - "image": false, - "status": "done", - "progress": 100, - "authorId": 1, - "authorName": "Anton Titovets", - "urlPreview": "", - "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerAttrs": { - "viewer": null, - "viewerType": "cloud-document", - "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", - "viewerSeparateItem": true, - "viewerExtension": "im.integration.viewer", - "objectId": "3254", - "imChatId": 254, - "title": "Imortant doc.docx", - "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Save to Bitrix24 Drive\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" - } - } - }, - "DISK_ID": [ - "3254" - ], - "FILE_MODELS": { - "upload3254": { - "id": 3254, - "name": "Imortant doc.docx", - "createTime": {}, - "updateTime": {}, - "deleteTime": null, - "code": null, - "xmlId": null, - "storageId": 6, - "realObjectId": 3254, - "parentId": 3250, - "deletedType": 0, - "createdBy": "1", - "updatedBy": "1", - "deletedBy": "0", - "typeFile": 4, - "globalContentVersion": 2, - "fileId": 2330, - "size": 24071, - "etag": "1179305ea90d0b0fef106e1163deaeb8", - "links": { - "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", - "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" - } - } - }, - "MESSAGE_ID": 5346 - }, - "time": { - "start": 1720969175.0006, - "finish": 1720969175.09084, - "duration": 0.0902431011199951, - "processing": 0.0652461051940918, - "date_start": "2024-07-14T14:59:35+00:00", - "date_finish": "2024-07-14T14:59:35+00:00", - "operating_reset_at": 1720969775, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Send file + Send disk file to chat + + + +`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | FileID | --fileid | String, Number | File ID from UploadFileToFolder method | + | Description | --description | String | File description | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "450"; + File = "https://openintegrations.dev/test_data/document.docx"; // Binary Data, URL or path to file + Description = "Very important file"; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + ChatID = "452"; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendFile --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% + +``` + +```json title="Result" +{ + "result": { + "FILES": { + "upload3254": { + "id": 3254, + "chatId": 254, + "date": {}, + "type": "file", + "name": "Imortant doc.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Anton Titovets", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "3254", + "imChatId": 254, + "title": "Imortant doc.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Save to Bitrix24 Drive\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "3254" + ], + "FILE_MODELS": { + "upload3254": { + "id": 3254, + "name": "Imortant doc.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 3254, + "parentId": 3250, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 2330, + "size": 24071, + "etag": "1179305ea90d0b0fef106e1163deaeb8", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 5346 + }, + "time": { + "start": 1720969175.0006, + "finish": 1720969175.09084, + "duration": 0.0902431011199951, + "processing": 0.0652461051940918, + "date_start": "2024-07-14T14:59:35+00:00", + "date_finish": "2024-07-14T14:59:35+00:00", + "operating_reset_at": 1720969775, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-message.md b/docs/en/md/Bitrix24/Message-management/Send-message.md index 4550f68a98..a7fc433d36 100644 --- a/docs/en/md/Bitrix24/Message-management/Send-message.md +++ b/docs/en/md/Bitrix24/Message-management/Send-message.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 1 ---- - -# Send message - Send message to dialog - - - -`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | - | Text | --text | String | Message text | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - ChatID = "chat" + "450"; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); - - Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 10; - - Result = OPI_Bitrix24.SendMessage(URL, UserID, Text,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 SendMessage --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% - -``` - -```json title="Result" -{ - "result": 5342, - "time": { - "start": 1720969163.89343, - "finish": 1720969163.95538, - "duration": 0.061945915222168, - "processing": 0.0366020202636719, - "date_start": "2024-07-14T14:59:23+00:00", - "date_finish": "2024-07-14T14:59:23+00:00", - "operating_reset_at": 1720969763, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Send message + Send message to dialog + + + +`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Text | --text | String | Message text | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + ChatID = "chat" + "450"; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 10; + + Result = OPI_Bitrix24.SendMessage(URL, UserID, Text,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendMessage --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": 5342, + "time": { + "start": 1720969163.89343, + "finish": 1720969163.95538, + "duration": 0.061945915222168, + "processing": 0.0366020202636719, + "date_start": "2024-07-14T14:59:23+00:00", + "date_finish": "2024-07-14T14:59:23+00:00", + "operating_reset_at": 1720969763, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md index 68c017513d..cca66221b6 100644 --- a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md +++ b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Set message reaction - Set or remove reaction mark on the message - - - -`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | MessageID | --message | String, Number | Message ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - MessageID = "8682"; - - Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - MessageID = "8684"; - - Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 SetMessageReaction --url %url% --message %message% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720969166.51361, - "finish": 1720969166.55322, - "duration": 0.0396139621734619, - "processing": 0.0151541233062744, - "date_start": "2024-07-14T14:59:26+00:00", - "date_finish": "2024-07-14T14:59:26+00:00", - "operating_reset_at": 1720969766, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Set message reaction + Set or remove reaction mark on the message + + + +`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | Message ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + MessageID = "8682"; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + MessageID = "8684"; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SetMessageReaction --url %url% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969166.51361, + "finish": 1720969166.55322, + "duration": 0.0396139621734619, + "processing": 0.0151541233062744, + "date_start": "2024-07-14T14:59:26+00:00", + "date_finish": "2024-07-14T14:59:26+00:00", + "operating_reset_at": 1720969766, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md index 081968b1f5..6d405d2811 100644 --- a/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 1 ---- - -# Create personal notification - Creates a personal notification to the user - - - -`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --user | String, Number | User ID for sending the notification | - | Text | --text | String | Notification text | - | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) -::: -
- - -```bsl title="Code example" - UserID = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); - - Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text,,Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - Tag = "New"; - UserID = 10; - - Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% - -``` - -```json title="Result" -{ - "result": 7450, - "time": { - "start": 1722087269.44996, - "finish": 1722087269.50075, - "duration": 0.0507829189300537, - "processing": 0.0262038707733154, - "date_start": "2024-07-27T13:34:29+00:00", - "date_finish": "2024-07-27T13:34:29+00:00", - "operating_reset_at": 1722087869, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Create personal notification + Creates a personal notification to the user + + + +`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --user | String, Number | User ID for sending the notification | + | Text | --text | String | Notification text | + | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```bsl title="Code example" + UserID = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text,,Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + Tag = "New"; + UserID = 10; + + Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": 7450, + "time": { + "start": 1722087269.44996, + "finish": 1722087269.50075, + "duration": 0.0507829189300537, + "processing": 0.0262038707733154, + "date_start": "2024-07-27T13:34:29+00:00", + "date_finish": "2024-07-27T13:34:29+00:00", + "operating_reset_at": 1722087869, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md index 84a95643f4..54a1435153 100644 --- a/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md +++ b/docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 2 ---- - -# Create system notification - Creates a system notification to the user - - - -`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --user | String, Number | User ID for sending the notification | - | Text | --text | String | Notification text | - | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | - | Attachments | --blocks | Array of Structure | Array of attachments | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) -::: -
- - -```bsl title="Code example" - UserID = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Text = "Message text"; - Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Attachments = New Array; - Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); - Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); - - Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text,,Attachments); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - Tag = "New"; - UserID = 10; - - Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% - -``` - -```json title="Result" -{ - "result": 7454, - "time": { - "start": 1722087270.72466, - "finish": 1722087270.78145, - "duration": 0.0567879676818848, - "processing": 0.0293958187103272, - "date_start": "2024-07-27T13:34:30+00:00", - "date_finish": "2024-07-27T13:34:30+00:00", - "operating_reset_at": 1722087870, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Create system notification + Creates a system notification to the user + + + +`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --user | String, Number | User ID for sending the notification | + | Text | --text | String | Notification text | + | Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```bsl title="Code example" + UserID = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text,,Attachments); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + Tag = "New"; + UserID = 10; + + Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": 7454, + "time": { + "start": 1722087270.72466, + "finish": 1722087270.78145, + "duration": 0.0567879676818848, + "processing": 0.0293958187103272, + "date_start": "2024-07-27T13:34:30+00:00", + "date_finish": "2024-07-27T13:34:30+00:00", + "operating_reset_at": 1722087870, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md index 91fa802a5f..ed0aa1a8a8 100644 --- a/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md +++ b/docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Delete notification - Delete notification by ID - - - -`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | NotificationID | --notif | String, Number | Notification ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - NotificationID = "8690"; - - Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - NotificationID = "8692"; - - Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722087271.36087, - "finish": 1722087271.39818, - "duration": 0.0373120307922363, - "processing": 0.0110759735107422, - "date_start": "2024-07-27T13:34:31+00:00", - "date_finish": "2024-07-27T13:34:31+00:00", - "operating_reset_at": 1722087871, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Delete notification + Delete notification by ID + + + +`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | NotificationID | --notif | String, Number | Notification ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + NotificationID = "8690"; + + Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + NotificationID = "8692"; + + Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722087271.36087, + "finish": 1722087271.39818, + "duration": 0.0373120307922363, + "processing": 0.0110759735107422, + "date_start": "2024-07-27T13:34:31+00:00", + "date_finish": "2024-07-27T13:34:31+00:00", + "operating_reset_at": 1722087871, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md index 1870270707..b70530181e 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md +++ b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 6 ---- - -# Create folder at the storage - Create new foldera at the storage - - - -`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String | Storage ID | - | Name | --title | String | Folder name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) -::: -
- - -```bsl title="Code example" - StorageID = 3; - Name = "New catalog"; - Filename2 = "New folder 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": 574, - "NAME": "New catalog", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 574, - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-06-22T09:07:36+00:00", - "UPDATE_TIME": "2024-06-22T09:07:36+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" - }, - "time": { - "start": 1719047256.22025, - "finish": 1719047256.27758, - "duration": 0.057330846786499, - "processing": 0.0276291370391846, - "date_start": "2024-06-22T09:07:36+00:00", - "date_finish": "2024-06-22T09:07:36+00:00", - "operating_reset_at": 1719047856, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Create folder at the storage + Create new foldera at the storage + + + +`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String | Storage ID | + | Name | --title | String | Folder name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Code example" + StorageID = 3; + Name = "New catalog"; + Filename2 = "New folder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 574, + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 574, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-22T09:07:36+00:00", + "UPDATE_TIME": "2024-06-22T09:07:36+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1719047256.22025, + "finish": 1719047256.27758, + "duration": 0.057330846786499, + "processing": 0.0276291370391846, + "date_start": "2024-06-22T09:07:36+00:00", + "date_finish": "2024-06-22T09:07:36+00:00", + "operating_reset_at": 1719047856, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md index a8d567e1ef..9e672747db 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md +++ b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md @@ -1,65 +1,65 @@ ---- -sidebar_position: 2 ---- - -# Get storage for application data - Get information about storage with which the application can work to store its data - - - -`Function GetAppSotrage(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) -::: -
- - -```bsl title="Code example" - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetAppSotrage(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1721067694.96416, - "finish": 1721067694.99489, - "duration": 0.0307230949401856, - "processing": 0.00391507148742676, - "date_start": "2024-07-15T18:21:34+00:00", - "date_finish": "2024-07-15T18:21:34+00:00", - "operating_reset_at": 1721068294, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Get storage for application data + Get information about storage with which the application can work to store its data + + + +`Function GetAppSotrage(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Code example" + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetAppSotrage(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1721067694.96416, + "finish": 1721067694.99489, + "duration": 0.0307230949401856, + "processing": 0.00391507148742676, + "date_start": "2024-07-15T18:21:34+00:00", + "date_finish": "2024-07-15T18:21:34+00:00", + "operating_reset_at": 1721068294, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md index ffcc96b150..ed93164f43 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md @@ -1,105 +1,105 @@ ---- -sidebar_position: 5 ---- - -# Get a list of child storage objects - Get a list of files and folders, located at the root of the storage - - - -`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - StorageID = 3; - - Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "568", - "NAME": "Picture2.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "558", - "SIZE": "2114023", - "CREATE_TIME": "2024-06-22T09:07:30+00:00", - "UPDATE_TIME": "2024-06-22T09:07:30+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg" - }, - { - "ID": "570", - "NAME": "Picture1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "560", - "SIZE": "805189", - "CREATE_TIME": "2024-06-22T09:07:32+00:00", - "UPDATE_TIME": "2024-06-22T09:07:32+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" - } - ], - "total": 2, - "time": { - "start": 1719047253.42516, - "finish": 1719047253.47205, - "duration": 0.0468947887420654, - "processing": 0.016359806060791, - "date_start": "2024-06-22T09:07:33+00:00", - "date_finish": "2024-06-22T09:07:33+00:00", - "operating_reset_at": 1719047853, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Get a list of child storage objects + Get a list of files and folders, located at the root of the storage + + + +`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + StorageID = 3; + + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "568", + "NAME": "Picture2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "558", + "SIZE": "2114023", + "CREATE_TIME": "2024-06-22T09:07:30+00:00", + "UPDATE_TIME": "2024-06-22T09:07:30+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg" + }, + { + "ID": "570", + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "560", + "SIZE": "805189", + "CREATE_TIME": "2024-06-22T09:07:32+00:00", + "UPDATE_TIME": "2024-06-22T09:07:32+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + } + ], + "total": 2, + "time": { + "start": 1719047253.42516, + "finish": 1719047253.47205, + "duration": 0.0468947887420654, + "processing": 0.016359806060791, + "date_start": "2024-06-22T09:07:33+00:00", + "date_finish": "2024-06-22T09:07:33+00:00", + "operating_reset_at": 1719047853, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage.md index fedd107760..4f6da1ea55 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storage.md +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 3 ---- - -# Get storage - Get information about storage - - - -`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - StorageID = 3; - - Result = OPI_Bitrix24.GetStorage(URL, StorageID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "3", - "NAME": "Main drive", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - "time": { - "start": 1719047247.65416, - "finish": 1719047247.68963, - "duration": 0.0354659557342529, - "processing": 0.00417995452880859, - "date_start": "2024-06-22T09:07:27+00:00", - "date_finish": "2024-06-22T09:07:27+00:00", - "operating_reset_at": 1719047847, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Get storage + Get information about storage + + + +`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + StorageID = 3; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "3", + "NAME": "Main drive", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1719047247.65416, + "finish": 1719047247.68963, + "duration": 0.0354659557342529, + "processing": 0.00417995452880859, + "date_start": "2024-06-22T09:07:27+00:00", + "date_finish": "2024-06-22T09:07:27+00:00", + "operating_reset_at": 1719047847, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md index f970d86851..44c2becc37 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md @@ -1,125 +1,125 @@ ---- -sidebar_position: 1 ---- - -# Get list of storages - Get list of available files storages - - - -`Function GetStoragesList(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Result = OPI_Bitrix24.GetStoragesList(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetStoragesList(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "3", - "NAME": "Main drive", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - { - "ID": "1", - "NAME": "Anton Titovets", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "1", - "ROOT_OBJECT_ID": "1" - }, - { - "ID": "16", - "NAME": "iscript13@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "10", - "ROOT_OBJECT_ID": "270" - }, - { - "ID": "4", - "NAME": "Payment Processing Customer Support", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "4" - }, - { - "ID": "10", - "NAME": "CoPilot", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "4", - "ROOT_OBJECT_ID": "52" - }, - { - "ID": "12", - "NAME": "Support Bitrix24", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "6", - "ROOT_OBJECT_ID": "70" - }, - { - "ID": "14", - "NAME": "Marta", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "8", - "ROOT_OBJECT_ID": "72" - } - ], - "total": 7, - "time": { - "start": 1718783911.64028, - "finish": 1718783911.69026, - "duration": 0.0499801635742188, - "processing": 0.00660109519958496, - "date_start": "2024-06-19T07:58:31+00:00", - "date_finish": "2024-06-19T07:58:31+00:00", - "operating_reset_at": 1718784511, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Get list of storages + Get list of available files storages + + + +`Function GetStoragesList(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Result = OPI_Bitrix24.GetStoragesList(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStoragesList(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "3", + "NAME": "Main drive", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "1", + "NAME": "Anton Titovets", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Support Bitrix24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Marta", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + } + ], + "total": 7, + "time": { + "start": 1718783911.64028, + "finish": 1718783911.69026, + "duration": 0.0499801635742188, + "processing": 0.00660109519958496, + "date_start": "2024-06-19T07:58:31+00:00", + "date_finish": "2024-06-19T07:58:31+00:00", + "operating_reset_at": 1718784511, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md index 9e2f066575..39aab2e281 100644 --- a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md +++ b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 4 ---- - -# Rename storage - Change storage name (for app storage only, see. GetAppStorage) - - - -`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | StorageID | --storageid | String, Number | Storage ID | - | Name | --title | String | New storage name | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) -::: -
- - -```bsl title="Code example" - Name = "New storage name"; - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - StorageID = "18"; - - Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1719047246.29499, - "finish": 1719047246.35783, - "duration": 0.062842845916748, - "processing": 0.0317339897155762, - "date_start": "2024-06-22T09:07:26+00:00", - "date_finish": "2024-06-22T09:07:26+00:00", - "operating_reset_at": 1719047846, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Rename storage + Change storage name (for app storage only, see. GetAppStorage) + + + +`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Name | --title | String | New storage name | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New storage name"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + StorageID = "18"; + + Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1719047246.29499, + "finish": 1719047246.35783, + "duration": 0.062842845916748, + "processing": 0.0317339897155762, + "date_start": "2024-06-22T09:07:26+00:00", + "date_finish": "2024-06-22T09:07:26+00:00", + "operating_reset_at": 1719047846, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md index a4db2fd603..c75b86cb41 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 1 ---- - -# Add tasks checklist element - Adds new element of tasks checklist - - - -`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Text | --text | String | Text (title) of checklist element | - | Completed | --complete | Boolean | Mark as completed | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - - Text = "Checklist element"; - - Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text,, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddTasksChecklistElement --url %url% --task %task% --text %text% --complete %complete% --token %token% - -``` - -```json title="Result" -{ - "result": 96, - "time": { - "start": 1720816505.3041, - "finish": 1720816505.37014, - "duration": 0.0660440921783447, - "processing": 0.0380921363830566, - "date_start": "2024-07-12T20:35:05+00:00", - "date_finish": "2024-07-12T20:35:05+00:00", - "operating_reset_at": 1720817105, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Add tasks checklist element + Adds new element of tasks checklist + + + +`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Text | --text | String | Text (title) of checklist element | + | Completed | --complete | Boolean | Mark as completed | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + + Text = "Checklist element"; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddTasksChecklistElement --url %url% --task %task% --text %text% --complete %complete% --token %token% + +``` + +```json title="Result" +{ + "result": 96, + "time": { + "start": 1720816505.3041, + "finish": 1720816505.37014, + "duration": 0.0660440921783447, + "processing": 0.0380921363830566, + "date_start": "2024-07-12T20:35:05+00:00", + "date_finish": "2024-07-12T20:35:05+00:00", + "operating_reset_at": 1720817105, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md index 6c3d28b30f..8a4e47a3b7 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 6 ---- - -# Complete tasks checklist element - Mark an element as completed - - - -`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - ElementID = "396"; - - Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "1080"; - ElementID = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CompleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720816509.8981, - "finish": 1720816509.94922, - "duration": 0.0511200428009033, - "processing": 0.0246191024780273, - "date_start": "2024-07-12T20:35:09+00:00", - "date_finish": "2024-07-12T20:35:09+00:00", - "operating_reset_at": 1720817109, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Complete tasks checklist element + Mark an element as completed + + + +`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + ElementID = "396"; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "1080"; + ElementID = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CompleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816509.8981, + "finish": 1720816509.94922, + "duration": 0.0511200428009033, + "processing": 0.0246191024780273, + "date_start": "2024-07-12T20:35:09+00:00", + "date_finish": "2024-07-12T20:35:09+00:00", + "operating_reset_at": 1720817109, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md index 6b1f795ed1..d529d158ab 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 3 ---- - -# Delete tasks checklist element - Deletes element from tasks checklist - - - -`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | ID of deleted element | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - ElementID = "396"; - - Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "1080"; - ElementID = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720816512.25818, - "finish": 1720816512.30984, - "duration": 0.0516610145568848, - "processing": 0.0264489650726318, - "date_start": "2024-07-12T20:35:12+00:00", - "date_finish": "2024-07-12T20:35:12+00:00", - "operating_reset_at": 1720817112, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Delete tasks checklist element + Deletes element from tasks checklist + + + +`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | ID of deleted element | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + ElementID = "396"; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "1080"; + ElementID = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816512.25818, + "finish": 1720816512.30984, + "duration": 0.0516610145568848, + "processing": 0.0264489650726318, + "date_start": "2024-07-12T20:35:12+00:00", + "date_finish": "2024-07-12T20:35:12+00:00", + "operating_reset_at": 1720817112, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md index a2320ccfd7..9a5bdb805b 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md @@ -1,81 +1,81 @@ ---- -sidebar_position: 5 ---- - -# Get tasks checklist element - Gets tasks checklist element by ID - - - -`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - ElementID = "396"; - - Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "1080"; - ElementID = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTasksChecklistElement --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": "96", - "TASK_ID": "632", - "PARENT_ID": "94", - "CREATED_BY": "1", - "TITLE": "New elements text", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - "time": { - "start": 1720816508.81324, - "finish": 1720816508.85536, - "duration": 0.0421209335327148, - "processing": 0.0174088478088379, - "date_start": "2024-07-12T20:35:08+00:00", - "date_finish": "2024-07-12T20:35:08+00:00", - "operating_reset_at": 1720817108, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Get tasks checklist element + Gets tasks checklist element by ID + + + +`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + ElementID = "396"; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "1080"; + ElementID = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1720816508.81324, + "finish": 1720816508.85536, + "duration": 0.0421209335327148, + "processing": 0.0174088478088379, + "date_start": "2024-07-12T20:35:08+00:00", + "date_finish": "2024-07-12T20:35:08+00:00", + "operating_reset_at": 1720817108, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md index a50377a89e..4761cebd61 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md @@ -1,93 +1,93 @@ ---- -sidebar_position: 4 ---- - -# Get tasks checklist - Gets the list of elements on the task checklist - - - -`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - - Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTasksChecklist --url %url% --task %task% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "94", - "TASK_ID": "632", - "PARENT_ID": 0, - "CREATED_BY": "1", - "TITLE": "BX_CHECKLIST_1", - "SORT_INDEX": "0", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - { - "ID": "96", - "TASK_ID": "632", - "PARENT_ID": "94", - "CREATED_BY": "1", - "TITLE": "New elements text", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - } - ], - "time": { - "start": 1720816507.68937, - "finish": 1720816507.74166, - "duration": 0.0522880554199219, - "processing": 0.0231881141662598, - "date_start": "2024-07-12T20:35:07+00:00", - "date_finish": "2024-07-12T20:35:07+00:00", - "operating_reset_at": 1720817107, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Get tasks checklist + Gets the list of elements on the task checklist + + + +`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTasksChecklist --url %url% --task %task% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "94", + "TASK_ID": "632", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1720816507.68937, + "finish": 1720816507.74166, + "duration": 0.0522880554199219, + "processing": 0.0231881141662598, + "date_start": "2024-07-12T20:35:07+00:00", + "date_finish": "2024-07-12T20:35:07+00:00", + "operating_reset_at": 1720817107, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md index 6f3c10e24e..659486df93 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 7 ---- - -# Renew tasks checklist element - Unmark an element as completed - - - -`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Element ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - ElementID = "396"; - - Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID); - - TaskID = "1080"; - ElementID = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 RenewTasksChecklistElement --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1720816511.09347, - "finish": 1720816511.14508, - "duration": 0.051609992980957, - "processing": 0.0250108242034912, - "date_start": "2024-07-12T20:35:11+00:00", - "date_finish": "2024-07-12T20:35:11+00:00", - "operating_reset_at": 1720817111, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Renew tasks checklist element + Unmark an element as completed + + + +`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + ElementID = "396"; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID); + + TaskID = "1080"; + ElementID = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenewTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816511.09347, + "finish": 1720816511.14508, + "duration": 0.051609992980957, + "processing": 0.0250108242034912, + "date_start": "2024-07-12T20:35:11+00:00", + "date_finish": "2024-07-12T20:35:11+00:00", + "operating_reset_at": 1720817111, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md index f3d01d40a5..203af767e0 100644 --- a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md @@ -1,70 +1,70 @@ ---- -sidebar_position: 2 ---- - -# Update tasks checklist element - Updates text of element of tasks checklist - - - -`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | ElementID | --element | Number, String | Checklist element ID | - | Text | --text | String | Text (title) of checklist element | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - ElementID = "396"; - - Text = "New elements text"; - - Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - ElementID = "400"; - - Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateTasksChecklistElement --url %url% --task %task% --element %element% --text %text% --token %token% - -``` - -```json title="Result" -{ - "result": null, - "time": { - "start": 1720816506.52861, - "finish": 1720816506.58416, - "duration": 0.0555450916290283, - "processing": 0.027979850769043, - "date_start": "2024-07-12T20:35:06+00:00", - "date_finish": "2024-07-12T20:35:06+00:00", - "operating_reset_at": 1720817106, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Update tasks checklist element + Updates text of element of tasks checklist + + + +`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Checklist element ID | + | Text | --text | String | Text (title) of checklist element | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + ElementID = "396"; + + Text = "New elements text"; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + ElementID = "400"; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateTasksChecklistElement --url %url% --task %task% --element %element% --text %text% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816506.52861, + "finish": 1720816506.58416, + "duration": 0.0555450916290283, + "processing": 0.027979850769043, + "date_start": "2024-07-12T20:35:06+00:00", + "date_finish": "2024-07-12T20:35:06+00:00", + "operating_reset_at": 1720817106, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md index ba4e666dd0..a568f3ea15 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 6 ---- - -# Attach file to the topic - Attaches a file to the selected task - - - -`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | FileID | --fileid | Number, String | File ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - FileID = "5006"; - - Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AttachFileToTopic --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "attachmentId": 598 - }, - "time": { - "start": 1720017736.90778, - "finish": 1720017736.97555, - "duration": 0.0677700042724609, - "processing": 0.0367820262908936, - "date_start": "2024-07-03T14:42:16+00:00", - "date_finish": "2024-07-03T14:42:16+00:00", - "operating_reset_at": 1720018336, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Attach file to the topic + Attaches a file to the selected task + + + +`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | FileID | --fileid | Number, String | File ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + FileID = "5006"; + + Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AttachFileToTopic --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "attachmentId": 598 + }, + "time": { + "start": 1720017736.90778, + "finish": 1720017736.97555, + "duration": 0.0677700042724609, + "processing": 0.0367820262908936, + "date_start": "2024-07-03T14:42:16+00:00", + "date_finish": "2024-07-03T14:42:16+00:00", + "operating_reset_at": 1720018336, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md index b6b24b335e..3bba18fc96 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -1,128 +1,128 @@ ---- -sidebar_position: 20 ---- - -# Check task acesses for users - Checks the availability of the task for users - - - -`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Users | --users | Array of String | User IDs for access checking | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) -::: -
- - -```bsl title="Code example" - ArrayOfUsers = New Array; - ArrayOfUsers.Add("1"); - ArrayOfUsers.Add("10"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - - Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CheckTaskAccesses --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "allowedActions": { - "1": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": true, - "EDIT": true, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": true, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": true, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": true, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": true, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - }, - "10": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": false, - "EDIT": false, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": false, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": false, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": false, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": false, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - } - } - }, - "time": { - "start": 1720017732.79312, - "finish": 1720017732.85673, - "duration": 0.0636129379272461, - "processing": 0.0308799743652344, - "date_start": "2024-07-03T14:42:12+00:00", - "date_finish": "2024-07-03T14:42:12+00:00", - "operating_reset_at": 1720018332, - "operating": 0 - } -} -``` +--- +sidebar_position: 20 +--- + +# Check task acesses for users + Checks the availability of the task for users + + + +`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Users | --users | Array of String | User IDs for access checking | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
+ + +```bsl title="Code example" + ArrayOfUsers = New Array; + ArrayOfUsers.Add("1"); + ArrayOfUsers.Add("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + + Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CheckTaskAccesses --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "allowedActions": { + "1": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": true, + "EDIT": true, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": true, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": true, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": true, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": true, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + }, + "10": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": false, + "EDIT": false, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": false, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": false, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": false, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": false, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + } + } + }, + "time": { + "start": 1720017732.79312, + "finish": 1720017732.85673, + "duration": 0.0636129379272461, + "processing": 0.0308799743652344, + "date_start": "2024-07-03T14:42:12+00:00", + "date_finish": "2024-07-03T14:42:12+00:00", + "operating_reset_at": 1720018332, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md index c3b5f9446e..a3ac8522a3 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 23 ---- - -# Create tasks dependencies - Creates the dependency of one task to another - - - -`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FromID | --taskfrom | String, Number | From task ID | - | DestinationID | --taskto | String, Number | To task ID | - | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) -::: -
- - -```bsl title="Code example" - FromID = "1078"; - DestinationID = "1080"; - LinkType = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType); - - FromID = "1080"; - DestinationID = "1078"; - LinkType = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateTasksDependencies --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": [], - "time": { - "start": 1720186655.56394, - "finish": 1720186656.29235, - "duration": 0.728404998779297, - "processing": 0.692660093307495, - "date_start": "2024-07-05T13:37:35+00:00", - "date_finish": "2024-07-05T13:37:36+00:00", - "operating_reset_at": 1720187255, - "operating": 0.692637920379639 - } -} -``` +--- +sidebar_position: 23 +--- + +# Create tasks dependencies + Creates the dependency of one task to another + + + +`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FromID | --taskfrom | String, Number | From task ID | + | DestinationID | --taskto | String, Number | To task ID | + | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
+ + +```bsl title="Code example" + FromID = "1078"; + DestinationID = "1080"; + LinkType = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType); + + FromID = "1080"; + DestinationID = "1078"; + LinkType = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateTasksDependencies --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [], + "time": { + "start": 1720186655.56394, + "finish": 1720186656.29235, + "duration": 0.728404998779297, + "processing": 0.692660093307495, + "date_start": "2024-07-05T13:37:35+00:00", + "date_finish": "2024-07-05T13:37:36+00:00", + "operating_reset_at": 1720187255, + "operating": 0.692637920379639 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md index 2ddd818a6c..725ed6296c 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 24 ---- - -# Delete tasks dependencies - Removes the dependency of one task to another - - - -`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FromID | --taskfrom | String, Number | From task ID | - | DestinationID | --taskto | String, Number | To task ID | - | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) -::: -
- - - - - -```sh title="CLI command example" - - oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% - -``` - -```json title="Result" -{ - "result": [], - "time": { - "start": 1720816479.3837, - "finish": 1720816479.41872, - "duration": 0.0350160598754883, - "processing": 0.00787091255187988, - "date_start": "2024-07-12T20:34:39+00:00", - "date_finish": "2024-07-12T20:34:39+00:00", - "operating_reset_at": 1720817079, - "operating": 0 - } -} -``` +--- +sidebar_position: 24 +--- + +# Delete tasks dependencies + Removes the dependency of one task to another + + + +`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FromID | --taskfrom | String, Number | From task ID | + | DestinationID | --taskto | String, Number | To task ID | + | LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
+ + + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% + +``` + +```json title="Result" +{ + "result": [], + "time": { + "start": 1720816479.3837, + "finish": 1720816479.41872, + "duration": 0.0350160598754883, + "processing": 0.00787091255187988, + "date_start": "2024-07-12T20:34:39+00:00", + "date_finish": "2024-07-12T20:34:39+00:00", + "operating_reset_at": 1720817079, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md index bb34f75c61..f48c3d80de 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 25 ---- - -# Get users daily tasks plan - Gets the task plan for the current users day - - - -`Function GetDailyPlan(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetDailyPlan(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetDailyPlan(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetDailyPlan --url %url% --token %token% - -``` - -```json title="Result" -{ - "result": [], - "time": { - "start": 1720816513.42336, - "finish": 1720816513.45192, - "duration": 0.0285580158233643, - "processing": 0.000265121459960938, - "date_start": "2024-07-12T20:35:13+00:00", - "date_finish": "2024-07-12T20:35:13+00:00", - "operating_reset_at": 1720817113, - "operating": 0 - } -} -``` +--- +sidebar_position: 25 +--- + +# Get users daily tasks plan + Gets the task plan for the current users day + + + +`Function GetDailyPlan(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetDailyPlan(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetDailyPlan(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetDailyPlan --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": [], + "time": { + "start": 1720816513.42336, + "finish": 1720816513.45192, + "duration": 0.0285580158233643, + "processing": 0.000265121459960938, + "date_start": "2024-07-12T20:35:13+00:00", + "date_finish": "2024-07-12T20:35:13+00:00", + "operating_reset_at": 1720817113, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md index 15dd4113e7..ae3db4edc8 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md @@ -1,194 +1,194 @@ ---- -sidebar_position: 21 ---- - -# Mute task - Mute task by ID - - - -`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - - Result = OPI_Bitrix24.MuteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 MuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "task": { - "id": "290", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T14:41:38+00:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-07-03T14:41:45+00:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-07-03T14:41:38+00:00", - "dateStart": null, - "deadline": "2024-07-04T14:41:00+00:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "2", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "Y", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T14:41:45+00:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Anton Titovets", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Anton Titovets", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1720017708.44201, - "finish": 1720017708.51044, - "duration": 0.0684309005737305, - "processing": 0.0346000194549561, - "date_start": "2024-07-03T14:41:48+00:00", - "date_finish": "2024-07-03T14:41:48+00:00", - "operating_reset_at": 1720018308, - "operating": 0 - } -} -``` +--- +sidebar_position: 21 +--- + +# Mute task + Mute task by ID + + + +`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + + Result = OPI_Bitrix24.MuteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "task": { + "id": "290", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T14:41:38+00:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-07-03T14:41:45+00:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-07-03T14:41:38+00:00", + "dateStart": null, + "deadline": "2024-07-04T14:41:00+00:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "2", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "Y", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T14:41:45+00:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Anton Titovets", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Anton Titovets", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1720017708.44201, + "finish": 1720017708.51044, + "duration": 0.0684309005737305, + "processing": 0.0346000194549561, + "date_start": "2024-07-03T14:41:48+00:00", + "date_finish": "2024-07-03T14:41:48+00:00", + "operating_reset_at": 1720018308, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md index f040419b3b..1f5227e504 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -1,194 +1,194 @@ ---- -sidebar_position: 22 ---- - -# Unmute task - Unmute task by ID - - - -`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | Number, String | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1078"; - - Result = OPI_Bitrix24.UnmuteTask(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - TaskID = "1080"; - - Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UnmuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Result" -{ - "result": { - "task": { - "id": "290", - "parentId": null, - "title": "Another task title", - "description": "Another task description", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T14:41:38+00:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-07-03T14:41:45+00:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-07-03T14:41:38+00:00", - "dateStart": null, - "deadline": "2024-07-04T14:41:00+00:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "2", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T14:41:45+00:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Anton Titovets", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Anton Titovets", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1720017709.85465, - "finish": 1720017709.91481, - "duration": 0.0601639747619629, - "processing": 0.0304751396179199, - "date_start": "2024-07-03T14:41:49+00:00", - "date_finish": "2024-07-03T14:41:49+00:00", - "operating_reset_at": 1720018309, - "operating": 0 - } -} -``` +--- +sidebar_position: 22 +--- + +# Unmute task + Unmute task by ID + + + +`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1078"; + + Result = OPI_Bitrix24.UnmuteTask(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + TaskID = "1080"; + + Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UnmuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "task": { + "id": "290", + "parentId": null, + "title": "Another task title", + "description": "Another task description", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T14:41:38+00:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-07-03T14:41:45+00:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-07-03T14:41:38+00:00", + "dateStart": null, + "deadline": "2024-07-04T14:41:00+00:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "2", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T14:41:45+00:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Anton Titovets", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Anton Titovets", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1720017709.85465, + "finish": 1720017709.91481, + "duration": 0.0601639747619629, + "processing": 0.0304751396179199, + "date_start": "2024-07-03T14:41:49+00:00", + "date_finish": "2024-07-03T14:41:49+00:00", + "operating_reset_at": 1720018309, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md index 7c00454969..8c2c4f819d 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md +++ b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 1 ---- - -# Add task time accounting - Adds information about the user's time spent to the task - - - -`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task for time accounting | - | Time | --amount | String, Number | Time spent in seconds | - | UserID | --user | String, Number | ID of user for time accounting | - | Text | --text | String | Comment text | - | SetupDate | --date | String | Date the record was set | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1088"; - - Time = 3600; - - Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Text = "Time spent on work"; - UserID = 10; - Time = 7200; - SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); - - Result = OPI_Bitrix24.AddTaskTimeAccounting(URL -, TaskID -, Time -, UserID -, Text -, SetupDate -, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 AddTaskTimeAccounting --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% - -``` - -```json title="Result" -{ - "result": 42, - "time": { - "start": 1720816582.16849, - "finish": 1720816582.22964, - "duration": 0.0611569881439209, - "processing": 0.0315871238708496, - "date_start": "2024-07-12T20:36:22+00:00", - "date_finish": "2024-07-12T20:36:22+00:00", - "operating_reset_at": 1720817182, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Add task time accounting + Adds information about the user's time spent to the task + + + +`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | Time | --amount | String, Number | Time spent in seconds | + | UserID | --user | String, Number | ID of user for time accounting | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1088"; + + Time = 3600; + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Text = "Time spent on work"; + UserID = 10; + Time = 7200; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL +, TaskID +, Time +, UserID +, Text +, SetupDate +, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddTaskTimeAccounting --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% + +``` + +```json title="Result" +{ + "result": 42, + "time": { + "start": 1720816582.16849, + "finish": 1720816582.22964, + "duration": 0.0611569881439209, + "processing": 0.0315871238708496, + "date_start": "2024-07-12T20:36:22+00:00", + "date_finish": "2024-07-12T20:36:22+00:00", + "operating_reset_at": 1720817182, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md index 0f8802badf..21dd5de45b 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md +++ b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 2 ---- - -# Delete task time accounting - Deletes record of time accounting - - - -`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | ID of task for time accounting | - | RecordID | --record | String, Number | Time record ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1088"; - RecordID = "306"; - - Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - RecordID = "308"; - - Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 DeleteTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% - -``` - -```json title="Result" -{ - "result": null, - "time": { - "start": 1720816586.91135, - "finish": 1720816586.96255, - "duration": 0.0512039661407471, - "processing": 0.0238111019134522, - "date_start": "2024-07-12T20:36:26+00:00", - "date_finish": "2024-07-12T20:36:26+00:00", - "operating_reset_at": 1720817186, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Delete task time accounting + Deletes record of time accounting + + + +`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1088"; + RecordID = "306"; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + RecordID = "308"; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816586.91135, + "finish": 1720816586.96255, + "duration": 0.0512039661407471, + "processing": 0.0238111019134522, + "date_start": "2024-07-12T20:36:26+00:00", + "date_finish": "2024-07-12T20:36:26+00:00", + "operating_reset_at": 1720817186, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md index b5e3f36b1d..259fbaa21c 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 3 ---- - -# Get task time accounting list - Get list of time accounting records for task - - - -`Function GetTaskTimeAccountingList(Val URL, Val TaskID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1088"; - - Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTaskTimeAccountingList --url %url% --task %task% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "40", - "TASK_ID": "638", - "USER_ID": "1", - "COMMENT_TEXT": "", - "SECONDS": "3600", - "MINUTES": "60", - "SOURCE": "2", - "CREATED_DATE": "2024-07-12T20:36:21+00:00", - "DATE_START": "2024-07-12T20:36:21+00:00", - "DATE_STOP": "2024-07-12T20:36:21+00:00" - }, - { - "ID": "42", - "TASK_ID": "638", - "USER_ID": "10", - "COMMENT_TEXT": "Time spent on work", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-06-12T17:36:21+00:00", - "DATE_START": "2024-07-12T20:36:22+00:00", - "DATE_STOP": "2024-07-12T20:36:22+00:00" - } - ], - "total": 2, - "time": { - "start": 1720816584.48831, - "finish": 1720816584.5364, - "duration": 0.0480880737304688, - "processing": 0.0219790935516357, - "date_start": "2024-07-12T20:36:24+00:00", - "date_finish": "2024-07-12T20:36:24+00:00", - "operating_reset_at": 1720817184, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Get task time accounting list + Get list of time accounting records for task + + + +`Function GetTaskTimeAccountingList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1088"; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskTimeAccountingList --url %url% --task %task% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "40", + "TASK_ID": "638", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-07-12T20:36:21+00:00", + "DATE_START": "2024-07-12T20:36:21+00:00", + "DATE_STOP": "2024-07-12T20:36:21+00:00" + }, + { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + } + ], + "total": 2, + "time": { + "start": 1720816584.48831, + "finish": 1720816584.5364, + "duration": 0.0480880737304688, + "processing": 0.0219790935516357, + "date_start": "2024-07-12T20:36:24+00:00", + "date_finish": "2024-07-12T20:36:24+00:00", + "operating_reset_at": 1720817184, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md index 1505f9c7f3..fee29aefbb 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md @@ -1,77 +1,77 @@ ---- -sidebar_position: 4 ---- - -# Get task time accounting - Get time accounting record data - - - -`Function GetTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | RecordID | --record | String, Number | Time record ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1088"; - RecordID = "306"; - - Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - RecordID = "308"; - - Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": "42", - "TASK_ID": "638", - "USER_ID": "10", - "COMMENT_TEXT": "Time spent on work", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-06-12T17:36:21+00:00", - "DATE_START": "2024-07-12T20:36:22+00:00", - "DATE_STOP": "2024-07-12T20:36:22+00:00" - }, - "time": { - "start": 1720816583.31997, - "finish": 1720816583.36716, - "duration": 0.0471861362457275, - "processing": 0.0187540054321289, - "date_start": "2024-07-12T20:36:23+00:00", - "date_finish": "2024-07-12T20:36:23+00:00", - "operating_reset_at": 1720817183, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Get task time accounting + Get time accounting record data + + + +`Function GetTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1088"; + RecordID = "306"; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + RecordID = "308"; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + }, + "time": { + "start": 1720816583.31997, + "finish": 1720816583.36716, + "duration": 0.0471861362457275, + "processing": 0.0187540054321289, + "date_start": "2024-07-12T20:36:23+00:00", + "date_finish": "2024-07-12T20:36:23+00:00", + "operating_reset_at": 1720817183, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md index 82a818fdd6..2f84e8a983 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 10 ---- - -# Get timekeeping settings - Gets user timekeeping settings - - - -`Function GetTimekeepingSettings(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetTimekeepingSettings(URL); - - Hour = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.GetTimekeepingSettings(URL, UserID); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTimekeepingSettings --url %url% --userid %userid% --token %token% - -``` - -```json title="Result" -{ - "result": { - "UF_TIMEMAN": true, - "UF_TM_FREE": false, - "UF_TM_MAX_START": "09:15:00", - "UF_TM_MIN_FINISH": "17:45:00", - "UF_TM_MIN_DURATION": "08:00:00", - "UF_TM_ALLOWED_DELTA": "00:15:00", - "ADMIN": true - }, - "time": { - "start": 1722332243.86487, - "finish": 1722332243.88732, - "duration": 0.0224521160125732, - "processing": 0.00417494773864746, - "date_start": "2024-07-30T09:37:23+00:00", - "date_finish": "2024-07-30T09:37:23+00:00", - "operating_reset_at": 1722332843, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Get timekeeping settings + Gets user timekeeping settings + + + +`Function GetTimekeepingSettings(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetTimekeepingSettings(URL); + + Hour = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.GetTimekeepingSettings(URL, UserID); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTimekeepingSettings --url %url% --userid %userid% --token %token% + +``` + +```json title="Result" +{ + "result": { + "UF_TIMEMAN": true, + "UF_TM_FREE": false, + "UF_TM_MAX_START": "09:15:00", + "UF_TM_MIN_FINISH": "17:45:00", + "UF_TM_MIN_DURATION": "08:00:00", + "UF_TM_ALLOWED_DELTA": "00:15:00", + "ADMIN": true + }, + "time": { + "start": 1722332243.86487, + "finish": 1722332243.88732, + "duration": 0.0224521160125732, + "processing": 0.00417494773864746, + "date_start": "2024-07-30T09:37:23+00:00", + "date_finish": "2024-07-30T09:37:23+00:00", + "operating_reset_at": 1722332843, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md index 7785ee7ac8..09225e85c7 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md +++ b/docs/en/md/Bitrix24/Timekeeping/Get-timekeeping-status.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 9 ---- - -# Get timekeeping status - Gets user timekeeping status - - - -`Function GetTimekeepingStatus(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetTimekeepingStatus(URL); - - Hour = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.GetTimekeepingStatus(URL, UserID); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetTimekeepingStatus --url %url% --userid %userid% --token %token% - -``` - -```json title="Result" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328322.65261, - "finish": 1722328322.6837, - "duration": 0.0310959815979004, - "processing": 0.00899505615234375, - "date_start": "2024-07-30T08:32:02+00:00", - "date_finish": "2024-07-30T08:32:02+00:00", - "operating_reset_at": 1722328922, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Get timekeeping status + Gets user timekeeping status + + + +`Function GetTimekeepingStatus(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetTimekeepingStatus(URL); + + Hour = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.GetTimekeepingStatus(URL, UserID); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTimekeepingStatus --url %url% --userid %userid% --token %token% + +``` + +```json title="Result" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328322.65261, + "finish": 1722328322.6837, + "duration": 0.0310959815979004, + "processing": 0.00899505615234375, + "date_start": "2024-07-30T08:32:02+00:00", + "date_finish": "2024-07-30T08:32:02+00:00", + "operating_reset_at": 1722328922, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md index c76bbf74dc..dd2ded20e3 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md +++ b/docs/en/md/Bitrix24/Timekeeping/Pause-timekeeping.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 8 ---- - -# Stop timekeeping - Pauses user timekeeping - - - -`Function PauseTimekeeping(Val URL, Val UserID = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.PauseTimekeeping(URL); - - Hour = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 1; - - Result = OPI_Bitrix24.PauseTimekeeping(URL, UserID); -``` - - - -```sh title="CLI command example" - - oint bitrix24 PauseTimekeeping --url %url% --userid %userid% --token %token% - -``` - -```json title="Result" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328320.91942, - "finish": 1722328320.98461, - "duration": 0.0651938915252686, - "processing": 0.0352118015289307, - "date_start": "2024-07-30T08:32:00+00:00", - "date_finish": "2024-07-30T08:32:00+00:00", - "operating_reset_at": 1722328920, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Stop timekeeping + Pauses user timekeeping + + + +`Function PauseTimekeeping(Val URL, Val UserID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.PauseTimekeeping(URL); + + Hour = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 1; + + Result = OPI_Bitrix24.PauseTimekeeping(URL, UserID); +``` + + + +```sh title="CLI command example" + + oint bitrix24 PauseTimekeeping --url %url% --userid %userid% --token %token% + +``` + +```json title="Result" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328320.91942, + "finish": 1722328320.98461, + "duration": 0.0651938915252686, + "processing": 0.0352118015289307, + "date_start": "2024-07-30T08:32:00+00:00", + "date_finish": "2024-07-30T08:32:00+00:00", + "operating_reset_at": 1722328920, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md index 6513988a48..2954445e4b 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md +++ b/docs/en/md/Bitrix24/Timekeeping/Start-timekeeping.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 6 ---- - -# Start timekeeping - Starts user timekeeping - - - -`Function StartTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Time | --time | Date | Start time. The date must match the current. Current time by default. | - | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.StartTimekeeping(URL); - - Hour = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 1; - Time = OPI_Tools.GetCurrentDate() - Hour; - Report = "Late"; - - Result = OPI_Bitrix24.StartTimekeeping(URL, UserID, Time, Report, ); -``` - - - -```sh title="CLI command example" - - oint bitrix24 StartTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token% - -``` - -```json title="Result" -{ - "result": { - "STATUS": "OPENED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": null, - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "93.125.42.204", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328319.21856, - "finish": 1722328319.25781, - "duration": 0.0392520427703857, - "processing": 0.014214038848877, - "date_start": "2024-07-30T08:31:59+00:00", - "date_finish": "2024-07-30T08:31:59+00:00", - "operating_reset_at": 1722328919, - "operating": 0.181692123413086 - } -} -``` +--- +sidebar_position: 6 +--- + +# Start timekeeping + Starts user timekeeping + + + +`Function StartTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Time | --time | Date | Start time. The date must match the current. Current time by default. | + | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.StartTimekeeping(URL); + + Hour = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 1; + Time = OPI_Tools.GetCurrentDate() - Hour; + Report = "Late"; + + Result = OPI_Bitrix24.StartTimekeeping(URL, UserID, Time, Report, ); +``` + + + +```sh title="CLI command example" + + oint bitrix24 StartTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Result" +{ + "result": { + "STATUS": "OPENED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": null, + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "93.125.42.204", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328319.21856, + "finish": 1722328319.25781, + "duration": 0.0392520427703857, + "processing": 0.014214038848877, + "date_start": "2024-07-30T08:31:59+00:00", + "date_finish": "2024-07-30T08:31:59+00:00", + "operating_reset_at": 1722328919, + "operating": 0.181692123413086 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md index 62c63b141f..2147a13e84 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md +++ b/docs/en/md/Bitrix24/Timekeeping/Stop-timekeeping.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 7 ---- - -# Stop timekeeping - Stops user timekeeping - - - -`Function StopTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | Users ID. Current by default | - | Time | --time | Date | Stop time. The date must match the current. Current time by default. | - | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.StopTimekeeping(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = 1; - Time = OPI_Tools.GetCurrentDate(); - Report = "Time off"; - - Result = OPI_Bitrix24.StopTimekeeping(URL, UserID, Time, Report, ); -``` - - - -```sh title="CLI command example" - - oint bitrix24 StopTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token% - -``` - -```json title="Result" -{ - "error": "WRONG_DATETIME_FORMAT", - "error_description": "Wrong datetime format" -} -``` +--- +sidebar_position: 7 +--- + +# Stop timekeeping + Stops user timekeeping + + + +`Function StopTimekeeping(Val URL, Val UserID = "", Val Time = "", Val Report = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | Users ID. Current by default | + | Time | --time | Date | Stop time. The date must match the current. Current time by default. | + | Report | --report | String | Reason for change. Required when Time is specified and free schedule is disabled | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.StopTimekeeping(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = 1; + Time = OPI_Tools.GetCurrentDate(); + Report = "Time off"; + + Result = OPI_Bitrix24.StopTimekeeping(URL, UserID, Time, Report, ); +``` + + + +```sh title="CLI command example" + + oint bitrix24 StopTimekeeping --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Result" +{ + "error": "WRONG_DATETIME_FORMAT", + "error_description": "Wrong datetime format" +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md index 5d9c03ec3c..ca4edaf33c 100644 --- a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md +++ b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 5 ---- - -# Update task time accounting - Update time accounting record data - - - -`Function UpdateTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Time, Val Text = "", Val SetupDate = "", Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | TaskID | --task | String, Number | Task ID | - | RecordID | --record | String, Number | Time record ID | - | Time | --amount | String, Number | Time spent in seconds | - | Text | --text | String | Comment text | - | SetupDate | --date | String | Date the record was set | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - TaskID = "1088"; - RecordID = "306"; - - Text = "The text I forgot last time"; - Time = 4800; - - Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL, TaskID, RecordID, Time, Text); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - RecordID = "308"; - - Text = "New time record"; - Time = 4800; - SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); - - Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL -, TaskID -, RecordID -, Time -, Text -, SetupDate -, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateTaskTimeAccounting --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% - -``` - -```json title="Result" -{ - "result": null, - "time": { - "start": 1720816585.70407, - "finish": 1720816585.77088, - "duration": 0.0668020248413086, - "processing": 0.0276288986206055, - "date_start": "2024-07-12T20:36:25+00:00", - "date_finish": "2024-07-12T20:36:25+00:00", - "operating_reset_at": 1720817185, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Update task time accounting + Update time accounting record data + + + +`Function UpdateTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Time, Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Time | --amount | String, Number | Time spent in seconds | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + TaskID = "1088"; + RecordID = "306"; + + Text = "The text I forgot last time"; + Time = 4800; + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL, TaskID, RecordID, Time, Text); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + RecordID = "308"; + + Text = "New time record"; + Time = 4800; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL +, TaskID +, RecordID +, Time +, Text +, SetupDate +, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateTaskTimeAccounting --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816585.70407, + "finish": 1720816585.77088, + "duration": 0.0668020248413086, + "processing": 0.0276288986206055, + "date_start": "2024-07-12T20:36:25+00:00", + "date_finish": "2024-07-12T20:36:25+00:00", + "operating_reset_at": 1720817185, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Change-user-status.md b/docs/en/md/Bitrix24/Users-managment/Change-user-status.md index be61d3737c..e4f8ccbe76 100644 --- a/docs/en/md/Bitrix24/Users-managment/Change-user-status.md +++ b/docs/en/md/Bitrix24/Users-managment/Change-user-status.md @@ -1,62 +1,62 @@ ---- -sidebar_position: 5 ---- - -# Change user status - Activates or deactivates (fire) the selected user - - - -`Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | Fire | --fire | Boolean | True > Deactivation, False > Activation | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- - - - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - UserID = "78"; - - Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = "80"; - - Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 ChangeUserStatus --url %url% --userid %userid% --fire %fire% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722328399.68494, - "finish": 1722328399.94913, - "duration": 0.264194965362549, - "processing": 0.229634046554565, - "date_start": "2024-07-30T08:33:19+00:00", - "date_finish": "2024-07-30T08:33:19+00:00", - "operating_reset_at": 1722328999, - "operating": 0.5396409034729 - } -} -``` +--- +sidebar_position: 5 +--- + +# Change user status + Activates or deactivates (fire) the selected user + + + +`Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | Fire | --fire | Boolean | True > Deactivation, False > Activation | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ + + + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + UserID = "78"; + + Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = "80"; + + Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeUserStatus --url %url% --userid %userid% --fire %fire% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722328399.68494, + "finish": 1722328399.94913, + "duration": 0.264194965362549, + "processing": 0.229634046554565, + "date_start": "2024-07-30T08:33:19+00:00", + "date_finish": "2024-07-30T08:33:19+00:00", + "operating_reset_at": 1722328999, + "operating": 0.5396409034729 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Create-user.md b/docs/en/md/Bitrix24/Users-managment/Create-user.md index 84fa830135..3d3a62d415 100644 --- a/docs/en/md/Bitrix24/Users-managment/Create-user.md +++ b/docs/en/md/Bitrix24/Users-managment/Create-user.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 3 ---- - -# Create user - Create new user by fields structure - - - -`Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) - - If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...] - - If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...] -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Email = String(New UUID) + "@exepmple.org"; - // The full structure can be obtained with the function GetUserFieldsStructure - - UserStructure = New Structure; - UserStructure.Insert("EMAIL", Email); - UserStructure.Insert("UF_DEPARTMENT", 7); - - Result = OPI_Bitrix24.CreateUser(URL, UserStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - Email = String(New UUID) + "@exepmple.org"; - - UserStructure = New Structure; - UserStructure.Insert("EMAIL", Email); - UserStructure.Insert("NAME", "Vitaly"); - UserStructure.Insert("LAST_NAME", "Alpaca"); - UserStructure.Insert("PERSONAL_MOBILE", "88003553535"); - UserStructure.Insert("UF_DEPARTMENT", 1); - - Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 CreateUser --url %url% --fields %fields% --token %token% - -``` - -```json title="Result" -{ - "result": 60, - "time": { - "start": 1722328388.80414, - "finish": 1722328391.95472, - "duration": 3.15058398246765, - "processing": 3.02733707427978, - "date_start": "2024-07-30T08:33:08+00:00", - "date_finish": "2024-07-30T08:33:11+00:00", - "operating_reset_at": 1722328988, - "operating": 3.0273129940033 - } -} -``` +--- +sidebar_position: 3 +--- + +# Create user + Create new user by fields structure + + + +`Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) + + If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...] + + If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...] +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Email = String(New UUID) + "@exepmple.org"; + // The full structure can be obtained with the function GetUserFieldsStructure + + UserStructure = New Structure; + UserStructure.Insert("EMAIL", Email); + UserStructure.Insert("UF_DEPARTMENT", 7); + + Result = OPI_Bitrix24.CreateUser(URL, UserStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + Email = String(New UUID) + "@exepmple.org"; + + UserStructure = New Structure; + UserStructure.Insert("EMAIL", Email); + UserStructure.Insert("NAME", "Vitaly"); + UserStructure.Insert("LAST_NAME", "Alpaca"); + UserStructure.Insert("PERSONAL_MOBILE", "88003553535"); + UserStructure.Insert("UF_DEPARTMENT", 1); + + Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateUser --url %url% --fields %fields% --token %token% + +``` + +```json title="Result" +{ + "result": 60, + "time": { + "start": 1722328388.80414, + "finish": 1722328391.95472, + "duration": 3.15058398246765, + "processing": 3.02733707427978, + "date_start": "2024-07-30T08:33:08+00:00", + "date_finish": "2024-07-30T08:33:11+00:00", + "operating_reset_at": 1722328988, + "operating": 3.0273129940033 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Find-users.md b/docs/en/md/Bitrix24/Users-managment/Find-users.md index 5dd594045d..8ca2c47b3a 100644 --- a/docs/en/md/Bitrix24/Users-managment/Find-users.md +++ b/docs/en/md/Bitrix24/Users-managment/Find-users.md @@ -1,277 +1,277 @@ ---- -sidebar_position: 6 ---- - -# Find users - Gets the list of users according to the specified filter - - - -`Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | FilterStructure | --filter | Structure of KeyAndValue | Filter. See GetUserFilterStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - FilterStructure = New Structure; - FilterStructure.Insert("NAME", "Vitaly"); - FilterStructure.Insert("LAST_NAME", "Alpaca"); - FilterStructure.Insert("WORK_POSITION", "DevOps engineer"); - FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department"); - FilterStructure.Insert("USER_TYPE", "employee"); - - Result = OPI_Bitrix24.FindUsers(URL, FilterStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - FilterStructure = New Structure; - FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix"); - - Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 FindUsers --url %url% --filter %filter% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "12", - "XML_ID": "56479740", - "ACTIVE": true, - "NAME": "Bay", - "LAST_NAME": "Selonarrend", - "EMAIL": "oarismos@gmail.com", - "LAST_LOGIN": "2024-07-13T07:17:17+00:00", - "DATE_REGISTER": "2024-07-13T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "18", - "XML_ID": "56701916", - "ACTIVE": true, - "EMAIL": "hey@exepmple.com", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "34", - "XML_ID": "56702240", - "ACTIVE": false, - "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "38", - "XML_ID": "56702244", - "ACTIVE": false, - "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "42", - "XML_ID": "56702314", - "ACTIVE": true, - "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "46", - "XML_ID": "56702336", - "ACTIVE": false, - "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "50", - "XML_ID": "56702654", - "ACTIVE": false, - "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "54", - "XML_ID": "56721830", - "ACTIVE": false, - "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-29T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Anton", - "LAST_NAME": "Titovets", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-07-30T06:49:41+00:00", - "DATE_REGISTER": "2024-02-10T00:00:00+00:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ], - "USER_TYPE": "employee" - }, - { - "ID": "10", - "XML_ID": "56016490", - "ACTIVE": true, - "NAME": "Techno", - "LAST_NAME": "Pizza", - "EMAIL": "iscript13@gmail.com", - "LAST_LOGIN": "2024-07-13T14:46:11+00:00", - "DATE_REGISTER": "2024-06-15T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ], - "USER_TYPE": "employee" - }, - { - "ID": "60", - "XML_ID": "56731232", - "ACTIVE": true, - "NAME": "Vitaly", - "LAST_NAME": "Alpaca", - "EMAIL": "87394c27-0694-457e-bcc9-39ccf92ffbf7@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-30T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - } - ], - "total": 11, - "time": { - "start": 1722328393.63268, - "finish": 1722328393.68509, - "duration": 0.0524110794067383, - "processing": 0.0202820301055908, - "date_start": "2024-07-30T08:33:13+00:00", - "date_finish": "2024-07-30T08:33:13+00:00", - "operating_reset_at": 1722328993, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Find users + Gets the list of users according to the specified filter + + + +`Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FilterStructure | --filter | Structure of KeyAndValue | Filter. See GetUserFilterStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + FilterStructure = New Structure; + FilterStructure.Insert("NAME", "Vitaly"); + FilterStructure.Insert("LAST_NAME", "Alpaca"); + FilterStructure.Insert("WORK_POSITION", "DevOps engineer"); + FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department"); + FilterStructure.Insert("USER_TYPE", "employee"); + + Result = OPI_Bitrix24.FindUsers(URL, FilterStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + FilterStructure = New Structure; + FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix"); + + Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 FindUsers --url %url% --filter %filter% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "12", + "XML_ID": "56479740", + "ACTIVE": true, + "NAME": "Bay", + "LAST_NAME": "Selonarrend", + "EMAIL": "oarismos@gmail.com", + "LAST_LOGIN": "2024-07-13T07:17:17+00:00", + "DATE_REGISTER": "2024-07-13T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "18", + "XML_ID": "56701916", + "ACTIVE": true, + "EMAIL": "hey@exepmple.com", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "34", + "XML_ID": "56702240", + "ACTIVE": false, + "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "38", + "XML_ID": "56702244", + "ACTIVE": false, + "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "42", + "XML_ID": "56702314", + "ACTIVE": true, + "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "46", + "XML_ID": "56702336", + "ACTIVE": false, + "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "50", + "XML_ID": "56702654", + "ACTIVE": false, + "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "54", + "XML_ID": "56721830", + "ACTIVE": false, + "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-29T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Anton", + "LAST_NAME": "Titovets", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-07-30T06:49:41+00:00", + "DATE_REGISTER": "2024-02-10T00:00:00+00:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ], + "USER_TYPE": "employee" + }, + { + "ID": "10", + "XML_ID": "56016490", + "ACTIVE": true, + "NAME": "Techno", + "LAST_NAME": "Pizza", + "EMAIL": "iscript13@gmail.com", + "LAST_LOGIN": "2024-07-13T14:46:11+00:00", + "DATE_REGISTER": "2024-06-15T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ], + "USER_TYPE": "employee" + }, + { + "ID": "60", + "XML_ID": "56731232", + "ACTIVE": true, + "NAME": "Vitaly", + "LAST_NAME": "Alpaca", + "EMAIL": "87394c27-0694-457e-bcc9-39ccf92ffbf7@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-30T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + } + ], + "total": 11, + "time": { + "start": 1722328393.63268, + "finish": 1722328393.68509, + "duration": 0.0524110794067383, + "processing": 0.0202820301055908, + "date_start": "2024-07-30T08:33:13+00:00", + "date_finish": "2024-07-30T08:33:13+00:00", + "operating_reset_at": 1722328993, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-current-user.md b/docs/en/md/Bitrix24/Users-managment/Get-current-user.md index 22f59eef82..9613729d51 100644 --- a/docs/en/md/Bitrix24/Users-managment/Get-current-user.md +++ b/docs/en/md/Bitrix24/Users-managment/Get-current-user.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 1 ---- - -# Get current user - Get current user data - - - -`Function GetCurrentUser(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetCurrentUser(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetCurrentUser(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetCurrentUser --url %url% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Anton", - "LAST_NAME": "Titovets", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-07-30T06:49:41+00:00", - "DATE_REGISTER": "2024-02-10T00:00:00+00:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": "30.07.2024 11:32:54", - "LAST_ACTIVITY_DATE": "2024-07-30 10:04:49", - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ] - }, - "time": { - "start": 1722328382.88095, - "finish": 1722328382.91677, - "duration": 0.0358180999755859, - "processing": 0.00372004508972168, - "date_start": "2024-07-30T08:33:02+00:00", - "date_finish": "2024-07-30T08:33:02+00:00", - "operating_reset_at": 1722328982, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Get current user + Get current user data + + + +`Function GetCurrentUser(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetCurrentUser(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetCurrentUser(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetCurrentUser --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Anton", + "LAST_NAME": "Titovets", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-07-30T06:49:41+00:00", + "DATE_REGISTER": "2024-02-10T00:00:00+00:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": "30.07.2024 11:32:54", + "LAST_ACTIVITY_DATE": "2024-07-30 10:04:49", + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ] + }, + "time": { + "start": 1722328382.88095, + "finish": 1722328382.91677, + "duration": 0.0358180999755859, + "processing": 0.00372004508972168, + "date_start": "2024-07-30T08:33:02+00:00", + "date_finish": "2024-07-30T08:33:02+00:00", + "operating_reset_at": 1722328982, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md index f1a20b31bf..c3cb1b058c 100644 --- a/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-fields-structure.md @@ -1,126 +1,126 @@ ---- -sidebar_position: 7 ---- - -# Get user fields structure - Gets the field structure for creating or modifying user information - - - -`Function GetUserFieldsStructure(Val URL, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Result = OPI_Bitrix24.GetUserFieldsStructure(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - - Result = OPI_Bitrix24.GetUserFieldsStructure(URL, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetUserFieldsStructure --url %url% --token %token% - -``` - -```json title="Result" -{ - "result": { - "ID": "ID", - "XML_ID": "Innotшнandй toод", - "ACTIVE": "Аtoтandinbutwithть", - "NAME": "Name", - "LAST_NAME": "LastName", - "SECOND_NAME": "Отчеwithтinо", - "TITLE": "User list", - "EMAIL": "E-Mail", - "LAST_LOGIN": "Afterдняя аinторfromацandя", - "DATE_REGISTER": "Date регandwithтрацandand", - "TIME_ZONE": "TIME_ZONE", - "IS_ONLINE": "IS_ONLINE", - "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", - "TIMESTAMP_X": "TIMESTAMP_X", - "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", - "PERSONAL_GENDER": "Toл", - "PERSONAL_PROFESSION": "Профеwithwithandя", - "PERSONAL_WWW": "Домашняя withтранandчtoа", - "PERSONAL_BIRTHDAY": "Date рожденandя", - "PERSONAL_PHOTO": "Photoграфandя", - "PERSONAL_ICQ": "ICQ", - "PERSONAL_PHONE": "Лandчный телефон", - "PERSONAL_FAX": "Фаtowith", - "PERSONAL_MOBILE": "Лandчный мобandльный", - "PERSONAL_PAGER": "Пейджер", - "PERSONAL_STREET": "Улandца прожandinанandя", - "PERSONAL_CITY": "Город прожandinанandя", - "PERSONAL_STATE": "Region / toрай", - "PERSONAL_ZIP": "Toчтоinый andндеtowith", - "PERSONAL_COUNTRY": "Страto", - "PERSONAL_MAILBOX": "Toчтоinый ящandto", - "PERSONAL_NOTES": "Доtoлнandтельные заметtoand", - "WORK_PHONE": "Phone toомпанandand", - "WORK_COMPANY": "Kомпанandя", - "WORK_POSITION": "Shouldwithть", - "WORK_DEPARTMENT": "Отдел", - "WORK_WWW": "Website toомпанandand", - "WORK_FAX": "WORK_FAX", - "WORK_PAGER": "WORK_PAGER", - "WORK_STREET": "WORK_STREET", - "WORK_MAILBOX": "WORK_MAILBOX", - "WORK_CITY": "Город work", - "WORK_STATE": "WORK_STATE", - "WORK_ZIP": "WORK_ZIP", - "WORK_COUNTRY": "WORK_COUNTRY", - "WORK_PROFILE": "WORK_PROFILE", - "WORK_LOGO": "WORK_LOGO", - "WORK_NOTES": "WORK_NOTES", - "UF_SKYPE_LINK": "Link to чат in Skype", - "UF_ZOOM": "Zoom", - "UF_EMPLOYMENT_DATE": "Date прandнятandя to работу", - "UF_TIMEMAN": "Timekeeping", - "UF_DEPARTMENT": "Toдразделенandя", - "UF_INTERESTS": "Andнтереwithы", - "UF_SKILLS": "Nаinыtoand", - "UF_WEB_SITES": "Другandе withайты", - "UF_XING": "Xing", - "UF_LINKEDIN": "LinkedIn", - "UF_FACEBOOK": "Facebook", - "UF_TWITTER": "Twitter", - "UF_SKYPE": "Skype", - "UF_DISTRICT": "Район", - "UF_PHONE_INNER": "Inнутреннandй телефон", - "USER_TYPE": "USER_TYPE" - }, - "time": { - "start": 1722328384.61197, - "finish": 1722328384.64683, - "duration": 0.0348641872406006, - "processing": 0.000688076019287109, - "date_start": "2024-07-30T08:33:04+00:00", - "date_finish": "2024-07-30T08:33:04+00:00", - "operating_reset_at": 1722328984, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Get user fields structure + Gets the field structure for creating or modifying user information + + + +`Function GetUserFieldsStructure(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Result = OPI_Bitrix24.GetUserFieldsStructure(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetUserFieldsStructure(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetUserFieldsStructure --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "ID", + "XML_ID": "Innotшнandй toод", + "ACTIVE": "Аtoтandinbutwithть", + "NAME": "Name", + "LAST_NAME": "LastName", + "SECOND_NAME": "Отчеwithтinо", + "TITLE": "User list", + "EMAIL": "E-Mail", + "LAST_LOGIN": "Afterдняя аinторfromацandя", + "DATE_REGISTER": "Date регandwithтрацandand", + "TIME_ZONE": "TIME_ZONE", + "IS_ONLINE": "IS_ONLINE", + "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", + "TIMESTAMP_X": "TIMESTAMP_X", + "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", + "PERSONAL_GENDER": "Toл", + "PERSONAL_PROFESSION": "Профеwithwithandя", + "PERSONAL_WWW": "Домашняя withтранandчtoа", + "PERSONAL_BIRTHDAY": "Date рожденandя", + "PERSONAL_PHOTO": "Photoграфandя", + "PERSONAL_ICQ": "ICQ", + "PERSONAL_PHONE": "Лandчный телефон", + "PERSONAL_FAX": "Фаtowith", + "PERSONAL_MOBILE": "Лandчный мобandльный", + "PERSONAL_PAGER": "Пейджер", + "PERSONAL_STREET": "Улandца прожandinанandя", + "PERSONAL_CITY": "Город прожandinанandя", + "PERSONAL_STATE": "Region / toрай", + "PERSONAL_ZIP": "Toчтоinый andндеtowith", + "PERSONAL_COUNTRY": "Страto", + "PERSONAL_MAILBOX": "Toчтоinый ящandto", + "PERSONAL_NOTES": "Доtoлнandтельные заметtoand", + "WORK_PHONE": "Phone toомпанandand", + "WORK_COMPANY": "Kомпанandя", + "WORK_POSITION": "Shouldwithть", + "WORK_DEPARTMENT": "Отдел", + "WORK_WWW": "Website toомпанandand", + "WORK_FAX": "WORK_FAX", + "WORK_PAGER": "WORK_PAGER", + "WORK_STREET": "WORK_STREET", + "WORK_MAILBOX": "WORK_MAILBOX", + "WORK_CITY": "Город work", + "WORK_STATE": "WORK_STATE", + "WORK_ZIP": "WORK_ZIP", + "WORK_COUNTRY": "WORK_COUNTRY", + "WORK_PROFILE": "WORK_PROFILE", + "WORK_LOGO": "WORK_LOGO", + "WORK_NOTES": "WORK_NOTES", + "UF_SKYPE_LINK": "Link to чат in Skype", + "UF_ZOOM": "Zoom", + "UF_EMPLOYMENT_DATE": "Date прandнятandя to работу", + "UF_TIMEMAN": "Timekeeping", + "UF_DEPARTMENT": "Toдразделенandя", + "UF_INTERESTS": "Andнтереwithы", + "UF_SKILLS": "Nаinыtoand", + "UF_WEB_SITES": "Другandе withайты", + "UF_XING": "Xing", + "UF_LINKEDIN": "LinkedIn", + "UF_FACEBOOK": "Facebook", + "UF_TWITTER": "Twitter", + "UF_SKYPE": "Skype", + "UF_DISTRICT": "Район", + "UF_PHONE_INNER": "Inнутреннandй телефон", + "USER_TYPE": "USER_TYPE" + }, + "time": { + "start": 1722328384.61197, + "finish": 1722328384.64683, + "duration": 0.0348641872406006, + "processing": 0.000688076019287109, + "date_start": "2024-07-30T08:33:04+00:00", + "date_finish": "2024-07-30T08:33:04+00:00", + "operating_reset_at": 1722328984, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md index 94d8e575d1..272458abe9 100644 --- a/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md +++ b/docs/en/md/Bitrix24/Users-managment/Get-user-filter-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 8 ---- - -# Get user filter structure - Returns the field structure for filtering users in the FindUsers method - - - -`Function GetUserFilterStructure(Val Clear = False) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | - - - Returns: Structure of KeyAndValue - Fields structure - -
- - - - - - - -```sh title="CLI command example" - - oint bitrix24 GetUserFilterStructure --empty %empty% - -``` - - +--- +sidebar_position: 8 +--- + +# Get user filter structure + Returns the field structure for filtering users in the FindUsers method + + + +`Function GetUserFilterStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure of KeyAndValue - Fields structure + +
+ + + + + + + +```sh title="CLI command example" + + oint bitrix24 GetUserFilterStructure --empty %empty% + +``` + + diff --git a/docs/en/md/Bitrix24/Users-managment/Get-user.md b/docs/en/md/Bitrix24/Users-managment/Get-user.md index f686776e40..06e41dcd2d 100644 --- a/docs/en/md/Bitrix24/Users-managment/Get-user.md +++ b/docs/en/md/Bitrix24/Users-managment/Get-user.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 2 ---- - -# Get user - Gets user information by ID - - - -`Function GetUser(Val URL, Val UserID, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - UserID = "78"; - - Result = OPI_Bitrix24.GetUser(URL, UserID); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = "80"; - - Result = OPI_Bitrix24.GetUser(URL, UserID, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 GetUser --url %url% --userid %userid% --token %token% - -``` - -```json title="Result" -{ - "result": [ - { - "ID": "60", - "XML_ID": "56731232", - "ACTIVE": true, - "NAME": "Oleg", - "LAST_NAME": "Lama", - "EMAIL": "804d1dbb-7df4-4245-8266-938fc2541978@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-30T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 7 - ], - "USER_TYPE": "employee" - } - ], - "total": 1, - "time": { - "start": 1722328397.72079, - "finish": 1722328397.76914, - "duration": 0.0483510494232178, - "processing": 0.0120601654052734, - "date_start": "2024-07-30T08:33:17+00:00", - "date_finish": "2024-07-30T08:33:17+00:00", - "operating_reset_at": 1722328997, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Get user + Gets user information by ID + + + +`Function GetUser(Val URL, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + UserID = "78"; + + Result = OPI_Bitrix24.GetUser(URL, UserID); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = "80"; + + Result = OPI_Bitrix24.GetUser(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetUser --url %url% --userid %userid% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "60", + "XML_ID": "56731232", + "ACTIVE": true, + "NAME": "Oleg", + "LAST_NAME": "Lama", + "EMAIL": "804d1dbb-7df4-4245-8266-938fc2541978@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-30T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 7 + ], + "USER_TYPE": "employee" + } + ], + "total": 1, + "time": { + "start": 1722328397.72079, + "finish": 1722328397.76914, + "duration": 0.0483510494232178, + "processing": 0.0120601654052734, + "date_start": "2024-07-30T08:33:17+00:00", + "date_finish": "2024-07-30T08:33:17+00:00", + "operating_reset_at": 1722328997, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Users-managment/Update-user.md b/docs/en/md/Bitrix24/Users-managment/Update-user.md index 22d70bd9c1..ac22633bdb 100644 --- a/docs/en/md/Bitrix24/Users-managment/Update-user.md +++ b/docs/en/md/Bitrix24/Users-managment/Update-user.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 4 ---- - -# Update user - Updates user data - - - -`Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | - | UserID | --userid | String, Number | User ID | - | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | - | Token | --token | String | Access token, when app auth method used | - - - Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API - -
- -:::tip -Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - UserID = "78"; - Email = String(New UUID) + "@exepmple.org"; - - // The full structure can be obtained with the function GetUserFieldsStructure - - UserStructure = New Structure; - UserStructure.Insert("EMAIL", Email); - UserStructure.Insert("UF_DEPARTMENT", 1); - - Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure); - - URL = "b24-ar17wx.bitrix24.by"; - Token = "fe3fa966006e9f06006b12e400000001000..."; - UserID = "80"; - Email = String(New UUID) + "@exepmple.org"; - - UserStructure = New Structure; - UserStructure.Insert("EMAIL", Email); - UserStructure.Insert("NAME", "Oleg"); - UserStructure.Insert("LAST_NAME", "Lama"); - UserStructure.Insert("UF_DEPARTMENT", 7); - - Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token); -``` - - - -```sh title="CLI command example" - - oint bitrix24 UpdateUser --url %url% --userid %userid% --fields %fields% --token %token% - -``` - -```json title="Result" -{ - "result": true, - "time": { - "start": 1722328395.63697, - "finish": 1722328395.97568, - "duration": 0.338706016540527, - "processing": 0.310076951980591, - "date_start": "2024-07-30T08:33:15+00:00", - "date_finish": "2024-07-30T08:33:15+00:00", - "operating_reset_at": 1722328995, - "operating": 0.310055017471314 - } -} -``` +--- +sidebar_position: 4 +--- + +# Update user + Updates user data + + + +`Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | UserID | --userid | String, Number | User ID | + | FieldsStructure | --fields | Structure of KeyAndValue | New user data. See. GetUserFieldsStructure | + | Token | --token | String | Access token, when app auth method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + UserID = "78"; + Email = String(New UUID) + "@exepmple.org"; + + // The full structure can be obtained with the function GetUserFieldsStructure + + UserStructure = New Structure; + UserStructure.Insert("EMAIL", Email); + UserStructure.Insert("UF_DEPARTMENT", 1); + + Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure); + + URL = "b24-ar17wx.bitrix24.by"; + Token = "fe3fa966006e9f06006b12e400000001000..."; + UserID = "80"; + Email = String(New UUID) + "@exepmple.org"; + + UserStructure = New Structure; + UserStructure.Insert("EMAIL", Email); + UserStructure.Insert("NAME", "Oleg"); + UserStructure.Insert("LAST_NAME", "Lama"); + UserStructure.Insert("UF_DEPARTMENT", 7); + + Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateUser --url %url% --userid %userid% --fields %fields% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1722328395.63697, + "finish": 1722328395.97568, + "duration": 0.338706016540527, + "processing": 0.310076951980591, + "date_start": "2024-07-30T08:33:15+00:00", + "date_finish": "2024-07-30T08:33:15+00:00", + "operating_reset_at": 1722328995, + "operating": 0.310055017471314 + } +} +``` diff --git a/docs/en/md/Instructions/VKTeams.md b/docs/en/md/Instructions/VKTeams.md index 234fbb1326..bdd4072ad9 100644 --- a/docs/en/md/Instructions/VKTeams.md +++ b/docs/en/md/Instructions/VKTeams.md @@ -1,47 +1,47 @@ ---- -id: VKTeams -sidebar_class_name: VKTeams ---- - - - -# VK Teams - -This section is dedicated to the library for working with VK Teams API. On this page, all the steps necessary to start working are described - -## Getting started - -1. Register, book a tariff and download the VK Teams app [on the home page](https://biz.mail.ru/teams) - -![BF](../../static/img/Docs/VKTeams/5.png) - -2. Log in to the application using the one-time password that should arrive in the mail. You can view the mail of the required user in the administration panel - -![BF](../../static/img/Docs/VKTeams/6.png) - -3. Start a dialog with [@metabot](http://teams.vk.com/profile/70001) and follow the procedure to create a new bot - -![BF](../../static/img/Docs/VKTeams/1.png) - -4. Generate a new **token** and enable the ability to add the bot to a group (if necessary) - -![BF](../../static/img/Docs/VKTeams/2.png) - -5. Save the bot ID by retrieving it using the "Show My Bots" button - -![BF](../../static/img/Docs/VKTeams/4.png) - -6. Form a link and click on it in your browser - -``` - -At the end of the URL should be your bot ID -https://teams.vk.com/profile/1234567890 - -``` - -7. Start a dialog with the bot - -Now you will be able to add a bot to groups and control it with **Token** and **ID of the desired dialog** (group or user) - -![BF](../../static/img/Docs/VKTeams/3.png) +--- +id: VKTeams +sidebar_class_name: VKTeams +--- + + + +# VK Teams + +This section is dedicated to the library for working with VK Teams API. On this page, all the steps necessary to start working are described + +## Getting started + +1. Register, book a tariff and download the VK Teams app [on the home page](https://biz.mail.ru/teams) + +![BF](../../static/img/Docs/VKTeams/5.png) + +2. Log in to the application using the one-time password that should arrive in the mail. You can view the mail of the required user in the administration panel + +![BF](../../static/img/Docs/VKTeams/6.png) + +3. Start a dialog with [@metabot](http://teams.vk.com/profile/70001) and follow the procedure to create a new bot + +![BF](../../static/img/Docs/VKTeams/1.png) + +4. Generate a new **token** and enable the ability to add the bot to a group (if necessary) + +![BF](../../static/img/Docs/VKTeams/2.png) + +5. Save the bot ID by retrieving it using the "Show My Bots" button + +![BF](../../static/img/Docs/VKTeams/4.png) + +6. Form a link and click on it in your browser + +``` + +At the end of the URL should be your bot ID +https://teams.vk.com/profile/1234567890 + +``` + +7. Start a dialog with the bot + +Now you will be able to add a bot to groups and control it with **Token** and **ID of the desired dialog** (group or user) + +![BF](../../static/img/Docs/VKTeams/3.png) diff --git a/docs/en/md/VK/Ad-account-management/Pause-advertising.md b/docs/en/md/VK/Ad-account-management/Pause-advertising.md index f7896ae17d..7890a0c9e9 100644 --- a/docs/en/md/VK/Ad-account-management/Pause-advertising.md +++ b/docs/en/md/VK/Ad-account-management/Pause-advertising.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 3 ---- - -# Pause advertising post - Pauses the display of the advertising post - - - -`Function PauseAdvertising(Val AccountID, Val AdID, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | AccountID | --cabinet | String, Number | Advertising account ID | - | AdID | --adv | String, Number | Ad ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - - AccountID = "1607951446"; - AdID = "0"; - - Result = OPI_VK.PauseAdvertising(AccountID, AdID, Parameters); -``` - - - -```sh title="CLI command example" - - oint vk PauseAdvertising --cabinet %cabinet% --adv %adv% --auth %auth% - -``` - -```json title="Result" -{ - "response": [ - { - "id": 1029701085 - } - ] - } -``` +--- +sidebar_position: 3 +--- + +# Pause advertising post + Pauses the display of the advertising post + + + +`Function PauseAdvertising(Val AccountID, Val AdID, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | AccountID | --cabinet | String, Number | Advertising account ID | + | AdID | --adv | String, Number | Ad ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + + AccountID = "1607951446"; + AdID = "0"; + + Result = OPI_VK.PauseAdvertising(AccountID, AdID, Parameters); +``` + + + +```sh title="CLI command example" + + oint vk PauseAdvertising --cabinet %cabinet% --adv %adv% --auth %auth% + +``` + +```json title="Result" +{ + "response": [ + { + "id": 1029701085 + } + ] + } +``` diff --git a/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md b/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md index 465cc06d75..98465065d1 100644 --- a/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md +++ b/docs/en/md/VK/Product-selection-management/Add-product-to-collection.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 5 ---- - -# Add product to selection - Adds a product to the selection - - - -`Function AddProductToCollection(Val ProductsArray, Val Selection, Val Parameters = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | ProductsArray | --items | Array of string, number | Array of products or product | - | Selection | --sel | String | Selection ID | - | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK - -
- - - - -```bsl title="Code example" - Parameters = GetVKParameters(); - - Product = "9372711"; - Selection = "125"; - - Result = OPI_VK.AddProductToCollection(Product, Selection, Parameters); -``` - - - -```sh title="CLI command example" - - oint vk AddProductToCollection --items %items% --sel %sel% --auth %auth% - -``` - -```json title="Result" -{ - "response": 1 - } -``` +--- +sidebar_position: 5 +--- + +# Add product to selection + Adds a product to the selection + + + +`Function AddProductToCollection(Val ProductsArray, Val Selection, Val Parameters = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | ProductsArray | --items | Array of string, number | Array of products or product | + | Selection | --sel | String | Selection ID | + | Parameters | --auth | Structure Of String | Authorization JSON or path to .json | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK + +
+ + + + +```bsl title="Code example" + Parameters = GetVKParameters(); + + Product = "9372711"; + Selection = "125"; + + Result = OPI_VK.AddProductToCollection(Product, Selection, Parameters); +``` + + + +```sh title="CLI command example" + + oint vk AddProductToCollection --items %items% --sel %sel% --auth %auth% + +``` + +```json title="Result" +{ + "response": 1 + } +``` diff --git a/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md b/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md new file mode 100644 index 0000000000..ce86cb3910 --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Remove chat members + Removes users from the chat + + + +`Function RemoveChatMembers(Val Token, Val ChatID, Val Users) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID | + | Users | --members | String, Number, Array of String, Number | The member or members of the chat room to remove | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) +::: +
+ + + + + +```sh title="CLI command example" + +oint vkteams RemoveChatMembers --token %token% --chatid %chatid% --members %members% + +``` + + diff --git a/docs/en/md/VKTeams/Chat-management/_category_.json b/docs/en/md/VKTeams/Chat-management/_category_.json new file mode 100644 index 0000000000..a73a07714e --- /dev/null +++ b/docs/en/md/VKTeams/Chat-management/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Chat management", +"position": "4" +} \ No newline at end of file diff --git a/docs/en/md/VKTeams/Common-methods/Check-token.md b/docs/en/md/VKTeams/Common-methods/Check-token.md index 1dca4d5d85..f83563f4b5 100644 --- a/docs/en/md/VKTeams/Common-methods/Check-token.md +++ b/docs/en/md/VKTeams/Common-methods/Check-token.md @@ -1,45 +1,40 @@ ---- -sidebar_position: 1 ---- - -# Check token - Checks if the bot token is functional - - - -`Function CheckToken(Val Token) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - Result = OPI_VKTeams.CheckToken(Token); -``` - - - -```sh title="CLI command example" - - oint vkteams CheckToken --token %token% - -``` - -```json title="Result" -{ - "userId": "1011893356", - "ok": true -} -``` +--- +sidebar_position: 1 +--- + +# Check token + Checks if the bot token is functional + + + +`Function CheckToken(Val Token) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + Result = OPI_VKTeams.CheckToken(Token); +``` + + + +```sh title="CLI command example" + + oint vkteams CheckToken --token %token% + +``` + + diff --git a/docs/en/md/VKTeams/Common-methods/Get-events.md b/docs/en/md/VKTeams/Common-methods/Get-events.md index 13da3600dd..106c50d68c 100644 --- a/docs/en/md/VKTeams/Common-methods/Get-events.md +++ b/docs/en/md/VKTeams/Common-methods/Get-events.md @@ -1,61 +1,56 @@ ---- -sidebar_position: 2 ---- - -# Get events - Receives bot events in Polling mode - - - -`Function GetEvents(Val Token, Val LastID, Val Timeout = 0) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | LastID | --last | String, Number | ID of the last event processed before this event | - | Timeout | --timeout | String, Number | Connection hold time for Long Polling | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - LastID = 0; - - For N = 1 To 5 Do // In real work - endless loop - - Result = OPI_VKTeams.GetEvents(Token, LastID, 3); - - Events = Result["events"]; - - // Event handling... - - If Not Events.Count() = 0 Then - LastID = Events[Events.UBound()]["eventId"]; - EndIf; - - EndDo; -``` - - - -```sh title="CLI command example" - - oint vkteams GetEvents --token %token% --last %last% --timeout %timeout% - -``` - -```json title="Result" -{ - "events": [], - "ok": true -} -``` +--- +sidebar_position: 2 +--- + +# Get events + Receives bot events in Polling mode + + + +`Function GetEvents(Val Token, Val LastID, Val Timeout = 0) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | LastID | --last | String, Number | ID of the last event processed before this event | + | Timeout | --timeout | String, Number | Connection hold time for Long Polling | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + LastID = 0; + + For N = 1 To 5 Do // In real work - endless loop + + Result = OPI_VKTeams.GetEvents(Token, LastID, 3); + + Events = Result["events"]; + + // Event handling... + + If Not Events.Count() = 0 Then + LastID = Events[Events.UBound()]["eventId"]; + EndIf; + + EndDo; +``` + + + +```sh title="CLI command example" + + oint vkteams GetEvents --token %token% --last %last% --timeout %timeout% + +``` + + diff --git a/docs/en/md/VKTeams/Common-methods/Get-file-information.md b/docs/en/md/VKTeams/Common-methods/Get-file-information.md index 20db6aa0d1..2bfbbe9878 100644 --- a/docs/en/md/VKTeams/Common-methods/Get-file-information.md +++ b/docs/en/md/VKTeams/Common-methods/Get-file-information.md @@ -1,51 +1,43 @@ ---- -sidebar_position: 3 ---- - -# Get information about file - Gets information about a file by ID - - - -`Function GetFileInformation(Val Token, Val FileID) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | FileID | --fileid | String, Number | File ID | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - FileID = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; - - Result = OPI_VKTeams.GetFileInformation(Token, FileID); -``` - - - -```sh title="CLI command example" - - oint vkteams GetFileInformation --token %token% --fileid %fileid% - -``` - -```json title="Result" -{ - "filename": "ImportantDocument.docx", - "size": 24071, - "type": "application", - "url": "https://ub.icq.net/files/get/XrJ30TgJvcpZoiAEu1MC46e1MCbBs3NXwqSkBiZgCEkXOsNmPmAnw2XXpEM4WXMcylct3N2s3XwyMI5Cj7GDKtY6FmpmOHLgYC2xUanmVRf4gtn0zVatipXHgtriTJACrKfemXbqJuLCNOYZJieYS72mwqu1MC/%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "ok": true -} -``` +--- +sidebar_position: 3 +--- + +# Get information about file + Gets information about a file by ID + + + +`Function GetFileInformation(Val Token, Val FileID) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | FileID | --fileid | String, Number | File ID | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + FileID = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; + + Result = OPI_VKTeams.GetFileInformation(Token, FileID); +``` + + + +```sh title="CLI command example" + + oint vkteams GetFileInformation --token %token% --fileid %fileid% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Delete-message.md b/docs/en/md/VKTeams/Message-sending/Delete-message.md index 706b430371..b6298cd326 100644 --- a/docs/en/md/VKTeams/Message-sending/Delete-message.md +++ b/docs/en/md/VKTeams/Message-sending/Delete-message.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Delete message - Deletes a message by ID - - - -`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | MessageID | --messageid | String, Number | Message ID for editing | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7402287649739767956"; - - Result = OPI_VKTeams.DeleteMessage(Token, ChatID, MessageID); -``` - - - -```sh title="CLI command example" - - oint vkteams DeleteMessage --token %token% --chatid %chatid% --messageid %messageid% - -``` - - +--- +sidebar_position: 5 +--- + +# Delete message + Deletes a message by ID + + + +`Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | MessageID | --messageid | String, Number | Message ID for editing | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7402287649739767956"; + + Result = OPI_VKTeams.DeleteMessage(Token, ChatID, MessageID); +``` + + + +```sh title="CLI command example" + + oint vkteams DeleteMessage --token %token% --chatid %chatid% --messageid %messageid% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Edit-message-text.md b/docs/en/md/VKTeams/Message-sending/Edit-message-text.md index 70f961e6fa..f1d0b1663b 100644 --- a/docs/en/md/VKTeams/Message-sending/Edit-message-text.md +++ b/docs/en/md/VKTeams/Message-sending/Edit-message-text.md @@ -1,59 +1,55 @@ ---- -sidebar_position: 4 ---- - -# Change the message text - Changes the text of an existing message - - - -`Function EditMessageText(Val Token, Val ChatID, Val MessageID, Val Text, Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | MessageID | --messageid | String, Number | Message ID for editing | - | Text | --text | String | New message text | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -You can mention a user by appending their userId to the text in the following format @[userId] - - Method at API documentation: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - MessageID = "7402287649739767956"; - Text = "New message text"; - - Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text); - - Text = "New bold message text"; - Markup = "HTML"; - - Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text, Markup); -``` - - - -```sh title="CLI command example" - - oint vkteams EditMessageText --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod% - -``` - -```json title="Result" -{ - "ok": true -} -``` +--- +sidebar_position: 4 +--- + +# Change the message text + Changes the text of an existing message + + + +`Function EditMessageText(Val Token, Val ChatID, Val MessageID, Val Text, Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | MessageID | --messageid | String, Number | Message ID for editing | + | Text | --text | String | New message text | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +You can mention a user by appending their userId to the text in the following format @[userId] + + Method at API documentation: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + MessageID = "7402287649739767956"; + Text = "New message text"; + + Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text); + + Text = "New bold message text"; + Markup = "HTML"; + + Result = OPI_VKTeams.EditMessageText(Token, ChatID, MessageID, Text, Markup); +``` + + + +```sh title="CLI command example" + + oint vkteams EditMessageText --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Forward-message.md b/docs/en/md/VKTeams/Message-sending/Forward-message.md index 17fee27f43..d8983da052 100644 --- a/docs/en/md/VKTeams/Message-sending/Forward-message.md +++ b/docs/en/md/VKTeams/Message-sending/Forward-message.md @@ -1,59 +1,54 @@ ---- -sidebar_position: 8 ---- - -# Forward message - Forwards an existing message to the current dialog box - - - -`Function ForwardMessage(Val Token, Val MessageID, Val FromChatID, Val ChatID, Val Text = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | MessageID | --message | String, Number | Original message ID | - | FromChatID | --fromid | String, Number | Source chat ID | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | Text | --text | String | Additional message text | - - - Returns: HTTPResponse - Forward message - -
- -:::tip -Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable)) - - Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FromChatID = "689203963@chat.agent"; - MessageID = "7402287649739767956"; - - Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID); - - Text = "Additional text"; - - Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID, Text); -``` - - - -```sh title="CLI command example" - - oint vkteams ForwardMessage --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text% - -``` - -```json title="Result" -{ - "msgId": "7401634788940972096", - "ok": true -} -``` +--- +sidebar_position: 8 +--- + +# Forward message + Forwards an existing message to the current dialog box + + + +`Function ForwardMessage(Val Token, Val MessageID, Val FromChatID, Val ChatID, Val Text = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | MessageID | --message | String, Number | Original message ID | + | FromChatID | --fromid | String, Number | Source chat ID | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | Text | --text | String | Additional message text | + + + Returns: HTTPResponse - Forward message + +
+ +:::tip +Only the chatId from events can be passed to the FromChatID (the code from the chat link is not suitable)) + + Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + FromChatID = "689203963@chat.agent"; + MessageID = "7402287649739767956"; + + Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID); + + Text = "Additional text"; + + Result = OPI_VKTeams.ForwardMessage(Token, MessageID, FromChatID, ChatID, Text); +``` + + + +```sh title="CLI command example" + + oint vkteams ForwardMessage --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Resend-file.md b/docs/en/md/VKTeams/Message-sending/Resend-file.md index 4b9da0edd5..dd76b5c6af 100644 --- a/docs/en/md/VKTeams/Message-sending/Resend-file.md +++ b/docs/en/md/VKTeams/Message-sending/Resend-file.md @@ -1,55 +1,49 @@ ---- -sidebar_position: 6 ---- - -# Resend file - Sends a previously uploaded file by ID - - - -`Function ResendFile(Val Token, Val ChatID, Val FileID, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | FileID | --fileid | String, Number | File ID to send | - | Text | --text | String | File caption | - | FileName | --filename | String | Displayed file name | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FileID = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; - Text = "File caption"; - - Result = OPI_VKTeams.ResendFile(Token, ChatID, FileID, Text, "SameDoc.docx"); -``` - - - -```sh title="CLI command example" - - oint vkteams ResendFile --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod% - -``` - -```json title="Result" -{ - "fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd", - "msgId": "7401634819005743172", - "ok": true -} -``` +--- +sidebar_position: 6 +--- + +# Resend file + Sends a previously uploaded file by ID + + + +`Function ResendFile(Val Token, Val ChatID, Val FileID, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | FileID | --fileid | String, Number | File ID to send | + | Text | --text | String | File caption | + | FileName | --filename | String | Displayed file name | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + FileID = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; + Text = "File caption"; + + Result = OPI_VKTeams.ResendFile(Token, ChatID, FileID, Text, "SameDoc.docx"); +``` + + + +```sh title="CLI command example" + + oint vkteams ResendFile --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Resend-voice.md b/docs/en/md/VKTeams/Message-sending/Resend-voice.md index 90f54433c7..37c472078f 100644 --- a/docs/en/md/VKTeams/Message-sending/Resend-voice.md +++ b/docs/en/md/VKTeams/Message-sending/Resend-voice.md @@ -1,45 +1,38 @@ ---- -sidebar_position: 7 ---- - -# Resend voice - Sends a previously uploaded voice message by ID - - - -`Function ResendVoice(Val Token, Val ChatID, Val FileID) Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | FileID | --fileid | String, Number | File ID of voice message | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - FileID = "I000bPVBYaNQkn9Fg3oY0066ba35811bd"; - - Result = OPI_VKTeams.ResendVoice(Token, ChatID, FileID); -``` - - - -```sh title="CLI command example" - -oint vkteams ResendVoice --token "001.3501506236.091..." --chatid "AoLI0egLWBSLR1Ngn2w" --fileid "I000bPVBYaNQkn9Fg3oY0066ba35811bd" - -``` - - +--- +sidebar_position: 7 +--- + +# Resend voice + Sends a previously uploaded voice message by ID + + + +`Function ResendVoice(Val Token, Val ChatID, Val FileID) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | FileID | --fileid | String, Number | File ID of voice message | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) +::: +
+ + + + + +```sh title="CLI command example" + + oint vkteams ResendVoice --token "001.3501506236.091..." --chatid "AoLI0egLWBSLR1Ngn2w" --fileid "I000bPVBYaNQkn9Fg3oY0066ba35811bd" + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Send-file.md b/docs/en/md/VKTeams/Message-sending/Send-file.md index dbb6151849..96d0a0968b 100644 --- a/docs/en/md/VKTeams/Message-sending/Send-file.md +++ b/docs/en/md/VKTeams/Message-sending/Send-file.md @@ -1,65 +1,59 @@ ---- -sidebar_position: 2 ---- - -# Send file - Sends the file to the chat - - - -`Function SendFile(Val Token, Val ChatID, Val File, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | File | --file | BinaryData, String | File for sending | - | Text | --text | String | File caption | - | FileName | --filename | String | Displayed file name | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -Method at API documentation: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - Text = "File caption"; - - File = "https://openintegrations.dev/test_data/document.docx"; // URL - FilePath = GetTempFileName("docx"); // Path - - FileCopy(File, FilePath); - - FileBD = New BinaryData(FilePath); // Binary - - Result = OPI_VKTeams.SendFile(Token, ChatID, File); - - Result = OPI_VKTeams.SendFile(Token, ChatID, FilePath, Text); - - Result = OPI_VKTeams.SendFile(Token, ChatID, File, Text, "ImportantDocument.docx"); -``` - - - -```sh title="CLI command example" - - oint vkteams SendFile --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod% - -``` - -```json title="Result" -{ - "fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd", - "msgId": "7401634797530906691", - "ok": true -} -``` +--- +sidebar_position: 2 +--- + +# Send file + Sends the file to the chat + + + +`Function SendFile(Val Token, Val ChatID, Val File, Val Text = "", Val FileName = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | File | --file | BinaryData, String | File for sending | + | Text | --text | String | File caption | + | FileName | --filename | String | Displayed file name | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +Method at API documentation: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + Text = "File caption"; + + File = "https://openintegrations.dev/test_data/document.docx"; // URL + FilePath = GetTempFileName("docx"); // Path + + FileCopy(File, FilePath); + + FileBD = New BinaryData(FilePath); // Binary + + Result = OPI_VKTeams.SendFile(Token, ChatID, File); + + Result = OPI_VKTeams.SendFile(Token, ChatID, FilePath, Text); + + Result = OPI_VKTeams.SendFile(Token, ChatID, File, Text, "ImportantDocument.docx"); +``` + + + +```sh title="CLI command example" + + oint vkteams SendFile --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Send-text-message.md b/docs/en/md/VKTeams/Message-sending/Send-text-message.md index aba3b57323..24a3056076 100644 --- a/docs/en/md/VKTeams/Message-sending/Send-text-message.md +++ b/docs/en/md/VKTeams/Message-sending/Send-text-message.md @@ -1,62 +1,57 @@ ---- -sidebar_position: 1 ---- - -# Send text message - Sends a text message to a chat - - - -`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val ReplyID = 0, Val Keyboard = "", Val Markup = "MarkdownV2") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for message sending | - | Text | --text | String | Message text | - | ReplyID | --reply | String, Number | Replying message id if necessary | - | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | - | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -You can mention a user by appending their userId to the text in the following format @[userId] - - Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "AoLI0egLWBSLR1Ngn2w"; - Text = "Message text"; - - Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text); - - ChatID = "689203963@chat.agent"; - ReplyID = "7402287649739767956"; - Text = "Bold text"; - Markup = "HTML"; - - Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text, ReplyID,, Markup); -``` - - - -```sh title="CLI command example" - - oint vkteams SendTextMessage --token %token% --chatid %chatid% --text %text% --reply %reply% --keyboard %keyboard% --parsemod %parsemod% - -``` - -```json title="Result" -{ - "msgId": "7401135795345555471", - "ok": true -} -``` +--- +sidebar_position: 1 +--- + +# Send text message + Sends a text message to a chat + + + +`Function SendTextMessage(Val Token, Val ChatID, Val Text, Val ReplyID = 0, Val Keyboard = "", Val Markup = "MarkdownV2") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for message sending | + | Text | --text | String | Message text | + | ReplyID | --reply | String, Number | Replying message id if necessary | + | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | + | Markup | --parsemod | String | Markup type for message text: MarkdownV2 or HTML | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +You can mention a user by appending their userId to the text in the following format @[userId] + + Method at API documentation: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "AoLI0egLWBSLR1Ngn2w"; + Text = "Message text"; + + Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text); + + ChatID = "689203963@chat.agent"; + ReplyID = "7402287649739767956"; + Text = "Bold text"; + Markup = "HTML"; + + Result = OPI_VKTeams.SendTextMessage(Token, ChatID, Text, ReplyID,, Markup); +``` + + + +```sh title="CLI command example" + + oint vkteams SendTextMessage --token %token% --chatid %chatid% --text %text% --reply %reply% --keyboard %keyboard% --parsemod %parsemod% + +``` + + diff --git a/docs/en/md/VKTeams/Message-sending/Send-voice.md b/docs/en/md/VKTeams/Message-sending/Send-voice.md index 96b03b446b..6c727fb8bd 100644 --- a/docs/en/md/VKTeams/Message-sending/Send-voice.md +++ b/docs/en/md/VKTeams/Message-sending/Send-voice.md @@ -1,62 +1,62 @@ ---- -sidebar_position: 3 ---- - -# Send voice - Sends an audio file as a voice message - - - -`Function SendVoice(Val Token, Val ChatID, Val File, Val FileType = "m4a", Val ReplyID = 0, Val Keyboard = "") Export` - - | Parameter | CLI option | Type | Destination | - |-|-|-|-| - | Token | --token | String | Bot token | - | ChatID | --chatid | String, Number | Chat ID for sending | - | File | --file | BinaryData, String | File for sending | - | FileType | --type | String | Audio type: aac, ogg or m4a | - | ReplyID | --reply | String, Number | Replying message id if necessary | - | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | - - - Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams - -
- -:::tip -If you want the client to display this file as a playable voice message, it must be in aac, ogg, or m4a format - - Method at API documentation: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) -::: -
- - -```bsl title="Code example" - Token = "001.3501506236.091..."; - ChatID = "689203963@chat.agent"; - ReplyID = "7402287649739767956"; - Text = "File caption"; - - File = "https://openintegrations.dev/test_data/song.m4a" ; // URL - FilePath = GetTempFileName("m4a"); // Path - - FileCopy(File, FilePath); - - FileBD = New BinaryData(FilePath); // Binary - - Result = OPI_VKTeams.SendVoice(Token, ChatID, File); - - Result = OPI_VKTeams.SendVoice(Token, ChatID, FilePath,,ReplyID); - - Result = OPI_VKTeams.SendVoice(Token, ChatID, File); -``` - - - -```sh title="CLI command example" - -oint vkteams SendVoice --token "001.3501506236.091..." --chatid "689203963@chat.agent" --file "https://openintegrations.dev/test_data/song.m4a" --type %type% --reply "7401868177463836806" --keyboard %keyboard% - -``` - - +--- +sidebar_position: 3 +--- + +# Send voice + Sends an audio file as a voice message + + + +`Function SendVoice(Val Token, Val ChatID, Val File, Val FileType = "m4a", Val ReplyID = 0, Val Keyboard = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Token | --token | String | Bot token | + | ChatID | --chatid | String, Number | Chat ID for sending | + | File | --file | BinaryData, String | File for sending | + | FileType | --type | String | Audio type: aac, ogg or m4a | + | ReplyID | --reply | String, Number | Replying message id if necessary | + | Keyboard | --keyboard | Array Of String | Buttons to the message if necessary | + + + Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams + +
+ +:::tip +If you want the client to display this file as a playable voice message, it must be in aac, ogg, or m4a format + + Method at API documentation: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) +::: +
+ + +```bsl title="Code example" + Token = "001.3501506236.091..."; + ChatID = "689203963@chat.agent"; + ReplyID = "7402287649739767956"; + Text = "File caption"; + + File = "https://openintegrations.dev/test_data/song.m4a" ; // URL + FilePath = GetTempFileName("m4a"); // Path + + FileCopy(File, FilePath); + + FileBD = New BinaryData(FilePath); // Binary + + Result = OPI_VKTeams.SendVoice(Token, ChatID, File); + + Result = OPI_VKTeams.SendVoice(Token, ChatID, FilePath,,ReplyID); + + Result = OPI_VKTeams.SendVoice(Token, ChatID, File); +``` + + + +```sh title="CLI command example" + + oint vkteams SendVoice --token "001.3501506236.091..." --chatid "689203963@chat.agent" --file "https://openintegrations.dev/test_data/song.m4a" --type %type% --reply "7401868177463836806" --keyboard %keyboard% + +``` + + diff --git a/docs/en/md/sidebars.js b/docs/en/md/sidebars.js index 6a36fbe32c..8a5d6a51b3 100644 --- a/docs/en/md/sidebars.js +++ b/docs/en/md/sidebars.js @@ -1,69 +1,69 @@ -export default { - docs: [ - - { - type: 'category', - label: 'Welcome!', - link: {type: 'doc', id:'Instructions/Start'}, - className: 'Start', - items:[{type: 'autogenerated', dirName: 'Start'}] - }, - - { - type: 'category', - label: 'Messengers', - className: 'Messenger', - items: [ - { type: 'category', link: {type: 'doc', id:'Instructions/Telegram'}, label: 'Telegram', className: 'Telegram', items:[{type: 'autogenerated', dirName: 'Telegram'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/Viber'}, label: 'Viber', className: 'Viber', items:[{type: 'autogenerated', dirName: 'Viber'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/Slack'}, label: 'Slack', className: 'Slack', items:[{type: 'autogenerated', dirName: 'Slack'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/VKTeams'}, label: 'VK Teams', className: 'VKTeams', items:[{type: 'autogenerated', dirName: 'VKTeams'}]}, - ], - }, - { - type: 'category', - label: 'Social networks', - className: 'Social', - items:[ - { type: 'category', link: {type: 'doc', id:'Instructions/VK'}, label: 'VK', className: 'VK', items:[{type: 'autogenerated', dirName: 'VK'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/Twitter'}, label: 'Twitter', className: 'Twitter', items:[{type: 'autogenerated', dirName: 'Twitter'}]}, - ], - }, - { - type: 'category', - label: 'Databases and spreadsheets', - className: 'Database', - items:[ - { type: 'category', link: {type: 'doc', id:'Instructions/Airtable'}, label: 'Airtable', className: 'Airtable', items:[{type: 'autogenerated', dirName: 'Airtable'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/GoogleSheets'}, label: 'Google Sheets', className: 'GoogleSheets', items:[{type: 'autogenerated', dirName: 'Google_Sheets'}]}, - ], - }, - { - type: 'category', - label: 'File-hosting services', - className: 'Folder', - items:[ - { type: 'category', link: {type: 'doc', id:'Instructions/GoogleDrive'}, label: 'Google Drive', className: 'GoogleDrive', items:[{type: 'autogenerated', dirName: 'Google_Drive'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/YandexDisk'}, label: 'Yandex Disk', className: 'YandexDisk', items:[{type: 'autogenerated', dirName: 'Yandex_Disk'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/Dropbox'}, label: 'Dropbox', className: 'Dropbox', items:[{type: 'autogenerated', dirName: 'Dropbox'}]}, - ], - }, - { - type: 'category', - label: 'Complete solutions (CMS, CRM)', - className: 'CRM', - items:[ - { type: 'category', link: {type: 'doc', id:'Instructions/Bitrix24'}, label: 'Bitrix24', className: 'Bitrix24', items:[{type: 'autogenerated', dirName: 'Bitrix24'}]}, - ], - }, - { - type: 'category', - label: 'Planning and projects managment ', - className: 'Calendar', - items:[ - { type: 'category', link: {type: 'doc', id:'Instructions/GoogleCalendar'}, label: 'Google Calendar', className: 'GoogleCalendar', items:[{type: 'autogenerated', dirName: 'Google_Calendar'}]}, - { type: 'category', link: {type: 'doc', id:'Instructions/Notion'}, label: 'Notion', className: 'Notion', items:[{type: 'autogenerated', dirName: 'Notion'}]}, - ], - }, - ], -}; +export default { + docs: [ + + { + type: 'category', + label: 'Welcome!', + link: {type: 'doc', id:'Instructions/Start'}, + className: 'Start', + items:[{type: 'autogenerated', dirName: 'Start'}] + }, + + { + type: 'category', + label: 'Messengers', + className: 'Messenger', + items: [ + { type: 'category', link: {type: 'doc', id:'Instructions/Telegram'}, label: 'Telegram', className: 'Telegram', items:[{type: 'autogenerated', dirName: 'Telegram'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/Viber'}, label: 'Viber', className: 'Viber', items:[{type: 'autogenerated', dirName: 'Viber'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/Slack'}, label: 'Slack', className: 'Slack', items:[{type: 'autogenerated', dirName: 'Slack'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/VKTeams'}, label: 'VK Teams', className: 'VKTeams', items:[{type: 'autogenerated', dirName: 'VKTeams'}]}, + ], + }, + { + type: 'category', + label: 'Social networks', + className: 'Social', + items:[ + { type: 'category', link: {type: 'doc', id:'Instructions/VK'}, label: 'VK', className: 'VK', items:[{type: 'autogenerated', dirName: 'VK'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/Twitter'}, label: 'Twitter', className: 'Twitter', items:[{type: 'autogenerated', dirName: 'Twitter'}]}, + ], + }, + { + type: 'category', + label: 'Databases and spreadsheets', + className: 'Database', + items:[ + { type: 'category', link: {type: 'doc', id:'Instructions/Airtable'}, label: 'Airtable', className: 'Airtable', items:[{type: 'autogenerated', dirName: 'Airtable'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/GoogleSheets'}, label: 'Google Sheets', className: 'GoogleSheets', items:[{type: 'autogenerated', dirName: 'Google_Sheets'}]}, + ], + }, + { + type: 'category', + label: 'File-hosting services', + className: 'Folder', + items:[ + { type: 'category', link: {type: 'doc', id:'Instructions/GoogleDrive'}, label: 'Google Drive', className: 'GoogleDrive', items:[{type: 'autogenerated', dirName: 'Google_Drive'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/YandexDisk'}, label: 'Yandex Disk', className: 'YandexDisk', items:[{type: 'autogenerated', dirName: 'Yandex_Disk'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/Dropbox'}, label: 'Dropbox', className: 'Dropbox', items:[{type: 'autogenerated', dirName: 'Dropbox'}]}, + ], + }, + { + type: 'category', + label: 'Complete solutions (CMS, CRM)', + className: 'CRM', + items:[ + { type: 'category', link: {type: 'doc', id:'Instructions/Bitrix24'}, label: 'Bitrix24', className: 'Bitrix24', items:[{type: 'autogenerated', dirName: 'Bitrix24'}]}, + ], + }, + { + type: 'category', + label: 'Planning and projects managment ', + className: 'Calendar', + items:[ + { type: 'category', link: {type: 'doc', id:'Instructions/GoogleCalendar'}, label: 'Google Calendar', className: 'GoogleCalendar', items:[{type: 'autogenerated', dirName: 'Google_Calendar'}]}, + { type: 'category', link: {type: 'doc', id:'Instructions/Notion'}, label: 'Notion', className: 'Notion', items:[{type: 'autogenerated', dirName: 'Notion'}]}, + ], + }, + ], +}; diff --git a/docs/ru/cli/VKTeams/ИсключитьПользователейЧата.txt b/docs/ru/cli/VKTeams/ИсключитьПользователейЧата.txt new file mode 100644 index 0000000000..9e12d7c427 --- /dev/null +++ b/docs/ru/cli/VKTeams/ИсключитьПользователейЧата.txt @@ -0,0 +1 @@ +oint vkteams ИсключитьПользователейЧата --token %token% --chatid %chatid% --members %members% diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md index dcb1eeda62..f055fa99e8 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 2 ---- - -# Создать подкаталог - Создает каталог внутри другого каталога - - - -`Функция СоздатьПодкаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога родителя | - | Наименование | --title | Строка | Наименование нового каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "5016"; - Наименование = "Новый подкаталог"; - Наименование2 = "Новый подкаталог 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьПодкаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 850, - "NAME": "Новый подкаталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 850, - "PARENT_ID": "846", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-06-27T07:19:57+00:00", - "UPDATE_TIME": "2024-06-27T07:19:57+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" - }, - "time": { - "start": 1719472797.42827, - "finish": 1719472797.50854, - "duration": 0.080265998840332, - "processing": 0.0455958843231201, - "date_start": "2024-06-27T07:19:57+00:00", - "date_finish": "2024-06-27T07:19:57+00:00", - "operating_reset_at": 1719473397, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Создать подкаталог + Создает каталог внутри другого каталога + + + +`Функция СоздатьПодкаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога родителя | + | Наименование | --title | Строка | Наименование нового каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "5016"; + Наименование = "Новый подкаталог"; + Наименование2 = "Новый подкаталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьПодкаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 850, + "NAME": "Новый подкаталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 850, + "PARENT_ID": "846", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-27T07:19:57+00:00", + "UPDATE_TIME": "2024-06-27T07:19:57+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" + }, + "time": { + "start": 1719472797.42827, + "finish": 1719472797.50854, + "duration": 0.080265998840332, + "processing": 0.0455958843231201, + "date_start": "2024-06-27T07:19:57+00:00", + "date_finish": "2024-06-27T07:19:57+00:00", + "operating_reset_at": 1719473397, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md index 6b459260d8..4cf484eeed 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 5 ---- - -# Удалить каталог - Удаляет каталог с подкаталогами - - - -`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5014"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1719047257.50616, - "finish": 1719047257.55445, - "duration": 0.048285961151123, - "processing": 0.0174880027770996, - "date_start": "2024-06-22T09:07:37+00:00", - "date_finish": "2024-06-22T09:07:37+00:00", - "operating_reset_at": 1719047857, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Удалить каталог + Удаляет каталог с подкаталогами + + + +`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5014"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1719047257.50616, + "finish": 1719047257.55445, + "duration": 0.048285961151123, + "processing": 0.0174880027770996, + "date_start": "2024-06-22T09:07:37+00:00", + "date_finish": "2024-06-22T09:07:37+00:00", + "operating_reset_at": 1719047857, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md index 0874f3b255..a9f35b0336 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 6 ---- - -# Получить внешнюю ссылку каталога - Получает внешнюю ссылку для доступа к каталогу - - - -`Функция ПолучитьВнешнююСсылкуКаталога(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьВнешнююСсылкуКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": "https://b24-ar17wx.bitrix24.by/~hWalI", - "time": { - "start": 1719472796.12325, - "finish": 1719472796.16843, - "duration": 0.0451798439025879, - "processing": 0.0110611915588379, - "date_start": "2024-06-27T07:19:56+00:00", - "date_finish": "2024-06-27T07:19:56+00:00", - "operating_reset_at": 1719473396, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Получить внешнюю ссылку каталога + Получает внешнюю ссылку для доступа к каталогу + + + +`Функция ПолучитьВнешнююСсылкуКаталога(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьВнешнююСсылкуКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": "https://b24-ar17wx.bitrix24.by/~hWalI", + "time": { + "start": 1719472796.12325, + "finish": 1719472796.16843, + "duration": 0.0451798439025879, + "processing": 0.0110611915588379, + "date_start": "2024-06-27T07:19:56+00:00", + "date_finish": "2024-06-27T07:19:56+00:00", + "operating_reset_at": 1719473396, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md index 07158f8823..54b3c3faf3 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 11 ---- - -# Получить структуру фильтра каталога - Возвращает структуру полей для фильтрации дочерних элементов каталога - - - -`Функция ПолучитьСтруктуруФильтраКаталога(Знач URL, Знач Пустая = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- -:::tip -Метод в документации API: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL, Истина, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтруктуруФильтраКаталога --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "ID": "", - "NAME": "", - "TYPE": "", - "CODE": "", - "STORAGE_ID": "", - "PARENT_ID": "", - "CREATE_TIME": "", - "UPDATE_TIME": "", - "DELETE_TIME": "", - "DELETED_TYPE": "" -} -``` +--- +sidebar_position: 11 +--- + +# Получить структуру фильтра каталога + Возвращает структуру полей для фильтрации дочерних элементов каталога + + + +`Функция ПолучитьСтруктуруФильтраКаталога(Знач URL, Знач Пустая = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ +:::tip +Метод в документации API: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтруктуруФильтраКаталога --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "ID": "", + "NAME": "", + "TYPE": "", + "CODE": "", + "STORAGE_ID": "", + "PARENT_ID": "", + "CREATE_TIME": "", + "UPDATE_TIME": "", + "DELETE_TIME": "", + "DELETED_TYPE": "" +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md index b766ea927f..31434df2ff 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 1 ---- - -# Получить информацию о каталоге - Получает информацию о каталоге - - - -`Функция ПолучитьИнформациюОКаталоге(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьИнформациюОКаталоге --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1722", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "1722", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-03T14:42:37+00:00", - "UPDATE_TIME": "2024-07-03T14:42:37+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1720017760.63451, - "finish": 1720017760.68628, - "duration": 0.0517730712890625, - "processing": 0.0117180347442627, - "date_start": "2024-07-03T14:42:40+00:00", - "date_finish": "2024-07-03T14:42:40+00:00", - "operating_reset_at": 1720018360, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить информацию о каталоге + Получает информацию о каталоге + + + +`Функция ПолучитьИнформациюОКаталоге(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьИнформациюОКаталоге --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1722", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "1722", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-03T14:42:37+00:00", + "UPDATE_TIME": "2024-07-03T14:42:37+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1720017760.63451, + "finish": 1720017760.68628, + "duration": 0.0517730712890625, + "processing": 0.0117180347442627, + "date_start": "2024-07-03T14:42:40+00:00", + "date_finish": "2024-07-03T14:42:40+00:00", + "operating_reset_at": 1720018360, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md index 1613f3536d..1760c9aaa5 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md @@ -1,100 +1,100 @@ ---- -sidebar_position: 7 ---- - -# Получить дочерние элементы каталога - Получает дочерние элементы каталога - - - -`Функция ПолучитьДочерниеЭлементыКаталога(Знач URL, Знач IDКаталога, Знач Фильтр = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Фильтр | --filter | Структура из КлючИЗначение | Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьДочерниеЭлементыКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "848", - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "848", - "PARENT_ID": "846", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-06-27T07:19:56+00:00", - "UPDATE_TIME": "2024-06-27T07:19:58+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог 2" - }, - { - "ID": "850", - "NAME": "Новый подкаталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "850", - "PARENT_ID": "846", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-06-27T07:19:57+00:00", - "UPDATE_TIME": "2024-06-27T07:19:58+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" - } - ], - "total": 2, - "time": { - "start": 1719472801.3139, - "finish": 1719472801.36215, - "duration": 0.0482509136199951, - "processing": 0.0148689746856689, - "date_start": "2024-06-27T07:20:01+00:00", - "date_finish": "2024-06-27T07:20:01+00:00", - "operating_reset_at": 1719473401, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Получить дочерние элементы каталога + Получает дочерние элементы каталога + + + +`Функция ПолучитьДочерниеЭлементыКаталога(Знач URL, Знач IDКаталога, Знач Фильтр = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Фильтр | --filter | Структура из КлючИЗначение | Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьДочерниеЭлементыКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "848", + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "848", + "PARENT_ID": "846", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-06-27T07:19:56+00:00", + "UPDATE_TIME": "2024-06-27T07:19:58+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог 2" + }, + { + "ID": "850", + "NAME": "Новый подкаталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "850", + "PARENT_ID": "846", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-06-27T07:19:57+00:00", + "UPDATE_TIME": "2024-06-27T07:19:58+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог" + } + ], + "total": 2, + "time": { + "start": 1719472801.3139, + "finish": 1719472801.36215, + "duration": 0.0482509136199951, + "processing": 0.0148689746856689, + "date_start": "2024-06-27T07:20:01+00:00", + "date_finish": "2024-06-27T07:20:01+00:00", + "operating_reset_at": 1719473401, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md index 29e64f269e..d49395abb6 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 3 ---- - -# Скопировать каталог - Копирует один каталог в другой - - - -`Функция СкопироватьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) -::: -
- - -```bsl title="Пример кода" - IDПриемника = "5018"; - IDКаталога = "5020"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); - - IDПриемника = "5020"; - IDКаталога = "5018"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника, Токен); - - Проверка_БитриксОбъект(Результат); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СкопироватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 1732, - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 1732, - "PARENT_ID": "1726", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-07-03T14:42:46+00:00", - "UPDATE_TIME": "2024-07-03T14:42:46+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог/Новый подкаталог 2" - }, - "time": { - "start": 1720017765.97028, - "finish": 1720017766.08005, - "duration": 0.109767913818359, - "processing": 0.0799601078033447, - "date_start": "2024-07-03T14:42:45+00:00", - "date_finish": "2024-07-03T14:42:46+00:00", - "operating_reset_at": 1720018366, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Скопировать каталог + Копирует один каталог в другой + + + +`Функция СкопироватьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
+ + +```bsl title="Пример кода" + IDПриемника = "5018"; + IDКаталога = "5020"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); + + IDПриемника = "5020"; + IDКаталога = "5018"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника, Токен); + + Проверка_БитриксОбъект(Результат); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СкопироватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 1732, + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 1732, + "PARENT_ID": "1726", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-07-03T14:42:46+00:00", + "UPDATE_TIME": "2024-07-03T14:42:46+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог/Новый подкаталог/Новый подкаталог 2" + }, + "time": { + "start": 1720017765.97028, + "finish": 1720017766.08005, + "duration": 0.109767913818359, + "processing": 0.0799601078033447, + "date_start": "2024-07-03T14:42:45+00:00", + "date_finish": "2024-07-03T14:42:46+00:00", + "operating_reset_at": 1720018366, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md index eba83b48f6..7d1d175ca4 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 8 ---- - -# Поместить каталог в корзину - Перемещает каталог в корзину удаляемых файлов - - - -`Функция ПоместитьКаталогВКорзину(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПоместитьКаталогВКорзину --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "936", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:06+00:00", - "DELETE_TIME": "2024-07-01T13:44:12+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1719841453.13782, - "finish": 1719841453.17717, - "duration": 0.0393478870391846, - "processing": 0.00959300994873047, - "date_start": "2024-07-01T13:44:13+00:00", - "date_finish": "2024-07-01T13:44:13+00:00", - "operating_reset_at": 1719842053, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Поместить каталог в корзину + Перемещает каталог в корзину удаляемых файлов + + + +`Функция ПоместитьКаталогВКорзину(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПоместитьКаталогВКорзину --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "936", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:06+00:00", + "DELETE_TIME": "2024-07-01T13:44:12+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1719841453.13782, + "finish": 1719841453.17717, + "duration": 0.0393478870391846, + "processing": 0.00959300994873047, + "date_start": "2024-07-01T13:44:13+00:00", + "date_finish": "2024-07-01T13:44:13+00:00", + "operating_reset_at": 1719842053, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md index 10797b42ab..336bd1345b 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 4 ---- - -# Переместить каталог - Перемещает один каталог внутрь другого - - - -`Функция ПереместитьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) -::: -
- - -```bsl title="Пример кода" - IDПриемника = "5014"; - IDКаталога = "5020"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); - - IDКаталога = "5018"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника, Токен); - - Проверка_БитриксОбъект(Результат); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереместитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "938", - "NAME": "Новый подкаталог 2", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "938", - "PARENT_ID": 934, - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:06+00:00", - "UPDATE_TIME": "2024-07-01T13:44:07+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог 2/Новый подкаталог 2" - }, - "time": { - "start": 1719841451.89089, - "finish": 1719841451.95846, - "duration": 0.0675740242004394, - "processing": 0.0360250473022461, - "date_start": "2024-07-01T13:44:11+00:00", - "date_finish": "2024-07-01T13:44:11+00:00", - "operating_reset_at": 1719842051, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Переместить каталог + Перемещает один каталог внутрь другого + + + +`Функция ПереместитьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
+ + +```bsl title="Пример кода" + IDПриемника = "5014"; + IDКаталога = "5020"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); + + IDКаталога = "5018"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника, Токен); + + Проверка_БитриксОбъект(Результат); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереместитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "938", + "NAME": "Новый подкаталог 2", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "938", + "PARENT_ID": 934, + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:06+00:00", + "UPDATE_TIME": "2024-07-01T13:44:07+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог 2/Новый подкаталог 2" + }, + "time": { + "start": 1719841451.89089, + "finish": 1719841451.95846, + "duration": 0.0675740242004394, + "processing": 0.0360250473022461, + "date_start": "2024-07-01T13:44:11+00:00", + "date_finish": "2024-07-01T13:44:11+00:00", + "operating_reset_at": 1719842051, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md index 4b173477ca..9c4bf3eda7 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md @@ -1,84 +1,84 @@ ---- -sidebar_position: 10 ---- - -# Переименовать каталог - Изменяет имя каталога - - - -`Функция ПереименоватьКаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Наименование | --title | Строка | Новое наименование каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новый каталог"; - Наименование2 = "Новый каталог 2"; - - IDКаталога2 = "5014"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); - - IDКаталога = "5016"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереименоватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "936", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:01+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1719841443.11172, - "finish": 1719841443.16013, - "duration": 0.0484049320220947, - "processing": 0.0123419761657715, - "date_start": "2024-07-01T13:44:03+00:00", - "date_finish": "2024-07-01T13:44:03+00:00", - "operating_reset_at": 1719842043, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Переименовать каталог + Изменяет имя каталога + + + +`Функция ПереименоватьКаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + IDКаталога2 = "5014"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); + + IDКаталога = "5016"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереименоватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "936", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:01+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1719841443.11172, + "finish": 1719841443.16013, + "duration": 0.0484049320220947, + "processing": 0.0123419761657715, + "date_start": "2024-07-01T13:44:03+00:00", + "date_finish": "2024-07-01T13:44:03+00:00", + "operating_reset_at": 1719842043, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md index c3d3a4e59e..f36c235109 100644 --- a/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 9 ---- - -# Восстановить каталог - Восстанавливает каталог из корзины - - - -`Функция ВосстановитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКаталога = "5016"; - - Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВосстановитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "936", - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": "936", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "CREATE_TIME": "2024-07-01T13:44:01+00:00", - "UPDATE_TIME": "2024-07-01T13:44:13+00:00", - "DELETE_TIME": "2024-07-01T13:44:12+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1719841454.36238, - "finish": 1719841454.40451, - "duration": 0.0421350002288818, - "processing": 0.00979709625244141, - "date_start": "2024-07-01T13:44:14+00:00", - "date_finish": "2024-07-01T13:44:14+00:00", - "operating_reset_at": 1719842054, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Восстановить каталог + Восстанавливает каталог из корзины + + + +`Функция ВосстановитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКаталога = "5016"; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВосстановитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "936", + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": "936", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "CREATE_TIME": "2024-07-01T13:44:01+00:00", + "UPDATE_TIME": "2024-07-01T13:44:13+00:00", + "DELETE_TIME": "2024-07-01T13:44:12+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1719841454.36238, + "finish": 1719841454.40451, + "duration": 0.0421350002288818, + "processing": 0.00979709625244141, + "date_start": "2024-07-01T13:44:14+00:00", + "date_finish": "2024-07-01T13:44:14+00:00", + "operating_reset_at": 1719842054, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md index 5ab4abedc2..9b5e16e2eb 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 5 ---- - -# Добавить пользователей в чат - Добавляет пользователей в чат по массиву ID - - - -`Функция ДобавитьПользователейВЧат(Знач URL, Знач IDЧата, Знач IDПользователей, Знач СкрытьИсторию = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователей | --users | Массив из Строка, Число | ID пользователей для добавления | - | СкрытьИсторию | --hide | Булево | Скрыть старые сообщения от новых пользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - IDПользователей = Новый Массив; - IDПользователей.Добавить(10); - IDПользователей.Добавить(12); - - Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователя, Истина, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьПользователейВЧат --url %url% --chat %chat% --users %users% --hide %hide% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865686.43672, - "finish": 1720865686.52541, - "duration": 0.0886859893798828, - "processing": 0.0491659641265869, - "date_start": "2024-07-13T10:14:46+00:00", - "date_finish": "2024-07-13T10:14:46+00:00", - "operating_reset_at": 1720866286, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Добавить пользователей в чат + Добавляет пользователей в чат по массиву ID + + + +`Функция ДобавитьПользователейВЧат(Знач URL, Знач IDЧата, Знач IDПользователей, Знач СкрытьИсторию = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователей | --users | Массив из Строка, Число | ID пользователей для добавления | + | СкрытьИсторию | --hide | Булево | Скрыть старые сообщения от новых пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + IDПользователей = Новый Массив; + IDПользователей.Добавить(10); + IDПользователей.Добавить(12); + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователя, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьПользователейВЧат --url %url% --chat %chat% --users %users% --hide %hide% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865686.43672, + "finish": 1720865686.52541, + "duration": 0.0886859893798828, + "processing": 0.0491659641265869, + "date_start": "2024-07-13T10:14:46+00:00", + "date_finish": "2024-07-13T10:14:46+00:00", + "operating_reset_at": 1720866286, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md index 286936f0cf..3904c79e5b 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 8 ---- - -# Изменить цвет чата - Изменяет цвет чата для мобильного приложения - - - -`Функция ИзменитьЦветЧата(Знач URL, Знач IDЧата, Знач Цвет, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Цвет | --color | Строка | Новый цвет чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) - - Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Цвет = "AZURE"; - - Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Цвет = "PURPLE"; - - Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьЦветЧата --url %url% --chat %chat% --color %color% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865688.95778, - "finish": 1720865689.02493, - "duration": 0.0671589374542236, - "processing": 0.0428512096405029, - "date_start": "2024-07-13T10:14:48+00:00", - "date_finish": "2024-07-13T10:14:49+00:00", - "operating_reset_at": 1720866288, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Изменить цвет чата + Изменяет цвет чата для мобильного приложения + + + +`Функция ИзменитьЦветЧата(Знач URL, Знач IDЧата, Знач Цвет, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Цвет | --color | Строка | Новый цвет чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Цвет = "AZURE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Цвет = "PURPLE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЦветЧата --url %url% --chat %chat% --color %color% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865688.95778, + "finish": 1720865689.02493, + "duration": 0.0671589374542236, + "processing": 0.0428512096405029, + "date_start": "2024-07-13T10:14:48+00:00", + "date_finish": "2024-07-13T10:14:49+00:00", + "operating_reset_at": 1720866288, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md index ad48e68c49..58ecc4d98e 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 10 ---- - -# Сменить владельца чата - Изменяет пользователя владельца чата - - - -`Функция СменитьВладельцаЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователя | --user | Строка, Число | ID пользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - IDПользователя = 10; - - Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СменитьВладельцаЧата --url %url% --chat %chat% --user %user% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865697.10595, - "finish": 1720865697.13924, - "duration": 0.0332820415496826, - "processing": 0.0104668140411377, - "date_start": "2024-07-13T10:14:57+00:00", - "date_finish": "2024-07-13T10:14:57+00:00", - "operating_reset_at": 1720866297, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Сменить владельца чата + Изменяет пользователя владельца чата + + + +`Функция СменитьВладельцаЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СменитьВладельцаЧата --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865697.10595, + "finish": 1720865697.13924, + "duration": 0.0332820415496826, + "processing": 0.0104668140411377, + "date_start": "2024-07-13T10:14:57+00:00", + "date_finish": "2024-07-13T10:14:57+00:00", + "operating_reset_at": 1720866297, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md index 1513887aa7..283068f49e 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 9 ---- - -# Изменить картинку чата - Устанавливает новую картинку чата - - - -`Функция ИзменитьКартинкуЧата(Знач URL, Знач IDЧата, Знач Картинка, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Картинка | --picture | Строка, ДвоичныеДанные | Данные файла картинки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; - - Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьКартинкуЧата --url %url% --chat %chat% --picture %picture% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865692.90718, - "finish": 1720865693.81896, - "duration": 0.91178297996521, - "processing": 0.884725093841553, - "date_start": "2024-07-13T10:14:52+00:00", - "date_finish": "2024-07-13T10:14:53+00:00", - "operating_reset_at": 1720866292, - "operating": 0.884703874588013 - } -} -``` +--- +sidebar_position: 9 +--- + +# Изменить картинку чата + Устанавливает новую картинку чата + + + +`Функция ИзменитьКартинкуЧата(Знач URL, Знач IDЧата, Знач Картинка, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Картинка | --picture | Строка, ДвоичныеДанные | Данные файла картинки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьКартинкуЧата --url %url% --chat %chat% --picture %picture% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865692.90718, + "finish": 1720865693.81896, + "duration": 0.91178297996521, + "processing": 0.884725093841553, + "date_start": "2024-07-13T10:14:52+00:00", + "date_finish": "2024-07-13T10:14:53+00:00", + "operating_reset_at": 1720866292, + "operating": 0.884703874588013 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md index 4e145378b3..edf2199f2e 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 7 ---- - -# Изменить заголовок чата - Изменяет текст заголовка чата - - - -`Функция ИзменитьЗаголовокЧата(Знач URL, Знач IDЧата, Знач Заголовок, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Заголовок | --title | Строка | Новый текст заголовка | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Заголовок = "Новый заголовок чата"; - - Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Заголовок = "Другой заголовок чата"; - - Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьЗаголовокЧата --url %url% --chat %chat% --title %title% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865687.70928, - "finish": 1720865687.78107, - "duration": 0.0717928409576416, - "processing": 0.0479631423950195, - "date_start": "2024-07-13T10:14:47+00:00", - "date_finish": "2024-07-13T10:14:47+00:00", - "operating_reset_at": 1720866287, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Изменить заголовок чата + Изменяет текст заголовка чата + + + +`Функция ИзменитьЗаголовокЧата(Знач URL, Знач IDЧата, Знач Заголовок, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Заголовок | --title | Строка | Новый текст заголовка | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Заголовок = "Новый заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Заголовок = "Другой заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЗаголовокЧата --url %url% --chat %chat% --title %title% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865687.70928, + "finish": 1720865687.78107, + "duration": 0.0717928409576416, + "processing": 0.0479631423950195, + "date_start": "2024-07-13T10:14:47+00:00", + "date_finish": "2024-07-13T10:14:47+00:00", + "operating_reset_at": 1720866287, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md index 422eaff7c6..ae835701f1 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 1 ---- - -# Создать чат - Создает новый чат на основе структуры полей - - - -`Функция СоздатьЧат(Знач URL, Знач СтруктураЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураЧата | --fields | Структура Из КлючИЗначение | Структура полей чата. См. ПолучитьСтруктуруЧата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) -::: -
- - -```bsl title="Пример кода" - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; - OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); - - B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); - - МассивУчастников = Новый Массив; - МассивУчастников.Добавить(10); - МассивУчастников.Добавить(1); - - СтруктураЧата = Новый Структура; - СтруктураЧата.Вставить("TYPE" , "OPEN"); - СтруктураЧата.Вставить("TITLE" , "Новый чат"); - СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); - СтруктураЧата.Вставить("COLOR" , "GREEN"); - СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); - СтруктураЧата.Вставить("USERS" , МассивУчастников); - СтруктураЧата.Вставить("AVATAR" , B64Картинка); - СтруктураЧата.Вставить("OWNER_ID" , 1); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - СтруктураЧата = Новый Структура; - СтруктураЧата.Вставить("TYPE" , "CHAT"); - СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); - СтруктураЧата.Вставить("USERS" , МассивУчастников); - - Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьЧат --url %url% --fields %fields% --token %token% - -``` - -```json title="Результат" -{ - "result": 26, - "time": { - "start": 1720816597.42171, - "finish": 1720816597.52933, - "duration": 0.107618093490601, - "processing": 0.081672191619873, - "date_start": "2024-07-12T20:36:37+00:00", - "date_finish": "2024-07-12T20:36:37+00:00", - "operating_reset_at": 1720817197, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Создать чат + Создает новый чат на основе структуры полей + + + +`Функция СоздатьЧат(Знач URL, Знач СтруктураЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураЧата | --fields | Структура Из КлючИЗначение | Структура полей чата. См. ПолучитьСтруктуруЧата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Пример кода" + Картинка = "https://openintegrations.dev/test_data/picture.jpg"; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); + + B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); + + МассивУчастников = Новый Массив; + МассивУчастников.Добавить(10); + МассивУчастников.Добавить(1); + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "OPEN"); + СтруктураЧата.Вставить("TITLE" , "Новый чат"); + СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); + СтруктураЧата.Вставить("COLOR" , "GREEN"); + СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + СтруктураЧата.Вставить("AVATAR" , B64Картинка); + СтруктураЧата.Вставить("OWNER_ID" , 1); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "CHAT"); + СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьЧат --url %url% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "result": 26, + "time": { + "start": 1720816597.42171, + "finish": 1720816597.52933, + "duration": 0.107618093490601, + "processing": 0.081672191619873, + "date_start": "2024-07-12T20:36:37+00:00", + "date_finish": "2024-07-12T20:36:37+00:00", + "operating_reset_at": 1720817197, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md index 7577204bd5..24fe18c413 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 6 ---- - -# Исключить пользователя из чата - Исключает выбранного пользователя из чата - - - -`Функция ИсключитьПользователяИзЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDПользователя | --user | Строка, Число | ID пользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - IDПользователя = 10; - - Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИсключитьПользователяИзЧата --url %url% --chat %chat% --user %user% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865685.25089, - "finish": 1720865685.32425, - "duration": 0.0733590126037598, - "processing": 0.0480890274047852, - "date_start": "2024-07-13T10:14:45+00:00", - "date_finish": "2024-07-13T10:14:45+00:00", - "operating_reset_at": 1720866285, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Исключить пользователя из чата + Исключает выбранного пользователя из чата + + + +`Функция ИсключитьПользователяИзЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИсключитьПользователяИзЧата --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865685.25089, + "finish": 1720865685.32425, + "duration": 0.0733590126037598, + "processing": 0.0480890274047852, + "date_start": "2024-07-13T10:14:45+00:00", + "date_finish": "2024-07-13T10:14:45+00:00", + "operating_reset_at": 1720866285, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md index 72acbbc836..484bc08b2a 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 11 ---- - -# Отключить уведомления чата - Отключает уведомлений чата - - - -`Функция ОтключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтключитьУведомленияЧата --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865694.86568, - "finish": 1720865694.9092, - "duration": 0.0435128211975098, - "processing": 0.0169928073883057, - "date_start": "2024-07-13T10:14:54+00:00", - "date_finish": "2024-07-13T10:14:54+00:00", - "operating_reset_at": 1720866294, - "operating": 0 - } -} -``` +--- +sidebar_position: 11 +--- + +# Отключить уведомления чата + Отключает уведомлений чата + + + +`Функция ОтключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтключитьУведомленияЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865694.86568, + "finish": 1720865694.9092, + "duration": 0.0435128211975098, + "processing": 0.0169928073883057, + "date_start": "2024-07-13T10:14:54+00:00", + "date_finish": "2024-07-13T10:14:54+00:00", + "operating_reset_at": 1720866294, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md index d6ff4cab4d..6adce3c6e7 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 12 ---- - -# Включить уведомления чата - Включает уведомления в чате - - - -`Функция ВключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВключитьУведомленияЧата --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720865695.99933, - "finish": 1720865696.04205, - "duration": 0.0427119731903076, - "processing": 0.0170090198516846, - "date_start": "2024-07-13T10:14:55+00:00", - "date_finish": "2024-07-13T10:14:56+00:00", - "operating_reset_at": 1720866296, - "operating": 0 - } -} -``` +--- +sidebar_position: 12 +--- + +# Включить уведомления чата + Включает уведомления в чате + + + +`Функция ВключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВключитьУведомленияЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865695.99933, + "finish": 1720865696.04205, + "duration": 0.0427119731903076, + "processing": 0.0170090198516846, + "date_start": "2024-07-13T10:14:55+00:00", + "date_finish": "2024-07-13T10:14:56+00:00", + "operating_reset_at": 1720866296, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md index 42b80e44a2..45b8ab333f 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 20 ---- - -# Получить каталог файлов чата - Получает каталог для хранения фйлов чата - - - -`Функция ПолучитьКаталогФайловЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьКаталогФайловЧата --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": 3250 - }, - "time": { - "start": 1720969169.10256, - "finish": 1720969169.1584, - "duration": 0.0558350086212158, - "processing": 0.0327038764953613, - "date_start": "2024-07-14T14:59:29+00:00", - "date_finish": "2024-07-14T14:59:29+00:00", - "operating_reset_at": 1720969769, - "operating": 0 - } -} -``` +--- +sidebar_position: 20 +--- + +# Получить каталог файлов чата + Получает каталог для хранения фйлов чата + + + +`Функция ПолучитьКаталогФайловЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьКаталогФайловЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": 3250 + }, + "time": { + "start": 1720969169.10256, + "finish": 1720969169.1584, + "duration": 0.0558350086212158, + "processing": 0.0327038764953613, + "date_start": "2024-07-14T14:59:29+00:00", + "date_finish": "2024-07-14T14:59:29+00:00", + "operating_reset_at": 1720969769, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md index 5da938c012..13ba13594d 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -1,120 +1,120 @@ ---- -sidebar_position: 15 ---- - -# Получить список пользователей диалога - Получает список участников далога - - - -`Функция ПолучитьСписокПользователейДиалога(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокПользователейДиалога --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "bot_data": null - }, - { - "id": 1, - "active": true, - "name": "Антон Титовец", - "first_name": "Антон", - "last_name": "Титовец", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-14T09:00:58+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "bot_data": null - } - ], - "total": 2, - "time": { - "start": 1720969161.4388, - "finish": 1720969161.46946, - "duration": 0.0306570529937744, - "processing": 0.00571608543395996, - "date_start": "2024-07-14T14:59:21+00:00", - "date_finish": "2024-07-14T14:59:21+00:00", - "operating_reset_at": 1720969761, - "operating": 0 - } -} -``` +--- +sidebar_position: 15 +--- + +# Получить список пользователей диалога + Получает список участников далога + + + +`Функция ПолучитьСписокПользователейДиалога(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокПользователейДиалога --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1720969161.4388, + "finish": 1720969161.46946, + "duration": 0.0306570529937744, + "processing": 0.00571608543395996, + "date_start": "2024-07-14T14:59:21+00:00", + "date_finish": "2024-07-14T14:59:21+00:00", + "operating_reset_at": 1720969761, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md index e5a3f2ed83..c211d619a2 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -1,399 +1,399 @@ ---- -sidebar_position: 13 ---- - -# Получить список сообщений чата - Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего - - - -`Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDПоследнего | --last | Строка, Число | ID последнего загруженного сообщения | - | IDПервого | --first | Строка, Число | ID первого загруженного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat4"; - - Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокСообщенийЧата --url %url% --chat %chat% --last %last% --first %first% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "chat_id": 10, - "messages": [ - { - "id": 3854, - "chat_id": 10, - "author_id": 10, - "date": "2024-07-13T14:54:43+00:00", - "text": "Записал", - "unread": false, - "uuid": "700d361d-8324-47fb-b989-647949c1c899", - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4286, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T16:06:51+00:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4366, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T16:40:58+00:00", - "text": "Message text", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4406, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T19:57:33+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4446, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:21:27+00:00", - "text": "Текст сообщения", - "unread": false, - "uuid": null, - "replaces": [], - "params": [], - "disappearing_date": null - }, - { - "id": 4486, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:22:30+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4526, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-13T20:41:21+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4668, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:10:33+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4708, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:22:56+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4748, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:26:01+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4788, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:28:01+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4828, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:28:36+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4868, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:30:18+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4908, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:52:24+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4948, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:53:31+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 4990, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:57:06+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5060, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T08:59:43+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5140, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T09:29:40+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5182, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T09:35:56+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - }, - { - "id": 5262, - "chat_id": 10, - "author_id": 1, - "date": "2024-07-14T11:27:54+00:00", - "text": "Это сообщение было удалено", - "unread": false, - "uuid": null, - "replaces": [], - "params": { - "IS_DELETED": "Y" - }, - "disappearing_date": null - } - ], - "users": [ - { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "desktop_last_date": false - }, - { - "id": 1, - "active": true, - "name": "Антон Титовец", - "first_name": "Антон", - "last_name": "Титовец", - "work_position": null, - "color": "#df532d", - "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-14T09:00:58+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false, - "desktop_last_date": false - } - ], - "files": [] - }, - "time": { - "start": 1720969156.38474, - "finish": 1720969156.42064, - "duration": 0.0358970165252686, - "processing": 0.0108029842376709, - "date_start": "2024-07-14T14:59:16+00:00", - "date_finish": "2024-07-14T14:59:16+00:00", - "operating_reset_at": 1720969756, - "operating": 0 - } -} -``` +--- +sidebar_position: 13 +--- + +# Получить список сообщений чата + Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего + + + +`Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDПоследнего | --last | Строка, Число | ID последнего загруженного сообщения | + | IDПервого | --first | Строка, Число | ID первого загруженного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat4"; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокСообщенийЧата --url %url% --chat %chat% --last %last% --first %first% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T14:54:43+00:00", + "text": "Записал", + "unread": false, + "uuid": "700d361d-8324-47fb-b989-647949c1c899", + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:06:51+00:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:40:58+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:57:33+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:21:27+00:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:22:30+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:41:21+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:10:33+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4708, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:22:56+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4748, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:26:01+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4788, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:01+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4828, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:36+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4868, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:30:18+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4908, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:52:24+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4948, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:53:31+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4990, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:57:06+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5060, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:59:43+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5140, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:29:40+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5182, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:35:56+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5262, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T11:27:54+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + } + ], + "users": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + } + ], + "files": [] + }, + "time": { + "start": 1720969156.38474, + "finish": 1720969156.42064, + "duration": 0.0358970165252686, + "processing": 0.0108029842376709, + "date_start": "2024-07-14T14:59:16+00:00", + "date_finish": "2024-07-14T14:59:16+00:00", + "operating_reset_at": 1720969756, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md index 72e67ea15a..f220a26000 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 21 ---- - -# Получить структуру чата - Получает структуру полей чата - - - -`Функция ПолучитьСтруктуруЧата(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтруктуруЧата --empty %empty% - -``` - - +--- +sidebar_position: 21 +--- + +# Получить структуру чата + Получает структуру полей чата + + + +`Функция ПолучитьСтруктуруЧата(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтруктуруЧата --empty %empty% + +``` + + diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md index 92d06288fc..8fc28d0413 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 2 ---- - -# Получить список пользователей чата - Получает список пользователей чата по ID - - - -`Функция ПолучитьСписокПользователейЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокПользователейЧата --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - 1, - 10 - ], - "time": { - "start": 1720816598.61771, - "finish": 1720816598.64882, - "duration": 0.0311079025268555, - "processing": 0.00316882133483887, - "date_start": "2024-07-12T20:36:38+00:00", - "date_finish": "2024-07-12T20:36:38+00:00", - "operating_reset_at": 1720817198, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Получить список пользователей чата + Получает список пользователей чата по ID + + + +`Функция ПолучитьСписокПользователейЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокПользователейЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1720816598.61771, + "finish": 1720816598.64882, + "duration": 0.0311079025268555, + "processing": 0.00316882133483887, + "date_start": "2024-07-12T20:36:38+00:00", + "date_finish": "2024-07-12T20:36:38+00:00", + "operating_reset_at": 1720817198, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md index c835e2708b..3ac6c5ffce 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -1,133 +1,133 @@ ---- -sidebar_position: 14 ---- - -# Получить диалог - Получает информацию о диалоге по ID - - - -`Функция ПолучитьДиалог(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - - Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьДиалог --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "id": 10, - "parent_chat_id": 0, - "parent_message_id": 0, - "name": "", - "description": "", - "owner": 10, - "extranet": false, - "avatar": "", - "color": "#ab7761", - "type": "private", - "counter": 1, - "user_counter": 0, - "message_count": 24, - "unread_id": 3854, - "restrictions": { - "avatar": true, - "rename": true, - "extend": true, - "call": true, - "mute": true, - "leave": true, - "leave_owner": true, - "send": true, - "user_list": true - }, - "last_message_id": 5262, - "last_id": 3852, - "marked_id": 0, - "disk_folder_id": 0, - "entity_type": "", - "entity_id": "", - "entity_data_1": "", - "entity_data_2": "", - "entity_data_3": "", - "mute_list": [], - "date_create": "2024-06-15T16:48:49+00:00", - "message_type": "P", - "disappearing_time": 0, - "public": "", - "role": "member", - "entity_link": { - "type": "", - "url": "" - }, - "permissions": { - "manage_users_add": "member", - "manage_users_delete": "manager", - "manage_ui": "member", - "manage_settings": "owner", - "manage_messages": "member", - "can_post": "member" - }, - "is_new": false, - "readed_list": [ - { - "user_id": 10, - "user_name": "Techno Pizza", - "message_id": 3854, - "date": null - } - ], - "manager_list": [], - "last_message_views": { - "message_id": 5262, - "first_viewers": [], - "count_of_viewers": 0 - }, - "dialog_id": "10" - }, - "time": { - "start": 1720969160.19046, - "finish": 1720969160.22782, - "duration": 0.037362813949585, - "processing": 0.0134620666503906, - "date_start": "2024-07-14T14:59:20+00:00", - "date_finish": "2024-07-14T14:59:20+00:00", - "operating_reset_at": 1720969760, - "operating": 0 - } -} -``` +--- +sidebar_position: 14 +--- + +# Получить диалог + Получает информацию о диалоге по ID + + + +`Функция ПолучитьДиалог(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьДиалог --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 1, + "user_counter": 0, + "message_count": 24, + "unread_id": 3854, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 5262, + "last_id": 3852, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T16:48:49+00:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 5262, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1720969160.19046, + "finish": 1720969160.22782, + "duration": 0.037362813949585, + "processing": 0.0134620666503906, + "date_start": "2024-07-14T14:59:20+00:00", + "date_finish": "2024-07-14T14:59:20+00:00", + "operating_reset_at": 1720969760, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md index 21ec3df676..9f9f4bf816 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md @@ -1,52 +1,52 @@ ---- -sidebar_position: 17 ---- - -# Получить статус пользователя - Получает статус (онлайн) текущего пользователя - - - -`Функция ПолучитьСтатусПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтатусПользователя --url %url% --token %token% - -``` - -```json title="Результат" -{ - "error": "expired_token", - "error_description": "The access token provided has expired." -} -``` +--- +sidebar_position: 17 +--- + +# Получить статус пользователя + Получает статус (онлайн) текущего пользователя + + + +`Функция ПолучитьСтатусПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтатусПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтатусПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "error": "expired_token", + "error_description": "The access token provided has expired." +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md index eb4acaf815..ac48e8f23e 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md @@ -1,94 +1,94 @@ ---- -sidebar_position: 4 ---- - -# Получить пользователей - Получает информацию о пользователях для диалога - - - -`Функция ПолучитьПользователей(Знач URL, Знач IDПользователей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователей | --users | Массив Из Строка, Число | ID пользователя или нескольких пользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - МассивПользователей = Новый Массив; - - МассивПользователей.Добавить(1); - МассивПользователей.Добавить(10); - - Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователей = 10; - - Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьПользователей --url %url% --users %users% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "10": { - "id": 10, - "active": true, - "name": "Techno Pizza", - "first_name": "Techno", - "last_name": "Pizza", - "work_position": null, - "color": "#ab7761", - "avatar": "", - "gender": "M", - "birthday": "", - "extranet": false, - "network": false, - "bot": false, - "connector": false, - "external_auth_id": "socservices", - "status": "online", - "idle": false, - "last_activity_date": "2024-07-13T18:36:23+00:00", - "mobile_last_date": false, - "absent": false, - "departments": [ - 1 - ], - "phones": false - } - }, - "time": { - "start": 1722083796.56495, - "finish": 1722083796.59641, - "duration": 0.031451940536499, - "processing": 0.00229191780090332, - "date_start": "2024-07-27T12:36:36+00:00", - "date_finish": "2024-07-27T12:36:36+00:00", - "operating_reset_at": 1722084396, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Получить пользователей + Получает информацию о пользователях для диалога + + + +`Функция ПолучитьПользователей(Знач URL, Знач IDПользователей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователей | --users | Массив Из Строка, Число | ID пользователя или нескольких пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + МассивПользователей = Новый Массив; + + МассивПользователей.Добавить(1); + МассивПользователей.Добавить(10); + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, МассивПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователей = 10; + + Результат = OPI_Bitrix24.ПолучитьПользователей(URL, IDПользователей, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПользователей --url %url% --users %users% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "10": { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false + } + }, + "time": { + "start": 1722083796.56495, + "finish": 1722083796.59641, + "duration": 0.031451940536499, + "processing": 0.00229191780090332, + "date_start": "2024-07-27T12:36:36+00:00", + "date_finish": "2024-07-27T12:36:36+00:00", + "operating_reset_at": 1722084396, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md index a852deaea4..a61da29c5f 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Покинуть чат - Исключает текущего пользователя из чата - - - -`Функция ПокинутьЧат(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - - Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПокинутьЧат --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720816599.74716, - "finish": 1720816599.81746, - "duration": 0.0702948570251465, - "processing": 0.0438079833984375, - "date_start": "2024-07-12T20:36:39+00:00", - "date_finish": "2024-07-12T20:36:39+00:00", - "operating_reset_at": 1720817199, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Покинуть чат + Исключает текущего пользователя из чата + + + +`Функция ПокинутьЧат(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПокинутьЧат --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816599.74716, + "finish": 1720816599.81746, + "duration": 0.0702948570251465, + "processing": 0.0438079833984375, + "date_start": "2024-07-12T20:36:39+00:00", + "date_finish": "2024-07-12T20:36:39+00:00", + "operating_reset_at": 1720817199, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md index 2a94f21434..249ad8b7ba 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 19 ---- - -# Прочитать все - Отмечает все сообщения во всех доступных чатах как прочитанные - - - -`Функция ПрочитатьВсе(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПрочитатьВсе(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПрочитатьВсе --url %url% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969176.30834, - "finish": 1720969176.34001, - "duration": 0.0316698551177978, - "processing": 0.00501918792724609, - "date_start": "2024-07-14T14:59:36+00:00", - "date_finish": "2024-07-14T14:59:36+00:00", - "operating_reset_at": 1720969776, - "operating": 0 - } -} -``` +--- +sidebar_position: 19 +--- + +# Прочитать все + Отмечает все сообщения во всех доступных чатах как прочитанные + + + +`Функция ПрочитатьВсе(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПрочитатьВсе --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969176.30834, + "finish": 1720969176.34001, + "duration": 0.0316698551177978, + "processing": 0.00501918792724609, + "date_start": "2024-07-14T14:59:36+00:00", + "date_finish": "2024-07-14T14:59:36+00:00", + "operating_reset_at": 1720969776, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md index b88667c94c..6b714e39ba 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 16 ---- - -# Отправить уведомление о вводе - Отправляет в чат статус Вам пишут... - - - -`Функция ОтправитьУведомлениеОВводе(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - - Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтправитьУведомлениеОВводе --url %url% --chat %chat% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969162.6704, - "finish": 1720969162.69719, - "duration": 0.0267889499664307, - "processing": 0.000684022903442383, - "date_start": "2024-07-14T14:59:22+00:00", - "date_finish": "2024-07-14T14:59:22+00:00", - "operating_reset_at": 1720969762, - "operating": 0 - } -} -``` +--- +sidebar_position: 16 +--- + +# Отправить уведомление о вводе + Отправляет в чат статус Вам пишут... + + + +`Функция ОтправитьУведомлениеОВводе(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьУведомлениеОВводе --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969162.6704, + "finish": 1720969162.69719, + "duration": 0.0267889499664307, + "processing": 0.000684022903442383, + "date_start": "2024-07-14T14:59:22+00:00", + "date_finish": "2024-07-14T14:59:22+00:00", + "operating_reset_at": 1720969762, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md index 855080cccd..35909b1af1 100644 --- a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 18 ---- - -# Установить статус пользователя - Устанавливает статус (онлайн) текущего пользователя - - - -`Функция УстановитьСтатусПользователя(Знач URL, Знач Статус, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Статус | --status | Строка, Число | Статус пользователя: online, dnd, away | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Статус = "dnd"; - - Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - Статус = "away"; - - Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УстановитьСтатусПользователя --url %url% --status %status% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722083795.3692, - "finish": 1722083795.39818, - "duration": 0.0289750099182129, - "processing": 0.00522208213806152, - "date_start": "2024-07-27T12:36:35+00:00", - "date_finish": "2024-07-27T12:36:35+00:00", - "operating_reset_at": 1722084395, - "operating": 0 - } -} -``` +--- +sidebar_position: 18 +--- + +# Установить статус пользователя + Устанавливает статус (онлайн) текущего пользователя + + + +`Функция УстановитьСтатусПользователя(Знач URL, Знач Статус, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Статус | --status | Строка, Число | Статус пользователя: online, dnd, away | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Статус = "dnd"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + Статус = "away"; + + Результат = OPI_Bitrix24.УстановитьСтатусПользователя(URL, Статус, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УстановитьСтатусПользователя --url %url% --status %status% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722083795.3692, + "finish": 1722083795.39818, + "duration": 0.0289750099182129, + "processing": 0.00522208213806152, + "date_start": "2024-07-27T12:36:35+00:00", + "date_finish": "2024-07-27T12:36:35+00:00", + "operating_reset_at": 1722084395, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md index ca9989fe52..e8487c6088 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 3 ---- - -# Добавить комментарий задачи - Создает комментарий к задаче - - - -`Функция ДобавитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1082"; - - Текст = "Задача невыполнима, расходимся"; - - Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Текст = "Задача выполнима, не расходимся"; - - Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": 1376, - "time": { - "start": 1720186702.77405, - "finish": 1720186703.52768, - "duration": 0.753632068634033, - "processing": 0.724568128585816, - "date_start": "2024-07-05T13:38:22+00:00", - "date_finish": "2024-07-05T13:38:23+00:00", - "operating_reset_at": 1720187302, - "operating": 0.724542856216431 - } -} -``` +--- +sidebar_position: 3 +--- + +# Добавить комментарий задачи + Создает комментарий к задаче + + + +`Функция ДобавитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1082"; + + Текст = "Задача невыполнима, расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Текст = "Задача выполнима, не расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": 1376, + "time": { + "start": 1720186702.77405, + "finish": 1720186703.52768, + "duration": 0.753632068634033, + "processing": 0.724568128585816, + "date_start": "2024-07-05T13:38:22+00:00", + "date_finish": "2024-07-05T13:38:23+00:00", + "operating_reset_at": 1720187302, + "operating": 0.724542856216431 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md index adb3dff761..53a21a5892 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 7 ---- - -# Создать результат из комментария - Создает результат задачи из комментария - - - -`Функция СоздатьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКомментария = "2932"; - - Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКомментария = "2936"; - - Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "id": 130, - "taskId": 432, - "commentId": 1376, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:22+00:00", - "updatedAt": "2024-07-05T13:38:22+00:00", - "status": 0, - "text": "Задача изменена, расходимся", - "formattedText": "Задача изменена, расходимся", - "files": null - }, - "time": { - "start": 1720186706.85195, - "finish": 1720186706.92671, - "duration": 0.0747611522674561, - "processing": 0.0460391044616699, - "date_start": "2024-07-05T13:38:26+00:00", - "date_finish": "2024-07-05T13:38:26+00:00", - "operating_reset_at": 1720187306, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Создать результат из комментария + Создает результат задачи из комментария + + + +`Функция СоздатьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКомментария = "2932"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКомментария = "2936"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "id": 130, + "taskId": 432, + "commentId": 1376, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:22+00:00", + "updatedAt": "2024-07-05T13:38:22+00:00", + "status": 0, + "text": "Задача изменена, расходимся", + "formattedText": "Задача изменена, расходимся", + "files": null + }, + "time": { + "start": 1720186706.85195, + "finish": 1720186706.92671, + "duration": 0.0747611522674561, + "processing": 0.0460391044616699, + "date_start": "2024-07-05T13:38:26+00:00", + "date_finish": "2024-07-05T13:38:26+00:00", + "operating_reset_at": 1720187306, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md index b791860073..e547ed2a0c 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 8 ---- - -# Удалить результат из комментария - Удаляет ранее созданный результат из комментария - - - -`Функция УдалитьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКомментария = "2932"; - - Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКомментария = "2936"; - - Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1720295536.04613, - "finish": 1720295536.09868, - "duration": 0.0525519847869873, - "processing": 0.0231878757476807, - "date_start": "2024-07-06T19:52:16+00:00", - "date_finish": "2024-07-06T19:52:16+00:00", - "operating_reset_at": 1720296136, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Удалить результат из комментария + Удаляет ранее созданный результат из комментария + + + +`Функция УдалитьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКомментария = "2932"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКомментария = "2936"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720295536.04613, + "finish": 1720295536.09868, + "duration": 0.0525519847869873, + "processing": 0.0231878757476807, + "date_start": "2024-07-06T19:52:16+00:00", + "date_finish": "2024-07-06T19:52:16+00:00", + "operating_reset_at": 1720296136, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md index 5b3ce74147..eb59618f22 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 5 ---- - -# Удалить комментарий - Удаляет существующий комментарий задачи - - - -`Функция УдалитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID удаляемого комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1082"; - IDКомментария = "2932"; - - Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКомментария = "2936"; - - Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720295541.27592, - "finish": 1720295541.38076, - "duration": 0.104840040206909, - "processing": 0.0781040191650391, - "date_start": "2024-07-06T19:52:21+00:00", - "date_finish": "2024-07-06T19:52:21+00:00", - "operating_reset_at": 1720296141, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Удалить комментарий + Удаляет существующий комментарий задачи + + + +`Функция УдалитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID удаляемого комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1082"; + IDКомментария = "2932"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКомментария = "2936"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720295541.27592, + "finish": 1720295541.38076, + "duration": 0.104840040206909, + "processing": 0.0781040191650391, + "date_start": "2024-07-06T19:52:21+00:00", + "date_finish": "2024-07-06T19:52:21+00:00", + "operating_reset_at": 1720296141, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md index ed504d0b47..20957b5e00 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 9 ---- - -# Получить структуру комментария - Получает структуру полей комментария - - - -`Функция ПолучитьСтруктуруКомментария(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтруктуруКомментария --empty %empty% - -``` - - +--- +sidebar_position: 9 +--- + +# Получить структуру комментария + Получает структуру полей комментария + + + +`Функция ПолучитьСтруктуруКомментария(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтруктуруКомментария --empty %empty% + +``` + + diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md index ef5240a095..d91bfde373 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -1,88 +1,88 @@ ---- -sidebar_position: 6 ---- - -# Получить список результатов - Получает список результатов задачи - - - -`Функция ПолучитьСписокРезультатов(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1082"; - - Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокРезультатов --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "id": 130, - "taskId": 432, - "commentId": 1376, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:22+00:00", - "updatedAt": "2024-07-05T13:38:22+00:00", - "status": 0, - "text": "Задача изменена, расходимся", - "formattedText": "Задача изменена, расходимся", - "files": [] - }, - { - "id": 128, - "taskId": 432, - "commentId": 1374, - "createdBy": 1, - "createdAt": "2024-07-05T13:38:21+00:00", - "updatedAt": "2024-07-05T13:38:21+00:00", - "status": 0, - "text": "Задача изменена, не расходимся", - "formattedText": "Задача изменена, не расходимся", - "files": [] - } - ], - "time": { - "start": 1720186708.49595, - "finish": 1720186708.54066, - "duration": 0.044705867767334, - "processing": 0.00980901718139648, - "date_start": "2024-07-05T13:38:28+00:00", - "date_finish": "2024-07-05T13:38:28+00:00", - "operating_reset_at": 1720187308, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Получить список результатов + Получает список результатов задачи + + + +`Функция ПолучитьСписокРезультатов(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1082"; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокРезультатов --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "id": 130, + "taskId": 432, + "commentId": 1376, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:22+00:00", + "updatedAt": "2024-07-05T13:38:22+00:00", + "status": 0, + "text": "Задача изменена, расходимся", + "formattedText": "Задача изменена, расходимся", + "files": [] + }, + { + "id": 128, + "taskId": 432, + "commentId": 1374, + "createdBy": 1, + "createdAt": "2024-07-05T13:38:21+00:00", + "updatedAt": "2024-07-05T13:38:21+00:00", + "status": 0, + "text": "Задача изменена, не расходимся", + "formattedText": "Задача изменена, не расходимся", + "files": [] + } + ], + "time": { + "start": 1720186708.49595, + "finish": 1720186708.54066, + "duration": 0.044705867767334, + "processing": 0.00980901718139648, + "date_start": "2024-07-05T13:38:28+00:00", + "date_finish": "2024-07-05T13:38:28+00:00", + "operating_reset_at": 1720187308, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md index a00ec0f973..21030e8b85 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 2 ---- - -# Получить комменатрий задачи - Получает информацию о комментарии задачи по ID - - - -`Функция ПолучитьКомменатрийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDКомментария = "2932"; - IDЗадачи = "1082"; - - Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКомментария = "2936"; - - Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьКомменатрийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "POST_MESSAGE_HTML": null, - "ID": "1496", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:08+00:00", - "POST_MESSAGE": "Задача изменена, расходимся" - }, - "time": { - "start": 1720295539.50621, - "finish": 1720295539.55446, - "duration": 0.0482499599456787, - "processing": 0.019589900970459, - "date_start": "2024-07-06T19:52:19+00:00", - "date_finish": "2024-07-06T19:52:19+00:00", - "operating_reset_at": 1720296139, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Получить комменатрий задачи + Получает информацию о комментарии задачи по ID + + + +`Функция ПолучитьКомменатрийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDКомментария = "2932"; + IDЗадачи = "1082"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКомментария = "2936"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьКомменатрийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "POST_MESSAGE_HTML": null, + "ID": "1496", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:08+00:00", + "POST_MESSAGE": "Задача изменена, расходимся" + }, + "time": { + "start": 1720295539.50621, + "finish": 1720295539.55446, + "duration": 0.0482499599456787, + "processing": 0.019589900970459, + "date_start": "2024-07-06T19:52:19+00:00", + "date_finish": "2024-07-06T19:52:19+00:00", + "operating_reset_at": 1720296139, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md index aac2806383..a4ebb12e31 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 1 ---- - -# Получить список комментариев задачи - Полчает список комментариев пользователей к задаче по ID - - - -`Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1082"; - - Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокКомментариевЗадачи --url %url% --task %task% --filter %filter% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "POST_MESSAGE_HTML": null, - "ID": "1494", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:07+00:00", - "POST_MESSAGE": "Задача изменена, не расходимся" - }, - { - "POST_MESSAGE_HTML": null, - "ID": "1496", - "AUTHOR_ID": "1", - "AUTHOR_NAME": "Антон Титовец", - "AUTHOR_EMAIL": "", - "POST_DATE": "2024-07-06T19:52:08+00:00", - "POST_MESSAGE": "Задача изменена, расходимся" - } - ], - "time": { - "start": 1720295537.77876, - "finish": 1720295537.83513, - "duration": 0.0563700199127197, - "processing": 0.0240809917449951, - "date_start": "2024-07-06T19:52:17+00:00", - "date_finish": "2024-07-06T19:52:17+00:00", - "operating_reset_at": 1720296137, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить список комментариев задачи + Полчает список комментариев пользователей к задаче по ID + + + +`Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1082"; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокКомментариевЗадачи --url %url% --task %task% --filter %filter% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "POST_MESSAGE_HTML": null, + "ID": "1494", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:07+00:00", + "POST_MESSAGE": "Задача изменена, не расходимся" + }, + { + "POST_MESSAGE_HTML": null, + "ID": "1496", + "AUTHOR_ID": "1", + "AUTHOR_NAME": "Антон Титовец", + "AUTHOR_EMAIL": "", + "POST_DATE": "2024-07-06T19:52:08+00:00", + "POST_MESSAGE": "Задача изменена, расходимся" + } + ], + "time": { + "start": 1720295537.77876, + "finish": 1720295537.83513, + "duration": 0.0563700199127197, + "processing": 0.0240809917449951, + "date_start": "2024-07-06T19:52:17+00:00", + "date_finish": "2024-07-06T19:52:17+00:00", + "operating_reset_at": 1720296137, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md index bd51ef4626..d65ab2e1d0 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 4 ---- - -# Изменить комментарий задачи - Изменяет текст комментария задачи - - - -`Функция ИзменитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDКомментария | --comment | Число, Строка | ID комментария | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1082"; - IDКомментария = "2932"; - - Текст = "Задача изменена, не расходимся"; - - Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDКомментария = "2936"; - - Текст = "Задача изменена, расходимся"; - - Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720186705.11133, - "finish": 1720186705.21965, - "duration": 0.108311891555786, - "processing": 0.0788998603820801, - "date_start": "2024-07-05T13:38:25+00:00", - "date_finish": "2024-07-05T13:38:25+00:00", - "operating_reset_at": 1720187305, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Изменить комментарий задачи + Изменяет текст комментария задачи + + + +`Функция ИзменитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1082"; + IDКомментария = "2932"; + + Текст = "Задача изменена, не расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDКомментария = "2936"; + + Текст = "Задача изменена, расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720186705.11133, + "finish": 1720186705.21965, + "duration": 0.108311891555786, + "processing": 0.0788998603820801, + "date_start": "2024-07-05T13:38:25+00:00", + "date_finish": "2024-07-05T13:38:25+00:00", + "operating_reset_at": 1720187305, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md index b6729d2441..c8bb61f906 100644 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 2 ---- - -# Добавить пользовательское поле задачи - Добавляет новое пользовательское поле для добавления в задачу - - - -`Функция ДобавитьПользовательскоеПолеЗадачи(Знач URL, Знач Тип, Знач Имя, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Тип | --type | Строка | Тип поля: string, double, date, boolean | - | Имя | --fieldname | Строка | Текстовый идентификатор (наименование) поля | - | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | - | Заголовок | --title | Строка | Заголовок поля | - | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Тип = "date"; - Имя = "BIRTHDAY_FIELD"; - - Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Тип = "string"; - Имя = "TEXT_FIELD"; - ВнешнийКод = "BITRIX_TEXT_FIELD"; - Заголовок = "Поле для текста"; - Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); - - Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьПользовательскоеПолеЗадачи --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% - -``` - -```json title="Результат" -{ - "result": 261, - "time": { - "start": 1722114794.52732, - "finish": 1722114794.59725, - "duration": 0.0699310302734375, - "processing": 0.0470340251922607, - "date_start": "2024-07-27T21:13:14+00:00", - "date_finish": "2024-07-27T21:13:14+00:00", - "operating_reset_at": 1722115394, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Добавить пользовательское поле задачи + Добавляет новое пользовательское поле для добавления в задачу + + + +`Функция ДобавитьПользовательскоеПолеЗадачи(Знач URL, Знач Тип, Знач Имя, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Тип | --type | Строка | Тип поля: string, double, date, boolean | + | Имя | --fieldname | Строка | Текстовый идентификатор (наименование) поля | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Тип = "date"; + Имя = "BIRTHDAY_FIELD"; + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Тип = "string"; + Имя = "TEXT_FIELD"; + ВнешнийКод = "BITRIX_TEXT_FIELD"; + Заголовок = "Поле для текста"; + Подпись = Новый Структура("en,ru", "Some field", "Некоторое поле"); + + Результат = OPI_Bitrix24.ДобавитьПользовательскоеПолеЗадачи(URL, Тип, Имя, ВнешнийКод, Заголовок, Подпись, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьПользовательскоеПолеЗадачи --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Результат" +{ + "result": 261, + "time": { + "start": 1722114794.52732, + "finish": 1722114794.59725, + "duration": 0.0699310302734375, + "processing": 0.0470340251922607, + "date_start": "2024-07-27T21:13:14+00:00", + "date_finish": "2024-07-27T21:13:14+00:00", + "operating_reset_at": 1722115394, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md index e2c1197058..7d83ffca4d 100644 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 5 ---- - -# Удалить пользовательское поле задачи - Удаляет пользовательское поле задачи - - - -`Функция УдалитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПоля = "255"; - - Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПоля = "257"; - - Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, ); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722114801.22925, - "finish": 1722114801.26696, - "duration": 0.0377130508422852, - "processing": 0.0185980796813965, - "date_start": "2024-07-27T21:13:21+00:00", - "date_finish": "2024-07-27T21:13:21+00:00", - "operating_reset_at": 1722115401, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Удалить пользовательское поле задачи + Удаляет пользовательское поле задачи + + + +`Функция УдалитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПоля = "255"; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПоля = "257"; + + Результат = OPI_Bitrix24.УдалитьПользовательскоеПолеЗадачи(URL, IDПоля, ); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722114801.22925, + "finish": 1722114801.26696, + "duration": 0.0377130508422852, + "processing": 0.0185980796813965, + "date_start": "2024-07-27T21:13:21+00:00", + "date_finish": "2024-07-27T21:13:21+00:00", + "operating_reset_at": 1722115401, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md index a3bf962a14..e2c51d6a96 100644 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md @@ -1,186 +1,186 @@ ---- -sidebar_position: 4 ---- - -# Получить пользовательское поле задачи - Получает информацию о пользовательском поле задачи - - - -`Функция ПолучитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПоля = "255"; - - Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПоля = "257"; - - Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля, ); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - }, - "EDIT_FORM_LABEL": { - "ar": "", - "br": "", - "de": "", - "en": "Updated field", - "fr": "", - "id": "", - "it": "", - "ja": "", - "la": "", - "ms": "", - "pl": "", - "ru": "Измененное поле", - "sc": "", - "tc": "", - "th": "", - "tr": "", - "ua": "", - "vn": "" - }, - "LIST_COLUMN_LABEL": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "LIST_FILTER_LABEL": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "ERROR_MESSAGE": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - }, - "HELP_MESSAGE": { - "ar": "Поле для текста", - "br": "Поле для текста", - "de": "Поле для текста", - "en": "Поле для текста", - "fr": "Поле для текста", - "id": "Поле для текста", - "it": "Поле для текста", - "ja": "Поле для текста", - "la": "Поле для текста", - "ms": "Поле для текста", - "pl": "Поле для текста", - "ru": "Поле для текста", - "sc": "Поле для текста", - "tc": "Поле для текста", - "th": "Поле для текста", - "tr": "Поле для текста", - "ua": "Поле для текста", - "vn": "Поле для текста" - } - }, - "total": 0, - "time": { - "start": 1722114797.9059, - "finish": 1722114797.92375, - "duration": 0.0178542137145996, - "processing": 0.000695943832397461, - "date_start": "2024-07-27T21:13:17+00:00", - "date_finish": "2024-07-27T21:13:17+00:00", - "operating_reset_at": 1722115397, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Получить пользовательское поле задачи + Получает информацию о пользовательском поле задачи + + + +`Функция ПолучитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПоля = "255"; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПоля = "257"; + + Результат = OPI_Bitrix24.ПолучитьПользовательскоеПолеЗадачи(URL, IDПоля, ); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + }, + "EDIT_FORM_LABEL": { + "ar": "", + "br": "", + "de": "", + "en": "Updated field", + "fr": "", + "id": "", + "it": "", + "ja": "", + "la": "", + "ms": "", + "pl": "", + "ru": "Измененное поле", + "sc": "", + "tc": "", + "th": "", + "tr": "", + "ua": "", + "vn": "" + }, + "LIST_COLUMN_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "LIST_FILTER_LABEL": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "ERROR_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + }, + "HELP_MESSAGE": { + "ar": "Поле для текста", + "br": "Поле для текста", + "de": "Поле для текста", + "en": "Поле для текста", + "fr": "Поле для текста", + "id": "Поле для текста", + "it": "Поле для текста", + "ja": "Поле для текста", + "la": "Поле для текста", + "ms": "Поле для текста", + "pl": "Поле для текста", + "ru": "Поле для текста", + "sc": "Поле для текста", + "tc": "Поле для текста", + "th": "Поле для текста", + "tr": "Поле для текста", + "ua": "Поле для текста", + "vn": "Поле для текста" + } + }, + "total": 0, + "time": { + "start": 1722114797.9059, + "finish": 1722114797.92375, + "duration": 0.0178542137145996, + "processing": 0.000695943832397461, + "date_start": "2024-07-27T21:13:17+00:00", + "date_finish": "2024-07-27T21:13:17+00:00", + "operating_reset_at": 1722115397, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md index d0e9ee0c94..d45acc76ad 100644 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md @@ -1,157 +1,157 @@ ---- -sidebar_position: 1 ---- - -# Получить список пользовательских полей задачи - Получает список пользовательских полей для задач - - - -`Функция ПолучитьСписокПользовательскихПолейЗадачи(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокПользовательскихПолейЗадачи --url %url% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "11", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_CRM_TASK", - "USER_TYPE_ID": "crm", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "LEAD": "Y", - "CONTACT": "Y", - "COMPANY": "Y", - "DEAL": "Y", - "ORDER": "Y", - "SMART_INVOICE": "Y" - } - }, - { - "ID": "101", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TASK_WEBDAV_FILES", - "USER_TYPE_ID": "disk_file", - "XML_ID": "TASK_WEBDAV_FILES", - "SORT": "100", - "MULTIPLE": "Y", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "Y", - "SETTINGS": [] - }, - { - "ID": "117", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_MAIL_MESSAGE", - "USER_TYPE_ID": "mail_message", - "XML_ID": "", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "N", - "EDIT_IN_LIST": "N", - "IS_SEARCHABLE": "N", - "SETTINGS": [] - }, - { - "ID": "259", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_BIRTHDAY_FIELD", - "USER_TYPE_ID": "date", - "XML_ID": null, - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "DEFAULT_VALUE": { - "TYPE": "NONE", - "VALUE": "" - } - } - }, - { - "ID": "261", - "ENTITY_ID": "TASKS_TASK", - "FIELD_NAME": "UF_TEXT_FIELD", - "USER_TYPE_ID": "string", - "XML_ID": "NEW_TEXT_FIELD", - "SORT": "100", - "MULTIPLE": "N", - "MANDATORY": "N", - "SHOW_FILTER": "N", - "SHOW_IN_LIST": "Y", - "EDIT_IN_LIST": "Y", - "IS_SEARCHABLE": "N", - "SETTINGS": { - "SIZE": 20, - "ROWS": 1, - "REGEXP": "", - "MIN_LENGTH": 0, - "MAX_LENGTH": 0, - "DEFAULT_VALUE": "" - } - } - ], - "total": 0, - "time": { - "start": 1722114799.57, - "finish": 1722114799.58769, - "duration": 0.0176839828491211, - "processing": 0.000379085540771484, - "date_start": "2024-07-27T21:13:19+00:00", - "date_finish": "2024-07-27T21:13:19+00:00", - "operating_reset_at": 1722115399, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить список пользовательских полей задачи + Получает список пользовательских полей для задач + + + +`Функция ПолучитьСписокПользовательскихПолейЗадачи(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокПользовательскихПолейЗадачи(URL); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокПользовательскихПолейЗадачи --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "11", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_CRM_TASK", + "USER_TYPE_ID": "crm", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "LEAD": "Y", + "CONTACT": "Y", + "COMPANY": "Y", + "DEAL": "Y", + "ORDER": "Y", + "SMART_INVOICE": "Y" + } + }, + { + "ID": "101", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TASK_WEBDAV_FILES", + "USER_TYPE_ID": "disk_file", + "XML_ID": "TASK_WEBDAV_FILES", + "SORT": "100", + "MULTIPLE": "Y", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "Y", + "SETTINGS": [] + }, + { + "ID": "117", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_MAIL_MESSAGE", + "USER_TYPE_ID": "mail_message", + "XML_ID": "", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "N", + "EDIT_IN_LIST": "N", + "IS_SEARCHABLE": "N", + "SETTINGS": [] + }, + { + "ID": "259", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_BIRTHDAY_FIELD", + "USER_TYPE_ID": "date", + "XML_ID": null, + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "DEFAULT_VALUE": { + "TYPE": "NONE", + "VALUE": "" + } + } + }, + { + "ID": "261", + "ENTITY_ID": "TASKS_TASK", + "FIELD_NAME": "UF_TEXT_FIELD", + "USER_TYPE_ID": "string", + "XML_ID": "NEW_TEXT_FIELD", + "SORT": "100", + "MULTIPLE": "N", + "MANDATORY": "N", + "SHOW_FILTER": "N", + "SHOW_IN_LIST": "Y", + "EDIT_IN_LIST": "Y", + "IS_SEARCHABLE": "N", + "SETTINGS": { + "SIZE": 20, + "ROWS": 1, + "REGEXP": "", + "MIN_LENGTH": 0, + "MAX_LENGTH": 0, + "DEFAULT_VALUE": "" + } + } + ], + "total": 0, + "time": { + "start": 1722114799.57, + "finish": 1722114799.58769, + "duration": 0.0176839828491211, + "processing": 0.000379085540771484, + "date_start": "2024-07-27T21:13:19+00:00", + "date_finish": "2024-07-27T21:13:19+00:00", + "operating_reset_at": 1722115399, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md index 1ea2787b74..894388903a 100644 --- a/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md +++ b/docs/ru/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 3 ---- - -# Изменить пользовательское поле задачи - Изменяет пользовательское поле задачи - - - -`Функция ИзменитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПоля | --fieldid | Строка, Число | ID поля для изменения | - | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | - | Заголовок | --title | Строка | Заголовок поля | - | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - IDПоля = "255"; - Заголовок = "Новый заголовок"; - - Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - IDПоля = "257"; - ВнешнийКод = "NEW_TEXT_FIELD"; - Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); - - Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722114796.23423, - "finish": 1722114796.26623, - "duration": 0.0319931507110596, - "processing": 0.0126721858978271, - "date_start": "2024-07-27T21:13:16+00:00", - "date_finish": "2024-07-27T21:13:16+00:00", - "operating_reset_at": 1722115396, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Изменить пользовательское поле задачи + Изменяет пользовательское поле задачи + + + +`Функция ИзменитьПользовательскоеПолеЗадачи(Знач URL, Знач IDПоля, Знач ВнешнийКод = "", Знач Заголовок = "", Знач Подпись = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПоля | --fieldid | Строка, Число | ID поля для изменения | + | ВнешнийКод | --externalid | Строка | Внешний текстовый идентификатор поля | + | Заголовок | --title | Строка | Заголовок поля | + | Подпись | --label | Структура Из КлючИЗначение | Подпись в форме. Ключ: en или ru, Значение: Текст подписи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + IDПоля = "255"; + Заголовок = "Новый заголовок"; + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, , Заголовок); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + IDПоля = "257"; + ВнешнийКод = "NEW_TEXT_FIELD"; + Подпись = Новый Структура("en,ru", "Updated field", "Измененное поле"); + + Результат = OPI_Bitrix24.ИзменитьПользовательскоеПолеЗадачи(URL, IDПоля, ВнешнийКод, , Подпись, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьПользовательскоеПолеЗадачи --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722114796.23423, + "finish": 1722114796.26623, + "duration": 0.0319931507110596, + "processing": 0.0126721858978271, + "date_start": "2024-07-27T21:13:16+00:00", + "date_finish": "2024-07-27T21:13:16+00:00", + "operating_reset_at": 1722115396, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Create-department.md b/docs/ru/md/Bitrix24/Departments-managment/Create-department.md index bff362c152..4170c7330f 100644 --- a/docs/ru/md/Bitrix24/Departments-managment/Create-department.md +++ b/docs/ru/md/Bitrix24/Departments-managment/Create-department.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 1 ---- - -# Создать подразделение - Создает новое подразделение - - - -`Функция СоздатьПодразделение(Знач URL, Знач Наименование, Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование подразделения | - | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | - | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Наименование = "Главное подразделение"; - IDРодителя = 1; - - Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Наименование = "Подчиненное подразделение"; - IDРодителя = "68"; - IDРуководителя = 1; - - Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьПодразделение --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Результат" -{ - "result": 42, - "time": { - "start": 1722171476.78229, - "finish": 1722171477.19809, - "duration": 0.415800094604492, - "processing": 0.389212131500244, - "date_start": "2024-07-28T12:57:56+00:00", - "date_finish": "2024-07-28T12:57:57+00:00", - "operating_reset_at": 1722172076, - "operating": 0.389190912246704 - } -} -``` +--- +sidebar_position: 1 +--- + +# Создать подразделение + Создает новое подразделение + + + +`Функция СоздатьПодразделение(Знач URL, Знач Наименование, Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Наименование = "Главное подразделение"; + IDРодителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Наименование = "Подчиненное подразделение"; + IDРодителя = "68"; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.СоздатьПодразделение(URL, Наименование, IDРодителя, IDРуководителя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьПодразделение --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "result": 42, + "time": { + "start": 1722171476.78229, + "finish": 1722171477.19809, + "duration": 0.415800094604492, + "processing": 0.389212131500244, + "date_start": "2024-07-28T12:57:56+00:00", + "date_finish": "2024-07-28T12:57:57+00:00", + "operating_reset_at": 1722172076, + "operating": 0.389190912246704 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md index b286be3ea6..4362975d2d 100644 --- a/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md +++ b/docs/ru/md/Bitrix24/Departments-managment/Delete-department.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Удалить подразделение - Удаляет подразделение по ID - - - -`Функция УдалитьПодразделение(Знач URL, Знач IDПодразделения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | ID подразделения для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПодразделения = "70"; - - Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПодразделения = "68"; - - Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьПодразделение --url %url% --depid %depid% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722171482.56495, - "finish": 1722171482.65313, - "duration": 0.0881810188293457, - "processing": 0.0624208450317383, - "date_start": "2024-07-28T12:58:02+00:00", - "date_finish": "2024-07-28T12:58:02+00:00", - "operating_reset_at": 1722172082, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Удалить подразделение + Удаляет подразделение по ID + + + +`Функция УдалитьПодразделение(Знач URL, Знач IDПодразделения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПодразделения = "70"; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПодразделения = "68"; + + Результат = OPI_Bitrix24.УдалитьПодразделение(URL, IDПодразделения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьПодразделение --url %url% --depid %depid% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722171482.56495, + "finish": 1722171482.65313, + "duration": 0.0881810188293457, + "processing": 0.0624208450317383, + "date_start": "2024-07-28T12:58:02+00:00", + "date_finish": "2024-07-28T12:58:02+00:00", + "operating_reset_at": 1722172082, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md index 7e0f9122a8..4441172768 100644 --- a/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md +++ b/docs/ru/md/Bitrix24/Departments-managment/Get-departments.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 3 ---- - -# Получить подразделения - Получает список подразделений по ID или фильтру - - - -`Функция ПолучитьПодразделения(Знач URL, Знач IDПодразделения = "", Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | Выбор по ID подразделения | - | Наименование | --title | Строка | Фильтр по наименованию | - | IDРодителя | --parentid | Строка, Число | Фильтр по родителю | - | IDРуководителя | --headid | Строка, Число | Фильтр по руководителю | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПодразделения = "70"; - - Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDРуководителя = 1; - - Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьПодразделения --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "42", - "NAME": "Подчиненное подразделение", - "SORT": 500, - "PARENT": "40", - "UF_HEAD": "1" - } - ], - "total": 1, - "time": { - "start": 1722171478.80371, - "finish": 1722171478.83794, - "duration": 0.034229040145874, - "processing": 0.00419092178344727, - "date_start": "2024-07-28T12:57:58+00:00", - "date_finish": "2024-07-28T12:57:58+00:00", - "operating_reset_at": 1722172078, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Получить подразделения + Получает список подразделений по ID или фильтру + + + +`Функция ПолучитьПодразделения(Знач URL, Знач IDПодразделения = "", Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | Выбор по ID подразделения | + | Наименование | --title | Строка | Фильтр по наименованию | + | IDРодителя | --parentid | Строка, Число | Фильтр по родителю | + | IDРуководителя | --headid | Строка, Число | Фильтр по руководителю | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПодразделения = "70"; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, IDПодразделения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDРуководителя = 1; + + Результат = OPI_Bitrix24.ПолучитьПодразделения(URL, , , , IDРуководителя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПодразделения --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "42", + "NAME": "Подчиненное подразделение", + "SORT": 500, + "PARENT": "40", + "UF_HEAD": "1" + } + ], + "total": 1, + "time": { + "start": 1722171478.80371, + "finish": 1722171478.83794, + "duration": 0.034229040145874, + "processing": 0.00419092178344727, + "date_start": "2024-07-28T12:57:58+00:00", + "date_finish": "2024-07-28T12:57:58+00:00", + "operating_reset_at": 1722172078, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Departments-managment/Update-department.md b/docs/ru/md/Bitrix24/Departments-managment/Update-department.md index 973be1bdea..b345a4d693 100644 --- a/docs/ru/md/Bitrix24/Departments-managment/Update-department.md +++ b/docs/ru/md/Bitrix24/Departments-managment/Update-department.md @@ -1,78 +1,78 @@ ---- -sidebar_position: 2 ---- - -# Изменить подразделение - Изменяет существующее подразделение - - - -`Функция ИзменитьПодразделение(Знач URL, Знач IDПодразделения, Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПодразделения | --depid | Строка, Число | ID подразделения | - | Наименование | --title | Строка | Наименование подразделения | - | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | - | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - IDПодразделения = "68"; - IDРодителя = 7; - - Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - IDПодразделения = "70"; - Наименование = "Новое подразделение"; - IDРодителя = 1; - IDРуководителя = 10; - - Результат = OPI_Bitrix24.ИзменитьПодразделение(URL - , IDПодразделения - , Наименование - , IDРодителя - , IDРуководителя - , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьПодразделение --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722171480.45996, - "finish": 1722171480.83957, - "duration": 0.37961220741272, - "processing": 0.347241878509522, - "date_start": "2024-07-28T12:58:00+00:00", - "date_finish": "2024-07-28T12:58:00+00:00", - "operating_reset_at": 1722172080, - "operating": 0.34721302986145 - } -} -``` +--- +sidebar_position: 2 +--- + +# Изменить подразделение + Изменяет существующее подразделение + + + +`Функция ИзменитьПодразделение(Знач URL, Знач IDПодразделения, Знач Наименование = "", Знач IDРодителя = "", Знач IDРуководителя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПодразделения | --depid | Строка, Число | ID подразделения | + | Наименование | --title | Строка | Наименование подразделения | + | IDРодителя | --parentid | Строка, Число | ID родительского подразделения | + | IDРуководителя | --headid | Строка, Число | ID руководителя подразделения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + IDПодразделения = "68"; + IDРодителя = 7; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL, IDПодразделения, , IDРодителя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + IDПодразделения = "70"; + Наименование = "Новое подразделение"; + IDРодителя = 1; + IDРуководителя = 10; + + Результат = OPI_Bitrix24.ИзменитьПодразделение(URL + , IDПодразделения + , Наименование + , IDРодителя + , IDРуководителя + , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьПодразделение --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722171480.45996, + "finish": 1722171480.83957, + "duration": 0.37961220741272, + "processing": 0.347241878509522, + "date_start": "2024-07-28T12:58:00+00:00", + "date_finish": "2024-07-28T12:58:00+00:00", + "operating_reset_at": 1722172080, + "operating": 0.34721302986145 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md index b1be033abc..821a817284 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 6 ---- - -# Добавить комментарий новости - Добавляет комментарий к новости - - - -`Функция ДобавитьКомментарийНовости(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) -::: -
- - -```bsl title="Пример кода" - Текст = "Комментарий к новости"; - IDНовости = "440"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); - - Текст = "Другой комментарий к новости"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьКомментарийНовости --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": 168, - "time": { - "start": 1720186639.67208, - "finish": 1720186639.77202, - "duration": 0.0999400615692139, - "processing": 0.0715811252593994, - "date_start": "2024-07-05T13:37:19+00:00", - "date_finish": "2024-07-05T13:37:19+00:00", - "operating_reset_at": 1720187239, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Добавить комментарий новости + Добавляет комментарий к новости + + + +`Функция ДобавитьКомментарийНовости(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php) +::: +
+ + +```bsl title="Пример кода" + Текст = "Комментарий к новости"; + IDНовости = "440"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); + + Текст = "Другой комментарий к новости"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьКомментарийНовости --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": 168, + "time": { + "start": 1720186639.67208, + "finish": 1720186639.77202, + "duration": 0.0999400615692139, + "processing": 0.0715811252593994, + "date_start": "2024-07-05T13:37:19+00:00", + "date_finish": "2024-07-05T13:37:19+00:00", + "operating_reset_at": 1720187239, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Delete-file.md b/docs/ru/md/Bitrix24/File-managment/Delete-file.md index 40a6e71c3c..e7d2b99dbc 100644 --- a/docs/ru/md/Bitrix24/File-managment/Delete-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Delete-file.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Удалить файл - Удаляет файл по ID - - - -`Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор удаляемого файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDФайла = "5008"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDФайла = "5010"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1718783933.86753, - "finish": 1718783937.64223, - "duration": 3.77469992637634, - "processing": 3.73617887496948, - "date_start": "2024-06-19T07:58:53+00:00", - "date_finish": "2024-06-19T07:58:57+00:00", - "operating_reset_at": 1718784533, - "operating": 3.73615193367004 - } -} -``` +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл по ID + + + +`Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор удаляемого файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDФайла = "5008"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDФайла = "5010"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1718783933.86753, + "finish": 1718783937.64223, + "duration": 3.77469992637634, + "processing": 3.73617887496948, + "date_start": "2024-06-19T07:58:53+00:00", + "date_finish": "2024-06-19T07:58:57+00:00", + "operating_reset_at": 1718784533, + "operating": 3.73615193367004 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md index 8ad1910f36..9dad9598d8 100644 --- a/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md @@ -1,63 +1,63 @@ ---- -sidebar_position: 5 ---- - -# Получить внешнюю ссылку файла - Получает внешнюю ссылку для доступа к файлу - - - -`Функция ПолучитьВнешнююСсылкуФайла(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDФайла = "5010"; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьВнешнююСсылкуФайла --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": "https://b24-ar17wx.bitrix24.by/~pT3DD", - "time": { - "start": 1720017752.7023, - "finish": 1720017752.74417, - "duration": 0.0418639183044434, - "processing": 0.00636386871337891, - "date_start": "2024-07-03T14:42:32+00:00", - "date_finish": "2024-07-03T14:42:32+00:00", - "operating_reset_at": 1720018352, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Получить внешнюю ссылку файла + Получает внешнюю ссылку для доступа к файлу + + + +`Функция ПолучитьВнешнююСсылкуФайла(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDФайла = "5010"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьВнешнююСсылкуФайла --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": "https://b24-ar17wx.bitrix24.by/~pT3DD", + "time": { + "start": 1720017752.7023, + "finish": 1720017752.74417, + "duration": 0.0418639183044434, + "processing": 0.00636386871337891, + "date_start": "2024-07-03T14:42:32+00:00", + "date_finish": "2024-07-03T14:42:32+00:00", + "operating_reset_at": 1720018352, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Get-file-information.md b/docs/ru/md/Bitrix24/File-managment/Get-file-information.md index 75a95f59e2..bf1b4f2790 100644 --- a/docs/ru/md/Bitrix24/File-managment/Get-file-information.md +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-information.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о файле - Получает информацию о файле по ID - - - -`Функция ПолучитьИнформациюОФайле(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDФайла = "5010"; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьИнформациюОФайле --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1716", - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - }, - "time": { - "start": 1720017751.37945, - "finish": 1720017751.42512, - "duration": 0.0456681251525879, - "processing": 0.0131018161773682, - "date_start": "2024-07-03T14:42:31+00:00", - "date_finish": "2024-07-03T14:42:31+00:00", - "operating_reset_at": 1720018351, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Получить информацию о файле + Получает информацию о файле по ID + + + +`Функция ПолучитьИнформациюОФайле(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDФайла = "5010"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьИнформациюОФайле --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1716", + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + }, + "time": { + "start": 1720017751.37945, + "finish": 1720017751.42512, + "duration": 0.0456681251525879, + "processing": 0.0131018161773682, + "date_start": "2024-07-03T14:42:31+00:00", + "date_finish": "2024-07-03T14:42:31+00:00", + "operating_reset_at": 1720018351, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md index a952417340..062829e1bd 100644 --- a/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md +++ b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 8 ---- - -# Скопировать файл - Копирует файл из одного расположения в другое - - - -`Функция СкопироватьФайл(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | ID файла для копирования | - | IDКаталога | --folderid | Строка, Число | ID каталога размещения копии | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "5014"; - IDФайла = "5010"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); - - IDКаталога = "5016"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога, Токен); - - Проверка_БитриксОбъект(Результат); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СкопироватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 1744, - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "1722", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 1146, - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:54+00:00", - "UPDATE_TIME": "2024-07-03T14:42:54+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" - }, - "time": { - "start": 1720017774.37632, - "finish": 1720017774.44715, - "duration": 0.07082200050354, - "processing": 0.0407531261444092, - "date_start": "2024-07-03T14:42:54+00:00", - "date_finish": "2024-07-03T14:42:54+00:00", - "operating_reset_at": 1720018374, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Скопировать файл + Копирует файл из одного расположения в другое + + + +`Функция СкопироватьФайл(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для копирования | + | IDКаталога | --folderid | Строка, Число | ID каталога размещения копии | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "5014"; + IDФайла = "5010"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); + + IDКаталога = "5016"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога, Токен); + + Проверка_БитриксОбъект(Результат); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СкопироватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 1744, + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "1722", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 1146, + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:54+00:00", + "UPDATE_TIME": "2024-07-03T14:42:54+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новое имя файла.jpg" + }, + "time": { + "start": 1720017774.37632, + "finish": 1720017774.44715, + "duration": 0.07082200050354, + "processing": 0.0407531261444092, + "date_start": "2024-07-03T14:42:54+00:00", + "date_finish": "2024-07-03T14:42:54+00:00", + "operating_reset_at": 1720018374, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md index 1a2efe6a6b..3b9b5730dd 100644 --- a/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md +++ b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 6 ---- - -# Поместить файл в корзину - Перемещает файл в корзину удаляемых файлов - - - -`Функция ПоместитьФайлВКорзину(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDФайла = "5010"; - - Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПоместитьФайлВКорзину --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1716", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "3", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpgi17200177547139i" - }, - "time": { - "start": 1720017755.36075, - "finish": 1720017755.40426, - "duration": 0.0435140132904053, - "processing": 0.0109550952911377, - "date_start": "2024-07-03T14:42:35+00:00", - "date_finish": "2024-07-03T14:42:35+00:00", - "operating_reset_at": 1720018355, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Поместить файл в корзину + Перемещает файл в корзину удаляемых файлов + + + +`Функция ПоместитьФайлВКорзину(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDФайла = "5010"; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПоместитьФайлВКорзину --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1716", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "3", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpgi17200177547139i" + }, + "time": { + "start": 1720017755.36075, + "finish": 1720017755.40426, + "duration": 0.0435140132904053, + "processing": 0.0109550952911377, + "date_start": "2024-07-03T14:42:35+00:00", + "date_finish": "2024-07-03T14:42:35+00:00", + "operating_reset_at": 1720018355, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md index 72cec64f84..7d263edc30 100644 --- a/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md +++ b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 9 ---- - -# Переместить файл - Перемещает файл из одного расположения в другое - - - -`Функция ПереместитьФайлВКаталог(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | ID файла для перемещения | - | IDКаталога | --folderid | Строка, Число | ID каталога нового размещения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) -::: -
- - -```bsl title="Пример кода" - IDКаталога = "5018"; - IDФайла = "5010"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); - - IDКаталога = "5020"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога, Токен); - - Проверка_БитриксОбъект(Результат); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереместитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1716", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": 1726, - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:36+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новый подкаталог/Новое имя файла.jpg" - }, - "time": { - "start": 1720017764.56434, - "finish": 1720017764.63176, - "duration": 0.0674228668212891, - "processing": 0.0307409763336182, - "date_start": "2024-07-03T14:42:44+00:00", - "date_finish": "2024-07-03T14:42:44+00:00", - "operating_reset_at": 1720018364, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Переместить файл + Перемещает файл из одного расположения в другое + + + +`Функция ПереместитьФайлВКаталог(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для перемещения | + | IDКаталога | --folderid | Строка, Число | ID каталога нового размещения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
+ + +```bsl title="Пример кода" + IDКаталога = "5018"; + IDФайла = "5010"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); + + IDКаталога = "5020"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога, Токен); + + Проверка_БитриксОбъект(Результат); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереместитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1716", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": 1726, + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:36+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Новый подкаталог/Новое имя файла.jpg" + }, + "time": { + "start": 1720017764.56434, + "finish": 1720017764.63176, + "duration": 0.0674228668212891, + "processing": 0.0307409763336182, + "date_start": "2024-07-03T14:42:44+00:00", + "date_finish": "2024-07-03T14:42:44+00:00", + "operating_reset_at": 1720018364, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Rename-file.md b/docs/ru/md/Bitrix24/File-managment/Rename-file.md index 2047008ddb..858ef5402b 100644 --- a/docs/ru/md/Bitrix24/File-managment/Rename-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Rename-file.md @@ -1,87 +1,87 @@ ---- -sidebar_position: 10 ---- - -# Переименовать файл - Изменяет имя существующего файла - - - -`Функция ПереименоватьФайл(Знач URL, Знач IDФайла, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Наименование | --title | Строка | Новое наименование каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя файла.jpg"; - Наименование2 = "Новое имя файла 2.jpg"; - - IDФайла2 = "5008"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); - - IDФайла = "5010"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереименоватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1716", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:28+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" - }, - "time": { - "start": 1720017754.0472, - "finish": 1720017754.09402, - "duration": 0.0468170642852783, - "processing": 0.0171689987182617, - "date_start": "2024-07-03T14:42:34+00:00", - "date_finish": "2024-07-03T14:42:34+00:00", - "operating_reset_at": 1720018354, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Переименовать файл + Изменяет имя существующего файла + + + +`Функция ПереименоватьФайл(Знач URL, Знач IDФайла, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя файла.jpg"; + Наименование2 = "Новое имя файла 2.jpg"; + + IDФайла2 = "5008"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); + + IDФайла = "5010"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереименоватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1716", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:28+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" + }, + "time": { + "start": 1720017754.0472, + "finish": 1720017754.09402, + "duration": 0.0468170642852783, + "processing": 0.0171689987182617, + "date_start": "2024-07-03T14:42:34+00:00", + "date_finish": "2024-07-03T14:42:34+00:00", + "operating_reset_at": 1720018354, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Restore-file.md b/docs/ru/md/Bitrix24/File-managment/Restore-file.md index 669edf7422..0a1f0d3977 100644 --- a/docs/ru/md/Bitrix24/File-managment/Restore-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Restore-file.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 7 ---- - -# Восстановить файл - Восстанавливает файл из корзины - - - -`Функция ВосстановитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDФайла | --fileid | Строка, Число | Идентификатор файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDФайла = "5010"; - - Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВосстановитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "1716", - "NAME": "Новое имя файла.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "1134", - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:28+00:00", - "UPDATE_TIME": "2024-07-03T14:42:36+00:00", - "DELETE_TIME": "2024-07-03T14:42:34+00:00", - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "1", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" - }, - "time": { - "start": 1720017756.65038, - "finish": 1720017756.69349, - "duration": 0.0431070327758789, - "processing": 0.0107128620147705, - "date_start": "2024-07-03T14:42:36+00:00", - "date_finish": "2024-07-03T14:42:36+00:00", - "operating_reset_at": 1720018356, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Восстановить файл + Восстанавливает файл из корзины + + + +`Функция ВосстановитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDФайла = "5010"; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВосстановитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "1716", + "NAME": "Новое имя файла.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "1134", + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:28+00:00", + "UPDATE_TIME": "2024-07-03T14:42:36+00:00", + "DELETE_TIME": "2024-07-03T14:42:34+00:00", + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "1", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новое имя файла.jpg" + }, + "time": { + "start": 1720017756.65038, + "finish": 1720017756.69349, + "duration": 0.0431070327758789, + "processing": 0.0107128620147705, + "date_start": "2024-07-03T14:42:36+00:00", + "date_finish": "2024-07-03T14:42:36+00:00", + "operating_reset_at": 1720018356, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md index faab2d704c..5858647fcd 100644 --- a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md @@ -1,81 +1,81 @@ ---- -sidebar_position: 2 ---- - -# Загрузить файл в каталог - Загружает переданный файл в каталог - - - -`Функция ЗагрузитьФайлВКаталог(Знач URL, Знач Наименование, Знач Файл, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование файла с расширением для сохранения | - | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | - | IDКаталога | --folderid | Строка | Идентификатор каталога для загрузки | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) -::: -
- - -```bsl title="Пример кода" - Наименование2 = "Картинка2.jpg"; - Наименование = "Картинка1.jpg"; - - Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные - Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные - - IDПриемника = "5016"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование, Картинка, IDПриемника, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ЗагрузитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 1740, - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "1722", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 1142, - "SIZE": "805189", - "CREATE_TIME": "2024-07-03T14:42:52+00:00", - "UPDATE_TIME": "2024-07-03T14:42:52+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Картинка1.jpg" - } -} -``` +--- +sidebar_position: 2 +--- + +# Загрузить файл в каталог + Загружает переданный файл в каталог + + + +`Функция ЗагрузитьФайлВКаталог(Знач URL, Знач Наименование, Знач Файл, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDКаталога | --folderid | Строка | Идентификатор каталога для загрузки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
+ + +```bsl title="Пример кода" + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = "5016"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование, Картинка, IDПриемника, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ЗагрузитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 1740, + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "1722", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 1142, + "SIZE": "805189", + "CREATE_TIME": "2024-07-03T14:42:52+00:00", + "UPDATE_TIME": "2024-07-03T14:42:52+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Новый каталог/Картинка1.jpg" + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md index 8fce98e82a..cb2ea99d4e 100644 --- a/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md @@ -1,92 +1,92 @@ ---- -sidebar_position: 1 ---- - -# Загрузить файл в хранилище - Загружает файл в выбранное хранилище - - - -`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование файла с расширением для сохранения | - | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | - | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | - | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) -::: -
- - -```bsl title="Пример кода" - Наименование2 = "Картинка2.jpg"; - Наименование = "Картинка1.jpg"; - - Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные - Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные - - IDПриемника = 3; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ЗагрузитьФайлВХранилище --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 356, - "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 404, - "SIZE": "26", - "CREATE_TIME": "2024-06-19T07:58:50+00:00", - "UPDATE_TIME": "2024-06-19T07:58:50+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" - }, - "time": { - "start": 1718783929.8197, - "finish": 1718783930.09911, - "duration": 0.279407024383545, - "processing": 0.227760076522827, - "date_start": "2024-06-19T07:58:49+00:00", - "date_finish": "2024-06-19T07:58:50+00:00", - "operating_reset_at": 1718784529, - "operating": 0.227726936340332 - } -} -``` +--- +sidebar_position: 1 +--- + +# Загрузить файл в хранилище + Загружает файл в выбранное хранилище + + + +`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | + | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Пример кода" + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ЗагрузитьФайлВХранилище --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 356, + "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 404, + "SIZE": "26", + "CREATE_TIME": "2024-06-19T07:58:50+00:00", + "UPDATE_TIME": "2024-06-19T07:58:50+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" + }, + "time": { + "start": 1718783929.8197, + "finish": 1718783930.09911, + "duration": 0.279407024383545, + "processing": 0.227760076522827, + "date_start": "2024-06-19T07:58:49+00:00", + "date_finish": "2024-06-19T07:58:50+00:00", + "operating_reset_at": 1718784529, + "operating": 0.227726936340332 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md index ba242ae59a..4e7dd1e9f1 100644 --- a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 1 ---- - -# Добавить стадию канбана - Добавляет стабию канбана или Моего плана - - - -`Функция ДобавитьСтадиюКанбана(Знач URL, Знач Наименование, Знач Цвет = "FFD800", Знач IDПредыдущей = 0, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование новой стадии | - | Цвет | --color | Строка | HEX цвета новой стадии | - | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить новую (в начало по ум.) | - | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новая стадия"; - Цвет = "0026FF"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); - - IDПредыдущей = Результат["result"]; - - Наименование = "Новая стадия 2"; - Цвет = "0026FF"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, IDПредыдущей, , Истина, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": 132, - "time": { - "start": 1720600360.58899, - "finish": 1720600360.679, - "duration": 0.0900149345397949, - "processing": 0.0587739944458008, - "date_start": "2024-07-10T08:32:40+00:00", - "date_finish": "2024-07-10T08:32:40+00:00", - "operating_reset_at": 1720600960, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Добавить стадию канбана + Добавляет стабию канбана или Моего плана + + + +`Функция ДобавитьСтадиюКанбана(Знач URL, Знач Наименование, Знач Цвет = "FFD800", Знач IDПредыдущей = 0, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование новой стадии | + | Цвет | --color | Строка | HEX цвета новой стадии | + | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить новую (в начало по ум.) | + | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новая стадия"; + Цвет = "0026FF"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); + + IDПредыдущей = Результат["result"]; + + Наименование = "Новая стадия 2"; + Цвет = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, IDПредыдущей, , Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": 132, + "time": { + "start": 1720600360.58899, + "finish": 1720600360.679, + "duration": 0.0900149345397949, + "processing": 0.0587739944458008, + "date_start": "2024-07-10T08:32:40+00:00", + "date_finish": "2024-07-10T08:32:40+00:00", + "operating_reset_at": 1720600960, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md index 09a4b94e47..ca15bd8f6b 100644 --- a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 3 ---- - -# Удалить стадию канбана - Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач - - - -`Функция УдалитьСтадиюКанбана(Знач URL, Знач IDСтадии, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСтадии | --stage | Строка, Число | ID стадии для удаления | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) -::: -
- - -```bsl title="Пример кода" - IDСтадии = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); - - IDСтадии = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720600367.83205, - "finish": 1720600367.8709, - "duration": 0.0388522148132324, - "processing": 0.0057981014251709, - "date_start": "2024-07-10T08:32:47+00:00", - "date_finish": "2024-07-10T08:32:47+00:00", - "operating_reset_at": 1720600967, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Удалить стадию канбана + Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач + + + +`Функция УдалитьСтадиюКанбана(Знач URL, Знач IDСтадии, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСтадии | --stage | Строка, Число | ID стадии для удаления | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
+ + +```bsl title="Пример кода" + IDСтадии = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); + + IDСтадии = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720600367.83205, + "finish": 1720600367.8709, + "duration": 0.0388522148132324, + "processing": 0.0057981014251709, + "date_start": "2024-07-10T08:32:47+00:00", + "date_finish": "2024-07-10T08:32:47+00:00", + "operating_reset_at": 1720600967, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md index fec1f5cab4..c18e03cdff 100644 --- a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md +++ b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -1,556 +1,556 @@ ---- -sidebar_position: 4 ---- - -# Получить стадии канбана - Получает информацию о стадиях Канбана или Моего плана - - - -`Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | - | КакАдминистратор | --admin | Булево | Позволяет получать стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтадииКанбана --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "20": { - "ID": "20", - "TITLE": "Новая стадия", - "SORT": "100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "NEW", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "24": { - "ID": "24", - "TITLE": "Название", - "SORT": "200", - "COLOR": "75d900", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "16": { - "ID": "16", - "TITLE": "Новая стадия", - "SORT": "300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "18": { - "ID": "18", - "TITLE": "Новая стадия 2", - "SORT": "400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "12": { - "ID": "12", - "TITLE": "Новая стадия", - "SORT": "500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "14": { - "ID": "14", - "TITLE": "Новая стадия 2", - "SORT": "600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "8": { - "ID": "8", - "TITLE": "Новая стадия", - "SORT": "700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "10": { - "ID": "10", - "TITLE": "Новая стадия 2", - "SORT": "800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "6": { - "ID": "6", - "TITLE": "Новая стадия", - "SORT": "900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "130": { - "ID": "130", - "TITLE": "Новая стадия", - "SORT": "1000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "132": { - "ID": "132", - "TITLE": "Новая стадия 2", - "SORT": "1100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "122": { - "ID": "122", - "TITLE": "Новая стадия", - "SORT": "1200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "124": { - "ID": "124", - "TITLE": "Новая стадия 2", - "SORT": "1300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "120": { - "ID": "120", - "TITLE": "Новая стадия 2", - "SORT": "1400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "114": { - "ID": "114", - "TITLE": "Новая стадия", - "SORT": "1500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "116": { - "ID": "116", - "TITLE": "Новая стадия 2", - "SORT": "1600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "112": { - "ID": "112", - "TITLE": "Новая стадия 2", - "SORT": "1700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "108": { - "ID": "108", - "TITLE": "Новая стадия 2", - "SORT": "1800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "104": { - "ID": "104", - "TITLE": "Новая стадия 2", - "SORT": "1900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "100": { - "ID": "100", - "TITLE": "Новая стадия 2", - "SORT": "2000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "96": { - "ID": "96", - "TITLE": "Новая стадия 2", - "SORT": "2100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "90": { - "ID": "90", - "TITLE": "Новая стадия", - "SORT": "2200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "92": { - "ID": "92", - "TITLE": "Новая стадия 2", - "SORT": "2300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "74": { - "ID": "74", - "TITLE": "Новая стадия", - "SORT": "2400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "76": { - "ID": "76", - "TITLE": "Новая стадия 2", - "SORT": "2500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "70": { - "ID": "70", - "TITLE": "Новая стадия", - "SORT": "2600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "72": { - "ID": "72", - "TITLE": "Новая стадия 2", - "SORT": "2700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "66": { - "ID": "66", - "TITLE": "Новая стадия", - "SORT": "2800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "68": { - "ID": "68", - "TITLE": "Новая стадия 2", - "SORT": "2900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "62": { - "ID": "62", - "TITLE": "Новая стадия", - "SORT": "3000", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "64": { - "ID": "64", - "TITLE": "Новая стадия 2", - "SORT": "3100", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "46": { - "ID": "46", - "TITLE": "Новая стадия", - "SORT": "3200", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "48": { - "ID": "48", - "TITLE": "Новая стадия 2", - "SORT": "3300", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "42": { - "ID": "42", - "TITLE": "Новая стадия", - "SORT": "3400", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "44": { - "ID": "44", - "TITLE": "Новая стадия 2", - "SORT": "3500", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "38": { - "ID": "38", - "TITLE": "Новая стадия", - "SORT": "3600", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "40": { - "ID": "40", - "TITLE": "Новая стадия 2", - "SORT": "3700", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "34": { - "ID": "34", - "TITLE": "Новая стадия", - "SORT": "3800", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "36": { - "ID": "36", - "TITLE": "Новая стадия 2", - "SORT": "3900", - "COLOR": "0026FF", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "2": { - "ID": "2", - "TITLE": "Не спланированы", - "SORT": "4000", - "COLOR": "00C4FB", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - }, - "4": { - "ID": "4", - "TITLE": "Сделаю на неделе", - "SORT": "4100", - "COLOR": "47D1E2", - "SYSTEM_TYPE": "", - "ENTITY_ID": "1", - "ENTITY_TYPE": "U", - "ADDITIONAL_FILTER": [], - "TO_UPDATE": [], - "TO_UPDATE_ACCESS": null - } - }, - "time": { - "start": 1720600362.36054, - "finish": 1720600362.39851, - "duration": 0.0379610061645508, - "processing": 0.00239396095275879, - "date_start": "2024-07-10T08:32:42+00:00", - "date_finish": "2024-07-10T08:32:42+00:00", - "operating_reset_at": 1720600962, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Получить стадии канбана + Получает информацию о стадиях Канбана или Моего плана + + + +`Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | + | КакАдминистратор | --admin | Булево | Позволяет получать стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтадииКанбана --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "20": { + "ID": "20", + "TITLE": "Новая стадия", + "SORT": "100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "NEW", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "24": { + "ID": "24", + "TITLE": "Название", + "SORT": "200", + "COLOR": "75d900", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "16": { + "ID": "16", + "TITLE": "Новая стадия", + "SORT": "300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "18": { + "ID": "18", + "TITLE": "Новая стадия 2", + "SORT": "400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "12": { + "ID": "12", + "TITLE": "Новая стадия", + "SORT": "500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "14": { + "ID": "14", + "TITLE": "Новая стадия 2", + "SORT": "600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "8": { + "ID": "8", + "TITLE": "Новая стадия", + "SORT": "700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "10": { + "ID": "10", + "TITLE": "Новая стадия 2", + "SORT": "800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "6": { + "ID": "6", + "TITLE": "Новая стадия", + "SORT": "900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "130": { + "ID": "130", + "TITLE": "Новая стадия", + "SORT": "1000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "132": { + "ID": "132", + "TITLE": "Новая стадия 2", + "SORT": "1100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "122": { + "ID": "122", + "TITLE": "Новая стадия", + "SORT": "1200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "124": { + "ID": "124", + "TITLE": "Новая стадия 2", + "SORT": "1300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "120": { + "ID": "120", + "TITLE": "Новая стадия 2", + "SORT": "1400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "114": { + "ID": "114", + "TITLE": "Новая стадия", + "SORT": "1500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "116": { + "ID": "116", + "TITLE": "Новая стадия 2", + "SORT": "1600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "112": { + "ID": "112", + "TITLE": "Новая стадия 2", + "SORT": "1700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "108": { + "ID": "108", + "TITLE": "Новая стадия 2", + "SORT": "1800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "104": { + "ID": "104", + "TITLE": "Новая стадия 2", + "SORT": "1900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "100": { + "ID": "100", + "TITLE": "Новая стадия 2", + "SORT": "2000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "96": { + "ID": "96", + "TITLE": "Новая стадия 2", + "SORT": "2100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "90": { + "ID": "90", + "TITLE": "Новая стадия", + "SORT": "2200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "92": { + "ID": "92", + "TITLE": "Новая стадия 2", + "SORT": "2300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "74": { + "ID": "74", + "TITLE": "Новая стадия", + "SORT": "2400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "76": { + "ID": "76", + "TITLE": "Новая стадия 2", + "SORT": "2500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "70": { + "ID": "70", + "TITLE": "Новая стадия", + "SORT": "2600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "72": { + "ID": "72", + "TITLE": "Новая стадия 2", + "SORT": "2700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "66": { + "ID": "66", + "TITLE": "Новая стадия", + "SORT": "2800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "68": { + "ID": "68", + "TITLE": "Новая стадия 2", + "SORT": "2900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "62": { + "ID": "62", + "TITLE": "Новая стадия", + "SORT": "3000", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "64": { + "ID": "64", + "TITLE": "Новая стадия 2", + "SORT": "3100", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "46": { + "ID": "46", + "TITLE": "Новая стадия", + "SORT": "3200", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "48": { + "ID": "48", + "TITLE": "Новая стадия 2", + "SORT": "3300", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "42": { + "ID": "42", + "TITLE": "Новая стадия", + "SORT": "3400", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "44": { + "ID": "44", + "TITLE": "Новая стадия 2", + "SORT": "3500", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "38": { + "ID": "38", + "TITLE": "Новая стадия", + "SORT": "3600", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "40": { + "ID": "40", + "TITLE": "Новая стадия 2", + "SORT": "3700", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "34": { + "ID": "34", + "TITLE": "Новая стадия", + "SORT": "3800", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "36": { + "ID": "36", + "TITLE": "Новая стадия 2", + "SORT": "3900", + "COLOR": "0026FF", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "2": { + "ID": "2", + "TITLE": "Не спланированы", + "SORT": "4000", + "COLOR": "00C4FB", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "4": { + "ID": "4", + "TITLE": "Сделаю на неделе", + "SORT": "4100", + "COLOR": "47D1E2", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + } + }, + "time": { + "start": 1720600362.36054, + "finish": 1720600362.39851, + "duration": 0.0379610061645508, + "processing": 0.00239396095275879, + "date_start": "2024-07-10T08:32:42+00:00", + "date_finish": "2024-07-10T08:32:42+00:00", + "operating_reset_at": 1720600962, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md index 2b930d330e..b0a241cfe4 100644 --- a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -1,70 +1,70 @@ ---- -sidebar_position: 5 ---- - -# Перенести задачу в стадию канбана - Переносит задачу в выбранную стадию канбана - - - -`Функция ПеренестиЗадачуВСтадиюКанбана(Знач URL, Знач IDЗадачи, Знач IDСтадии, Знач Перед = 0, Знач После = 0, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для переноса | - | IDСтадии | --stage | Строка, Число | ID стадии | - | Перед | --before | Строка, Число | ID задачи, перед которой надо поставить выбранную (если не заполнено После) | - | После | --after | Строка, Число | ID задачи, после которой надо поставить выбранную (если не заполнено Перед) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) -::: -
- - -```bsl title="Пример кода" - IDЗадачи = "1086"; - IDСтадии = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); - - IDСтадии = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии, , , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПеренестиЗадачуВСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720600364.06058, - "finish": 1720600364.11507, - "duration": 0.0544910430908203, - "processing": 0.0175719261169434, - "date_start": "2024-07-10T08:32:44+00:00", - "date_finish": "2024-07-10T08:32:44+00:00", - "operating_reset_at": 1720600964, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Перенести задачу в стадию канбана + Переносит задачу в выбранную стадию канбана + + + +`Функция ПеренестиЗадачуВСтадиюКанбана(Знач URL, Знач IDЗадачи, Знач IDСтадии, Знач Перед = 0, Знач После = 0, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для переноса | + | IDСтадии | --stage | Строка, Число | ID стадии | + | Перед | --before | Строка, Число | ID задачи, перед которой надо поставить выбранную (если не заполнено После) | + | После | --after | Строка, Число | ID задачи, после которой надо поставить выбранную (если не заполнено Перед) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
+ + +```bsl title="Пример кода" + IDЗадачи = "1086"; + IDСтадии = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); + + IDСтадии = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии, , , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПеренестиЗадачуВСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720600364.06058, + "finish": 1720600364.11507, + "duration": 0.0544910430908203, + "processing": 0.0175719261169434, + "date_start": "2024-07-10T08:32:44+00:00", + "date_finish": "2024-07-10T08:32:44+00:00", + "operating_reset_at": 1720600964, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md index 577cff198f..26d2132001 100644 --- a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md @@ -1,74 +1,74 @@ ---- -sidebar_position: 2 ---- - -# Изменить стадию канбана - Изменяет свойства существующей стадии канбана или Моего плана - - - -`Функция ИзменитьСтадиюКанбана(Знач URL, Знач Наименование, Знач IDСтадии, Знач Цвет = "", Знач IDПредыдущей = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Новое наименование стадии | - | IDСтадии | --stage | Строка, Число | ID стадии для изменения | - | Цвет | --color | Строка | HEX нового цвета стадии | - | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить выбранную | - | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя стадии стадии"; - Цвет = "000000"; - IDСтадии = "318"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); - - Наименование = "Новое имя стадии стадии 2"; - Цвет = "000000"; - IDСтадии = "320"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьСтадиюКанбана --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720816577.57757, - "finish": 1720816577.66624, - "duration": 0.0886678695678711, - "processing": 0.059006929397583, - "date_start": "2024-07-12T20:36:17+00:00", - "date_finish": "2024-07-12T20:36:17+00:00", - "operating_reset_at": 1720817177, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Изменить стадию канбана + Изменяет свойства существующей стадии канбана или Моего плана + + + +`Функция ИзменитьСтадиюКанбана(Знач URL, Знач Наименование, Знач IDСтадии, Знач Цвет = "", Знач IDПредыдущей = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Новое наименование стадии | + | IDСтадии | --stage | Строка, Число | ID стадии для изменения | + | Цвет | --color | Строка | HEX нового цвета стадии | + | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить выбранную | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя стадии стадии"; + Цвет = "000000"; + IDСтадии = "318"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); + + Наименование = "Новое имя стадии стадии 2"; + Цвет = "000000"; + IDСтадии = "320"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьСтадиюКанбана --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816577.57757, + "finish": 1720816577.66624, + "duration": 0.0886678695678711, + "processing": 0.059006929397583, + "date_start": "2024-07-12T20:36:17+00:00", + "date_finish": "2024-07-12T20:36:17+00:00", + "operating_reset_at": 1720817177, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Delete-message.md b/docs/ru/md/Bitrix24/Message-management/Delete-message.md index a4d1916db0..c0414c7ae6 100644 --- a/docs/ru/md/Bitrix24/Message-management/Delete-message.md +++ b/docs/ru/md/Bitrix24/Message-management/Delete-message.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 4 ---- - -# Удалить сообщение - Удаляет сообщение в диалоге - - - -`Функция УдалитьСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDСообщения = "8682"; - - Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDСообщения = "8684"; - - Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьСообщение --url %url% --message %message% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969167.77137, - "finish": 1720969167.82331, - "duration": 0.051936149597168, - "processing": 0.0215229988098145, - "date_start": "2024-07-14T14:59:27+00:00", - "date_finish": "2024-07-14T14:59:27+00:00", - "operating_reset_at": 1720969767, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение в диалоге + + + +`Функция УдалитьСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDСообщения = "8682"; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDСообщения = "8684"; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьСообщение --url %url% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969167.77137, + "finish": 1720969167.82331, + "duration": 0.051936149597168, + "processing": 0.0215229988098145, + "date_start": "2024-07-14T14:59:27+00:00", + "date_finish": "2024-07-14T14:59:27+00:00", + "operating_reset_at": 1720969767, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Edit-message.md b/docs/ru/md/Bitrix24/Message-management/Edit-message.md index 88239ac0ee..5d9a2a75e8 100644 --- a/docs/ru/md/Bitrix24/Message-management/Edit-message.md +++ b/docs/ru/md/Bitrix24/Message-management/Edit-message.md @@ -1,75 +1,75 @@ ---- -sidebar_position: 2 ---- - -# Изменить сообщение - Изменяет сообщение в диалоге - - - -`Функция ИзменитьСообщение(Знач URL, Знач IDСообщения, Знач Текст = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения для изменения | - | Текст | --text | Строка | Новый текст сообщения | - | Вложения | --blocks | Массив из Структура | Новый массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDСообщения = "8682"; - - Текст = "Новый текст сообщения"; - - Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDСообщения = "8684"; - - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьСообщение --url %url% --message %message% --text %text% --blocks %blocks% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969165.17314, - "finish": 1720969165.21621, - "duration": 0.0430619716644287, - "processing": 0.018265962600708, - "date_start": "2024-07-14T14:59:25+00:00", - "date_finish": "2024-07-14T14:59:25+00:00", - "operating_reset_at": 1720969765, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Изменить сообщение + Изменяет сообщение в диалоге + + + +`Функция ИзменитьСообщение(Знач URL, Знач IDСообщения, Знач Текст = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для изменения | + | Текст | --text | Строка | Новый текст сообщения | + | Вложения | --blocks | Массив из Структура | Новый массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDСообщения = "8682"; + + Текст = "Новый текст сообщения"; + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDСообщения = "8684"; + + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьСообщение --url %url% --message %message% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969165.17314, + "finish": 1720969165.21621, + "duration": 0.0430619716644287, + "processing": 0.018265962600708, + "date_start": "2024-07-14T14:59:25+00:00", + "date_finish": "2024-07-14T14:59:25+00:00", + "operating_reset_at": 1720969765, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-file-block.md b/docs/ru/md/Bitrix24/Message-management/Get-file-block.md index ba67a794ba..80105af07b 100644 --- a/docs/ru/md/Bitrix24/Message-management/Get-file-block.md +++ b/docs/ru/md/Bitrix24/Message-management/Get-file-block.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 9 ---- - -# Получить блок файла - Формирует блок файла для отправки в функции ОтправитьСообщение - - - -`Функция ПолучитьБлокФайла(Знач Наименование, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование картинки | - | URL | --url | Строка | URL файла для отправки | - - - Возвращаемое значение: Структура - Блок с файлом - -
- -:::tip -Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьБлокФайла --title %title% --url %url% - -``` - - +--- +sidebar_position: 9 +--- + +# Получить блок файла + Формирует блок файла для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокФайла(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL файла для отправки | + + + Возвращаемое значение: Структура - Блок с файлом + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьБлокФайла --title %title% --url %url% + +``` + + diff --git a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md index 8a17edd29a..239b5ecfb3 100644 --- a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md +++ b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md @@ -1,37 +1,37 @@ ---- -sidebar_position: 8 ---- - -# Получить блок картинки - Формирует картинку для отправки в функции ОтправитьСообщение - - - -`Функция ПолучитьБлокКартинки(Знач Наименование, Знач URL) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Наименование | --title | Строка | Наименование картинки | - | URL | --url | Строка | URL картинки для отправки | - - - Возвращаемое значение: Структура - Блок с картинкой - -
- -:::tip -Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) -::: -
- - - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьБлокКартинки --title %title% --url %url% - -``` - - +--- +sidebar_position: 8 +--- + +# Получить блок картинки + Формирует картинку для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокКартинки(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL картинки для отправки | + + + Возвращаемое значение: Структура - Блок с картинкой + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьБлокКартинки --title %title% --url %url% + +``` + + diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md index 52de9c87b3..fb8a1a27f7 100644 --- a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 6 ---- - -# Отметить сообщение как прочитанное - Отмечает выбранное сообщение и все сообщения до него как прочитанные - - - -`Функция ОтметитьСообщениеКакПрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDСообщения | --message | Строка, Число | ID последнего прочитанного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - IDСообщения = "8682"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - IDСообщения = "8684"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDПользователя, IDСообщения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтметитьСообщениеКакПрочитанное --url %url% --chat %chat% --message %message% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "dialogId": 10, - "chatId": 10, - "lastId": 5262, - "counter": 0 - }, - "time": { - "start": 1720969157.61149, - "finish": 1720969157.65659, - "duration": 0.0451040267944336, - "processing": 0.0171201229095459, - "date_start": "2024-07-14T14:59:17+00:00", - "date_finish": "2024-07-14T14:59:17+00:00", - "operating_reset_at": 1720969757, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Отметить сообщение как прочитанное + Отмечает выбранное сообщение и все сообщения до него как прочитанные + + + +`Функция ОтметитьСообщениеКакПрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID последнего прочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + IDСообщения = "8682"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + IDСообщения = "8684"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDПользователя, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтметитьСообщениеКакПрочитанное --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 5262, + "counter": 0 + }, + "time": { + "start": 1720969157.61149, + "finish": 1720969157.65659, + "duration": 0.0451040267944336, + "processing": 0.0171201229095459, + "date_start": "2024-07-14T14:59:17+00:00", + "date_finish": "2024-07-14T14:59:17+00:00", + "operating_reset_at": 1720969757, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md index 6d03d76c4b..a991b7cbac 100644 --- a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md @@ -1,67 +1,67 @@ ---- -sidebar_position: 7 ---- - -# Отметить сообщение как непрочитанное - Отмечает выбранное сообщение и все сообщения после него как непрочитанные - - - -`Функция ОтметитьСообщениеКакНепрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | IDСообщения | --message | Строка, Число | ID послднего непрочитанного сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - IDСообщения = "8682"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - IDСообщения = "8684"; - - Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDПользователя, IDСообщения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтметитьСообщениеКакНепрочитанное --url %url% --chat %chat% --message %message% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969158.8803, - "finish": 1720969158.91584, - "duration": 0.035538911819458, - "processing": 0.0112378597259521, - "date_start": "2024-07-14T14:59:18+00:00", - "date_finish": "2024-07-14T14:59:18+00:00", - "operating_reset_at": 1720969758, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Отметить сообщение как непрочитанное + Отмечает выбранное сообщение и все сообщения после него как непрочитанные + + + +`Функция ОтметитьСообщениеКакНепрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID послднего непрочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + IDСообщения = "8682"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + IDСообщения = "8684"; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDПользователя, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтметитьСообщениеКакНепрочитанное --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969158.8803, + "finish": 1720969158.91584, + "duration": 0.035538911819458, + "processing": 0.0112378597259521, + "date_start": "2024-07-14T14:59:18+00:00", + "date_finish": "2024-07-14T14:59:18+00:00", + "operating_reset_at": 1720969758, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-file.md b/docs/ru/md/Bitrix24/Message-management/Send-file.md index dbacb3b110..1febd3ab1b 100644 --- a/docs/ru/md/Bitrix24/Message-management/Send-file.md +++ b/docs/ru/md/Bitrix24/Message-management/Send-file.md @@ -1,143 +1,143 @@ ---- -sidebar_position: 5 ---- - -# Отправить файл - Отправляет файл диска в чат по ID - - - -`Функция ОтправитьФайл(Знач URL, Знач IDЧата, Знач IDФайла, Знач Описание = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата | - | IDФайла | --fileid | Строка, Число | ID файла, загруженного при помощи ЗагрузитьФайлВКаталог | - | Описание | --description | Строка | Описание файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "450"; - Файл = "https://openintegrations.dev/test_data/document.docx"; // Двоичные данные, URL или путь к файлу - Описание = "Очень важный файл"; - - Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); - IDКаталога = Каталог["result"]["ID"]; - - ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); - IDФайла = ЗагруженныйФайл["result"]["ID"]; - - Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЧата = "452"; - - Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); - IDКаталога = Каталог["result"]["ID"]; - - ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); - IDФайла = ЗагруженныйФайл["result"]["ID"]; - - Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтправитьФайл --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "FILES": { - "upload3254": { - "id": 3254, - "chatId": 254, - "date": {}, - "type": "file", - "name": "Важный документ.docx", - "extension": "docx", - "size": 24071, - "image": false, - "status": "done", - "progress": 100, - "authorId": 1, - "authorName": "Антон Титовец", - "urlPreview": "", - "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerAttrs": { - "viewer": null, - "viewerType": "cloud-document", - "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", - "viewerSeparateItem": true, - "viewerExtension": "im.integration.viewer", - "objectId": "3254", - "imChatId": 254, - "title": "Важный документ.docx", - "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" - } - } - }, - "DISK_ID": [ - "3254" - ], - "FILE_MODELS": { - "upload3254": { - "id": 3254, - "name": "Важный документ.docx", - "createTime": {}, - "updateTime": {}, - "deleteTime": null, - "code": null, - "xmlId": null, - "storageId": 6, - "realObjectId": 3254, - "parentId": 3250, - "deletedType": 0, - "createdBy": "1", - "updatedBy": "1", - "deletedBy": "0", - "typeFile": 4, - "globalContentVersion": 2, - "fileId": 2330, - "size": 24071, - "etag": "1179305ea90d0b0fef106e1163deaeb8", - "links": { - "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", - "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" - } - } - }, - "MESSAGE_ID": 5346 - }, - "time": { - "start": 1720969175.0006, - "finish": 1720969175.09084, - "duration": 0.0902431011199951, - "processing": 0.0652461051940918, - "date_start": "2024-07-14T14:59:35+00:00", - "date_finish": "2024-07-14T14:59:35+00:00", - "operating_reset_at": 1720969775, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Отправить файл + Отправляет файл диска в чат по ID + + + +`Функция ОтправитьФайл(Знач URL, Знач IDЧата, Знач IDФайла, Знач Описание = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDФайла | --fileid | Строка, Число | ID файла, загруженного при помощи ЗагрузитьФайлВКаталог | + | Описание | --description | Строка | Описание файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "450"; + Файл = "https://openintegrations.dev/test_data/document.docx"; // Двоичные данные, URL или путь к файлу + Описание = "Очень важный файл"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЧата = "452"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьФайл --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "FILES": { + "upload3254": { + "id": 3254, + "chatId": 254, + "date": {}, + "type": "file", + "name": "Важный документ.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Антон Титовец", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "3254", + "imChatId": 254, + "title": "Важный документ.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "3254" + ], + "FILE_MODELS": { + "upload3254": { + "id": 3254, + "name": "Важный документ.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 3254, + "parentId": 3250, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 2330, + "size": 24071, + "etag": "1179305ea90d0b0fef106e1163deaeb8", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 5346 + }, + "time": { + "start": 1720969175.0006, + "finish": 1720969175.09084, + "duration": 0.0902431011199951, + "processing": 0.0652461051940918, + "date_start": "2024-07-14T14:59:35+00:00", + "date_finish": "2024-07-14T14:59:35+00:00", + "operating_reset_at": 1720969775, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-message.md b/docs/ru/md/Bitrix24/Message-management/Send-message.md index 0d789b480d..ca96fd6034 100644 --- a/docs/ru/md/Bitrix24/Message-management/Send-message.md +++ b/docs/ru/md/Bitrix24/Message-management/Send-message.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 1 ---- - -# Отправить сообщение - Отправляет сообщение в диалог - - - -`Функция ОтправитьСообщение(Знач URL, Знач IDЧата, Знач Текст, Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | - | Текст | --text | Строка | Текст сообщения | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЧата = "chat" + "450"; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 10; - - Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтправитьСообщение --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% - -``` - -```json title="Результат" -{ - "result": 5342, - "time": { - "start": 1720969163.89343, - "finish": 1720969163.95538, - "duration": 0.061945915222168, - "processing": 0.0366020202636719, - "date_start": "2024-07-14T14:59:23+00:00", - "date_finish": "2024-07-14T14:59:23+00:00", - "operating_reset_at": 1720969763, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в диалог + + + +`Функция ОтправитьСообщение(Знач URL, Знач IDЧата, Знач Текст, Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Текст | --text | Строка | Текст сообщения | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЧата = "chat" + "450"; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьСообщение --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": 5342, + "time": { + "start": 1720969163.89343, + "finish": 1720969163.95538, + "duration": 0.061945915222168, + "processing": 0.0366020202636719, + "date_start": "2024-07-14T14:59:23+00:00", + "date_finish": "2024-07-14T14:59:23+00:00", + "operating_reset_at": 1720969763, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md index eb36129850..3b93c840f0 100644 --- a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md +++ b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Установить реакцию на сообщение - Устанавливает или снимает реакцию на сообщение - - - -`Функция УстановитьРеакциюНаСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDСообщения | --message | Строка, Число | ID сообщения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDСообщения = "8682"; - - Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDСообщения = "8684"; - - Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УстановитьРеакциюНаСообщение --url %url% --message %message% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720969166.51361, - "finish": 1720969166.55322, - "duration": 0.0396139621734619, - "processing": 0.0151541233062744, - "date_start": "2024-07-14T14:59:26+00:00", - "date_finish": "2024-07-14T14:59:26+00:00", - "operating_reset_at": 1720969766, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Установить реакцию на сообщение + Устанавливает или снимает реакцию на сообщение + + + +`Функция УстановитьРеакциюНаСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDСообщения = "8682"; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDСообщения = "8684"; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УстановитьРеакциюНаСообщение --url %url% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969166.51361, + "finish": 1720969166.55322, + "duration": 0.0396139621734619, + "processing": 0.0151541233062744, + "date_start": "2024-07-14T14:59:26+00:00", + "date_finish": "2024-07-14T14:59:26+00:00", + "operating_reset_at": 1720969766, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md index 5ebaac5fb3..c4da0022b5 100644 --- a/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-personal-notification.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 1 ---- - -# Создать персональное уведомление - Создает персональное уведомление пользователю - - - -`Функция СоздатьПерсональноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | - | Текст | --text | Строка | Текст уведомления | - | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) -::: -
- - -```bsl title="Пример кода" - IDПользователя = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - Тег = "Новый"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьПерсональноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% - -``` - -```json title="Результат" -{ - "result": 7450, - "time": { - "start": 1722087269.44996, - "finish": 1722087269.50075, - "duration": 0.0507829189300537, - "processing": 0.0262038707733154, - "date_start": "2024-07-27T13:34:29+00:00", - "date_finish": "2024-07-27T13:34:29+00:00", - "operating_reset_at": 1722087869, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Создать персональное уведомление + Создает персональное уведомление пользователю + + + +`Функция СоздатьПерсональноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьПерсональноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьПерсональноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": 7450, + "time": { + "start": 1722087269.44996, + "finish": 1722087269.50075, + "duration": 0.0507829189300537, + "processing": 0.0262038707733154, + "date_start": "2024-07-27T13:34:29+00:00", + "date_finish": "2024-07-27T13:34:29+00:00", + "operating_reset_at": 1722087869, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md index 10459f711f..03a8d7dc75 100644 --- a/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md +++ b/docs/ru/md/Bitrix24/Notifications-managment/Create-system-notification.md @@ -1,76 +1,76 @@ ---- -sidebar_position: 2 ---- - -# Создать системное уведомление - Создает системное уведомление пользователю - - - -`Функция СоздатьСистемноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | - | Текст | --text | Строка | Текст уведомления | - | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | - | Вложения | --blocks | Массив из Структура | Массив блоков вложений | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) -::: -
- - -```bsl title="Пример кода" - IDПользователя = 1; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Текст = "Текст сообщения"; - Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; - Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; - - Вложения = Новый Массив; - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); - Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); - - Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - Тег = "Новый"; - IDПользователя = 10; - - Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьСистемноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% - -``` - -```json title="Результат" -{ - "result": 7454, - "time": { - "start": 1722087270.72466, - "finish": 1722087270.78145, - "duration": 0.0567879676818848, - "processing": 0.0293958187103272, - "date_start": "2024-07-27T13:34:30+00:00", - "date_finish": "2024-07-27T13:34:30+00:00", - "operating_reset_at": 1722087870, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Создать системное уведомление + Создает системное уведомление пользователю + + + +`Функция СоздатьСистемноеУведомление(Знач URL, Знач IDПользователя, Знач Текст, Знач Тег = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --user | Строка, Число | ID пользователя для отправки уведомления | + | Текст | --text | Строка | Текст уведомления | + | Тег | --tag | Строка | Тег уникальности Если уже существет, то другие увед. будут удалены | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131) +::: +
+ + +```bsl title="Пример кода" + IDПользователя = 1; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx" , Файл)); + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, ,Вложения); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + Тег = "Новый"; + IDПользователя = 10; + + Результат = OPI_Bitrix24.СоздатьСистемноеУведомление(URL, IDПользователя, Текст, Тег, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьСистемноеУведомление --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": 7454, + "time": { + "start": 1722087270.72466, + "finish": 1722087270.78145, + "duration": 0.0567879676818848, + "processing": 0.0293958187103272, + "date_start": "2024-07-27T13:34:30+00:00", + "date_finish": "2024-07-27T13:34:30+00:00", + "operating_reset_at": 1722087870, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md index 4141ac896d..cc63dedba7 100644 --- a/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md +++ b/docs/ru/md/Bitrix24/Notifications-managment/Delete-notification.md @@ -1,64 +1,64 @@ ---- -sidebar_position: 3 ---- - -# Удалить уведомление - Удаляет уведомление по ID - - - -`Функция УдалитьУведомление(Знач URL, Знач IDУведомления, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDУведомления | --notif | Строка, Число | ID уведомления для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDУведомления = "8690"; - - Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDУведомления = "8692"; - - Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьУведомление --url %url% --notif %notif% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722087271.36087, - "finish": 1722087271.39818, - "duration": 0.0373120307922363, - "processing": 0.0110759735107422, - "date_start": "2024-07-27T13:34:31+00:00", - "date_finish": "2024-07-27T13:34:31+00:00", - "operating_reset_at": 1722087871, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Удалить уведомление + Удаляет уведомление по ID + + + +`Функция УдалитьУведомление(Знач URL, Знач IDУведомления, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDУведомления | --notif | Строка, Число | ID уведомления для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDУведомления = "8690"; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDУведомления = "8692"; + + Результат = OPI_Bitrix24.УдалитьУведомление(URL, IDУведомления, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьУведомление --url %url% --notif %notif% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722087271.36087, + "finish": 1722087271.39818, + "duration": 0.0373120307922363, + "processing": 0.0110759735107422, + "date_start": "2024-07-27T13:34:31+00:00", + "date_finish": "2024-07-27T13:34:31+00:00", + "operating_reset_at": 1722087871, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md index 4fb960e2e6..28d4e76fa8 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 6 ---- - -# Создать каталог в хранилище - Создает пустой каталог в хранилище - - - -`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка | Идентификатор хранилища | - | Наименование | --title | Строка | Имя каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) -::: -
- - -```bsl title="Пример кода" - IDХранилища = 3; - Наименование = "Новый каталог"; - Наименование2 = "Новый каталог 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьКаталогВХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 574, - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 574, - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-06-22T09:07:36+00:00", - "UPDATE_TIME": "2024-06-22T09:07:36+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1719047256.22025, - "finish": 1719047256.27758, - "duration": 0.057330846786499, - "processing": 0.0276291370391846, - "date_start": "2024-06-22T09:07:36+00:00", - "date_finish": "2024-06-22T09:07:36+00:00", - "operating_reset_at": 1719047856, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Создать каталог в хранилище + Создает пустой каталог в хранилище + + + +`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка | Идентификатор хранилища | + | Наименование | --title | Строка | Имя каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Пример кода" + IDХранилища = 3; + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьКаталогВХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 574, + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 574, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-22T09:07:36+00:00", + "UPDATE_TIME": "2024-06-22T09:07:36+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1719047256.22025, + "finish": 1719047256.27758, + "duration": 0.057330846786499, + "processing": 0.0276291370391846, + "date_start": "2024-06-22T09:07:36+00:00", + "date_finish": "2024-06-22T09:07:36+00:00", + "operating_reset_at": 1719047856, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md index 398f721748..f5e7dfd45d 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md @@ -1,65 +1,65 @@ ---- -sidebar_position: 2 ---- - -# Получить хранилище приложения - Получает информацию о хранилище с которым может работать приложение для хранения своих данных - - - -`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) -::: -
- - -```bsl title="Пример кода" - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьХранилищеПриложения --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "18", - "NAME": "New storage name", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1721067694.96416, - "finish": 1721067694.99489, - "duration": 0.0307230949401856, - "processing": 0.00391507148742676, - "date_start": "2024-07-15T18:21:34+00:00", - "date_finish": "2024-07-15T18:21:34+00:00", - "operating_reset_at": 1721068294, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Получить хранилище приложения + Получает информацию о хранилище с которым может работать приложение для хранения своих данных + + + +`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Пример кода" + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьХранилищеПриложения --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1721067694.96416, + "finish": 1721067694.99489, + "duration": 0.0307230949401856, + "processing": 0.00391507148742676, + "date_start": "2024-07-15T18:21:34+00:00", + "date_finish": "2024-07-15T18:21:34+00:00", + "operating_reset_at": 1721068294, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md index 3472eb34ac..d00db49ab1 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md @@ -1,105 +1,105 @@ ---- -sidebar_position: 5 ---- - -# Получить содержимое хранилища - Получает список файлов и каталогов, находящихся в корне хранилища - - - -`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDХранилища = 3; - - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСодержимоеХранилища --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "568", - "NAME": "Картинка2.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "558", - "SIZE": "2114023", - "CREATE_TIME": "2024-06-22T09:07:30+00:00", - "UPDATE_TIME": "2024-06-22T09:07:30+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" - }, - { - "ID": "570", - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "560", - "SIZE": "805189", - "CREATE_TIME": "2024-06-22T09:07:32+00:00", - "UPDATE_TIME": "2024-06-22T09:07:32+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - } - ], - "total": 2, - "time": { - "start": 1719047253.42516, - "finish": 1719047253.47205, - "duration": 0.0468947887420654, - "processing": 0.016359806060791, - "date_start": "2024-06-22T09:07:33+00:00", - "date_finish": "2024-06-22T09:07:33+00:00", - "operating_reset_at": 1719047853, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Получить содержимое хранилища + Получает список файлов и каталогов, находящихся в корне хранилища + + + +`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDХранилища = 3; + + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСодержимоеХранилища --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "568", + "NAME": "Картинка2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "558", + "SIZE": "2114023", + "CREATE_TIME": "2024-06-22T09:07:30+00:00", + "UPDATE_TIME": "2024-06-22T09:07:30+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" + }, + { + "ID": "570", + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "560", + "SIZE": "805189", + "CREATE_TIME": "2024-06-22T09:07:32+00:00", + "UPDATE_TIME": "2024-06-22T09:07:32+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + } + ], + "total": 2, + "time": { + "start": 1719047253.42516, + "finish": 1719047253.47205, + "duration": 0.0468947887420654, + "processing": 0.016359806060791, + "date_start": "2024-06-22T09:07:33+00:00", + "date_finish": "2024-06-22T09:07:33+00:00", + "operating_reset_at": 1719047853, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md index 445b4766a3..b43a8f03a5 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md @@ -1,71 +1,71 @@ ---- -sidebar_position: 3 ---- - -# Получить хранилище - Получает информацию о хранилище по ID - - - -`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDХранилища = 3; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - "time": { - "start": 1719047247.65416, - "finish": 1719047247.68963, - "duration": 0.0354659557342529, - "processing": 0.00417995452880859, - "date_start": "2024-06-22T09:07:27+00:00", - "date_finish": "2024-06-22T09:07:27+00:00", - "operating_reset_at": 1719047847, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Получить хранилище + Получает информацию о хранилище по ID + + + +`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDХранилища = 3; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1719047247.65416, + "finish": 1719047247.68963, + "duration": 0.0354659557342529, + "processing": 0.00417995452880859, + "date_start": "2024-06-22T09:07:27+00:00", + "date_finish": "2024-06-22T09:07:27+00:00", + "operating_reset_at": 1719047847, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md index 196b5cbd07..69d9f1d5d1 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md @@ -1,125 +1,125 @@ ---- -sidebar_position: 1 ---- - -# Получить список хранилищ - Получает список доступных хранилищ файлов - - - -`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокХранилищ --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - { - "ID": "1", - "NAME": "Антон Титовец", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "1", - "ROOT_OBJECT_ID": "1" - }, - { - "ID": "16", - "NAME": "iscript13@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "10", - "ROOT_OBJECT_ID": "270" - }, - { - "ID": "4", - "NAME": "Payment Processing Customer Support", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "4" - }, - { - "ID": "10", - "NAME": "CoPilot", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "4", - "ROOT_OBJECT_ID": "52" - }, - { - "ID": "12", - "NAME": "Поддержка Битрикс24", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "6", - "ROOT_OBJECT_ID": "70" - }, - { - "ID": "14", - "NAME": "Марта", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "8", - "ROOT_OBJECT_ID": "72" - } - ], - "total": 7, - "time": { - "start": 1718783911.64028, - "finish": 1718783911.69026, - "duration": 0.0499801635742188, - "processing": 0.00660109519958496, - "date_start": "2024-06-19T07:58:31+00:00", - "date_finish": "2024-06-19T07:58:31+00:00", - "operating_reset_at": 1718784511, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить список хранилищ + Получает список доступных хранилищ файлов + + + +`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокХранилищ --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "1", + "NAME": "Антон Титовец", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Поддержка Битрикс24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Марта", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + } + ], + "total": 7, + "time": { + "start": 1718783911.64028, + "finish": 1718783911.69026, + "duration": 0.0499801635742188, + "processing": 0.00660109519958496, + "date_start": "2024-06-19T07:58:31+00:00", + "date_finish": "2024-06-19T07:58:31+00:00", + "operating_reset_at": 1718784511, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md index 2b2f71f7f1..b657f83d8f 100644 --- a/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md @@ -1,69 +1,69 @@ ---- -sidebar_position: 4 ---- - -# Переименовать хранилище - Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) - - - -`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Наименование | --title | Строка | Новое наименование хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) -::: -
- - -```bsl title="Пример кода" - Наименование = "Новое имя хранилища"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDХранилища = "18"; - - Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереименоватьХранилище --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "18", - "NAME": "Новое имя хранилища", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1719047246.29499, - "finish": 1719047246.35783, - "duration": 0.062842845916748, - "processing": 0.0317339897155762, - "date_start": "2024-06-22T09:07:26+00:00", - "date_finish": "2024-06-22T09:07:26+00:00", - "operating_reset_at": 1719047846, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Переименовать хранилище + Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) + + + +`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Наименование | --title | Строка | Новое наименование хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя хранилища"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDХранилища = "18"; + + Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереименоватьХранилище --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "18", + "NAME": "Новое имя хранилища", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1719047246.29499, + "finish": 1719047246.35783, + "duration": 0.062842845916748, + "processing": 0.0317339897155762, + "date_start": "2024-06-22T09:07:26+00:00", + "date_finish": "2024-06-22T09:07:26+00:00", + "operating_reset_at": 1719047846, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md index 68f325ff6a..3d004c457f 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 1 ---- - -# Добавить элемент чеклиста задачи - Добавляет новый элемент чеклиста задачи - - - -`Функция ДобавитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Выполнен = Ложь, Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Текст | --text | Строка | Текст (заголовок) пункта чек листа | - | Выполнен | --complete | Булево | Отметить пункт как выполненный | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - - Текст = "Пункт чек-листа"; - - Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьЭлементЧеклистаЗадачи --url %url% --task %task% --text %text% --complete %complete% --token %token% - -``` - -```json title="Результат" -{ - "result": 96, - "time": { - "start": 1720816505.3041, - "finish": 1720816505.37014, - "duration": 0.0660440921783447, - "processing": 0.0380921363830566, - "date_start": "2024-07-12T20:35:05+00:00", - "date_finish": "2024-07-12T20:35:05+00:00", - "operating_reset_at": 1720817105, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Добавить элемент чеклиста задачи + Добавляет новый элемент чеклиста задачи + + + +`Функция ДобавитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Выполнен = Ложь, Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Выполнен | --complete | Булево | Отметить пункт как выполненный | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + + Текст = "Пункт чек-листа"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьЭлементЧеклистаЗадачи --url %url% --task %task% --text %text% --complete %complete% --token %token% + +``` + +```json title="Результат" +{ + "result": 96, + "time": { + "start": 1720816505.3041, + "finish": 1720816505.37014, + "duration": 0.0660440921783447, + "processing": 0.0380921363830566, + "date_start": "2024-07-12T20:35:05+00:00", + "date_finish": "2024-07-12T20:35:05+00:00", + "operating_reset_at": 1720817105, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md index f9df5b3b99..ab27ae767e 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 6 ---- - -# Выполнить элемент чеклиста задачи - Помечает элемент чеклиста задачи как выполненный - - - -`Функция ВыполнитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDЭлемента = "396"; - - Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "1080"; - IDЭлемента = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВыполнитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720816509.8981, - "finish": 1720816509.94922, - "duration": 0.0511200428009033, - "processing": 0.0246191024780273, - "date_start": "2024-07-12T20:35:09+00:00", - "date_finish": "2024-07-12T20:35:09+00:00", - "operating_reset_at": 1720817109, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Выполнить элемент чеклиста задачи + Помечает элемент чеклиста задачи как выполненный + + + +`Функция ВыполнитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDЭлемента = "396"; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "1080"; + IDЭлемента = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВыполнитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816509.8981, + "finish": 1720816509.94922, + "duration": 0.0511200428009033, + "processing": 0.0246191024780273, + "date_start": "2024-07-12T20:35:09+00:00", + "date_finish": "2024-07-12T20:35:09+00:00", + "operating_reset_at": 1720817109, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md index c880429c4d..1d11633165 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 3 ---- - -# Удалить элемент чеклиста задачи - Удаляет элемент из чеклиста задачи - - - -`Функция УдалитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента для удаления | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDЭлемента = "396"; - - Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "1080"; - IDЭлемента = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720816512.25818, - "finish": 1720816512.30984, - "duration": 0.0516610145568848, - "processing": 0.0264489650726318, - "date_start": "2024-07-12T20:35:12+00:00", - "date_finish": "2024-07-12T20:35:12+00:00", - "operating_reset_at": 1720817112, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Удалить элемент чеклиста задачи + Удаляет элемент из чеклиста задачи + + + +`Функция УдалитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDЭлемента = "396"; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "1080"; + IDЭлемента = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816512.25818, + "finish": 1720816512.30984, + "duration": 0.0516610145568848, + "processing": 0.0264489650726318, + "date_start": "2024-07-12T20:35:12+00:00", + "date_finish": "2024-07-12T20:35:12+00:00", + "operating_reset_at": 1720817112, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md index 17c1b7486e..1f0ee49bd3 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md @@ -1,81 +1,81 @@ ---- -sidebar_position: 5 ---- - -# Получить элемент чеклиста задачи - Получить элемент чеклиста задачи по ID - - - -`Функция ПолучитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDЭлемента = "396"; - - Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "1080"; - IDЭлемента = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": "96", - "TASK_ID": "632", - "PARENT_ID": "94", - "CREATED_BY": "1", - "TITLE": "Новый текст пункта чек-листа", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - "time": { - "start": 1720816508.81324, - "finish": 1720816508.85536, - "duration": 0.0421209335327148, - "processing": 0.0174088478088379, - "date_start": "2024-07-12T20:35:08+00:00", - "date_finish": "2024-07-12T20:35:08+00:00", - "operating_reset_at": 1720817108, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Получить элемент чеклиста задачи + Получить элемент чеклиста задачи по ID + + + +`Функция ПолучитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDЭлемента = "396"; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "1080"; + IDЭлемента = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1720816508.81324, + "finish": 1720816508.85536, + "duration": 0.0421209335327148, + "processing": 0.0174088478088379, + "date_start": "2024-07-12T20:35:08+00:00", + "date_finish": "2024-07-12T20:35:08+00:00", + "operating_reset_at": 1720817108, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md index 8547cfeba2..4b556ded65 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md @@ -1,93 +1,93 @@ ---- -sidebar_position: 4 ---- - -# Получить чеклист задачи - Получает список элементов чеклиста задачи - - - -`Функция ПолучитьЧеклистЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - - Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьЧеклистЗадачи --url %url% --task %task% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "94", - "TASK_ID": "632", - "PARENT_ID": 0, - "CREATED_BY": "1", - "TITLE": "BX_CHECKLIST_1", - "SORT_INDEX": "0", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - }, - { - "ID": "96", - "TASK_ID": "632", - "PARENT_ID": "94", - "CREATED_BY": "1", - "TITLE": "Новый текст пункта чек-листа", - "SORT_INDEX": "1", - "IS_COMPLETE": "N", - "IS_IMPORTANT": "N", - "TOGGLED_BY": null, - "TOGGLED_DATE": "", - "MEMBERS": [], - "ATTACHMENTS": [] - } - ], - "time": { - "start": 1720816507.68937, - "finish": 1720816507.74166, - "duration": 0.0522880554199219, - "processing": 0.0231881141662598, - "date_start": "2024-07-12T20:35:07+00:00", - "date_finish": "2024-07-12T20:35:07+00:00", - "operating_reset_at": 1720817107, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Получить чеклист задачи + Получает список элементов чеклиста задачи + + + +`Функция ПолучитьЧеклистЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьЧеклистЗадачи --url %url% --task %task% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "94", + "TASK_ID": "632", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1720816507.68937, + "finish": 1720816507.74166, + "duration": 0.0522880554199219, + "processing": 0.0231881141662598, + "date_start": "2024-07-12T20:35:07+00:00", + "date_finish": "2024-07-12T20:35:07+00:00", + "operating_reset_at": 1720817107, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md index 778302e7a2..e297b60bd6 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 7 ---- - -# Возобновить элемент чеклиста задачи - Снимает пометку элемента как выполненного - - - -`Функция ВозобновитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDЭлемента = "396"; - - Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); - - IDЗадачи = "1080"; - IDЭлемента = "400"; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВозобновитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1720816511.09347, - "finish": 1720816511.14508, - "duration": 0.051609992980957, - "processing": 0.0250108242034912, - "date_start": "2024-07-12T20:35:11+00:00", - "date_finish": "2024-07-12T20:35:11+00:00", - "operating_reset_at": 1720817111, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Возобновить элемент чеклиста задачи + Снимает пометку элемента как выполненного + + + +`Функция ВозобновитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDЭлемента = "396"; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + IDЗадачи = "1080"; + IDЭлемента = "400"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВозобновитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816511.09347, + "finish": 1720816511.14508, + "duration": 0.051609992980957, + "processing": 0.0250108242034912, + "date_start": "2024-07-12T20:35:11+00:00", + "date_finish": "2024-07-12T20:35:11+00:00", + "operating_reset_at": 1720817111, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md index 1c19f4f703..46794bceb0 100644 --- a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md @@ -1,70 +1,70 @@ ---- -sidebar_position: 2 ---- - -# Изменить элемент чеклиста задачи - Изменяет текст элемента чеклиста задачи - - - -`Функция ИзменитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Текст, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDЭлемента | --element | Число, Строка | ID элемента чеклиста | - | Текст | --text | Строка | Текст (заголовок) пункта чек листа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDЭлемента = "396"; - - Текст = "Новый текст пункта чек-листа"; - - Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - IDЭлемента = "400"; - - Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --text %text% --token %token% - -``` - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1720816506.52861, - "finish": 1720816506.58416, - "duration": 0.0555450916290283, - "processing": 0.027979850769043, - "date_start": "2024-07-12T20:35:06+00:00", - "date_finish": "2024-07-12T20:35:06+00:00", - "operating_reset_at": 1720817106, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Изменить элемент чеклиста задачи + Изменяет текст элемента чеклиста задачи + + + +`Функция ИзменитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента чеклиста | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDЭлемента = "396"; + + Текст = "Новый текст пункта чек-листа"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + IDЭлемента = "400"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --text %text% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816506.52861, + "finish": 1720816506.58416, + "duration": 0.0555450916290283, + "processing": 0.027979850769043, + "date_start": "2024-07-12T20:35:06+00:00", + "date_finish": "2024-07-12T20:35:06+00:00", + "operating_reset_at": 1720817106, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md index 2a65dc8005..00a69b41dc 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -1,68 +1,68 @@ ---- -sidebar_position: 6 ---- - -# Добавить файл в задачу - Прикрепляет файл к выбранной задаче - - - -`Функция ДобавитьФайлВЗадачу(Знач URL, Знач IDЗадачи, Знач IDФайла, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число, Строка | ID задачи | - | IDФайла | --fileid | Число, Строка | ID Файла | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - IDФайла = "5006"; - - Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьФайлВЗадачу --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "attachmentId": 598 - }, - "time": { - "start": 1720017736.90778, - "finish": 1720017736.97555, - "duration": 0.0677700042724609, - "processing": 0.0367820262908936, - "date_start": "2024-07-03T14:42:16+00:00", - "date_finish": "2024-07-03T14:42:16+00:00", - "operating_reset_at": 1720018336, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Добавить файл в задачу + Прикрепляет файл к выбранной задаче + + + +`Функция ДобавитьФайлВЗадачу(Знач URL, Знач IDЗадачи, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDФайла | --fileid | Число, Строка | ID Файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + IDФайла = "5006"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьФайлВЗадачу --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "attachmentId": 598 + }, + "time": { + "start": 1720017736.90778, + "finish": 1720017736.97555, + "duration": 0.0677700042724609, + "processing": 0.0367820262908936, + "date_start": "2024-07-03T14:42:16+00:00", + "date_finish": "2024-07-03T14:42:16+00:00", + "operating_reset_at": 1720018336, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md index 1693abcf83..4fc10807a5 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -1,128 +1,128 @@ ---- -sidebar_position: 20 ---- - -# Проверить доступ к задаче - Проверяет доступность задачи для пользователей - - - -`Функция ПроверитьДоступКЗадаче(Знач URL, Знач IDЗадачи, Знач Пользователи = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Пользователи | --users | Массив из Строка | ID пользователей для проверки доступа | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) -::: -
- - -```bsl title="Пример кода" - МассивПользователей = Новый Массив; - МассивПользователей.Добавить("1"); - МассивПользователей.Добавить("10"); - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - - Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПроверитьДоступКЗадаче --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "allowedActions": { - "1": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": true, - "EDIT": true, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": true, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": true, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": true, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": true, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - }, - "10": { - "ACCEPT": false, - "DECLINE": false, - "COMPLETE": true, - "APPROVE": false, - "DISAPPROVE": false, - "START": true, - "PAUSE": false, - "DELEGATE": true, - "REMOVE": false, - "EDIT": false, - "DEFER": true, - "RENEW": false, - "CREATE": true, - "CHANGE_DEADLINE": false, - "CHECKLIST_ADD_ITEMS": true, - "ADD_FAVORITE": true, - "DELETE_FAVORITE": false, - "RATE": false, - "EDIT.ORIGINATOR": false, - "CHECKLIST.REORDER": false, - "ELAPSEDTIME.ADD": true, - "DAYPLAN.TIMER.TOGGLE": false, - "EDIT.PLAN": false, - "CHECKLIST.ADD": true, - "FAVORITE.ADD": true, - "FAVORITE.DELETE": false - } - } - }, - "time": { - "start": 1720017732.79312, - "finish": 1720017732.85673, - "duration": 0.0636129379272461, - "processing": 0.0308799743652344, - "date_start": "2024-07-03T14:42:12+00:00", - "date_finish": "2024-07-03T14:42:12+00:00", - "operating_reset_at": 1720018332, - "operating": 0 - } -} -``` +--- +sidebar_position: 20 +--- + +# Проверить доступ к задаче + Проверяет доступность задачи для пользователей + + + +`Функция ПроверитьДоступКЗадаче(Знач URL, Знач IDЗадачи, Знач Пользователи = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Пользователи | --users | Массив из Строка | ID пользователей для проверки доступа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
+ + +```bsl title="Пример кода" + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("1"); + МассивПользователей.Добавить("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПроверитьДоступКЗадаче --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "allowedActions": { + "1": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": true, + "EDIT": true, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": true, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": true, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": true, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": true, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + }, + "10": { + "ACCEPT": false, + "DECLINE": false, + "COMPLETE": true, + "APPROVE": false, + "DISAPPROVE": false, + "START": true, + "PAUSE": false, + "DELEGATE": true, + "REMOVE": false, + "EDIT": false, + "DEFER": true, + "RENEW": false, + "CREATE": true, + "CHANGE_DEADLINE": false, + "CHECKLIST_ADD_ITEMS": true, + "ADD_FAVORITE": true, + "DELETE_FAVORITE": false, + "RATE": false, + "EDIT.ORIGINATOR": false, + "CHECKLIST.REORDER": false, + "ELAPSEDTIME.ADD": true, + "DAYPLAN.TIMER.TOGGLE": false, + "EDIT.PLAN": false, + "CHECKLIST.ADD": true, + "FAVORITE.ADD": true, + "FAVORITE.DELETE": false + } + } + }, + "time": { + "start": 1720017732.79312, + "finish": 1720017732.85673, + "duration": 0.0636129379272461, + "processing": 0.0308799743652344, + "date_start": "2024-07-03T14:42:12+00:00", + "date_finish": "2024-07-03T14:42:12+00:00", + "operating_reset_at": 1720018332, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md index 6777cff825..7e2ee6e641 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -1,72 +1,72 @@ ---- -sidebar_position: 23 ---- - -# Создать зависимость задач - Создает зависимость одной задачи от другой - - - -`Функция СоздатьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | - | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | - | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) -::: -
- - -```bsl title="Пример кода" - IDИсточника = "1078"; - IDПриемника = "1080"; - ТипСвязи = 0; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); - - IDИсточника = "1080"; - IDПриемника = "1078"; - ТипСвязи = 2; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьЗависимостьЗадач --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1720186655.56394, - "finish": 1720186656.29235, - "duration": 0.728404998779297, - "processing": 0.692660093307495, - "date_start": "2024-07-05T13:37:35+00:00", - "date_finish": "2024-07-05T13:37:36+00:00", - "operating_reset_at": 1720187255, - "operating": 0.692637920379639 - } -} -``` +--- +sidebar_position: 23 +--- + +# Создать зависимость задач + Создает зависимость одной задачи от другой + + + +`Функция СоздатьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | + | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | + | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
+ + +```bsl title="Пример кода" + IDИсточника = "1078"; + IDПриемника = "1080"; + ТипСвязи = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); + + IDИсточника = "1080"; + IDПриемника = "1078"; + ТипСвязи = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьЗависимостьЗадач --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1720186655.56394, + "finish": 1720186656.29235, + "duration": 0.728404998779297, + "processing": 0.692660093307495, + "date_start": "2024-07-05T13:37:35+00:00", + "date_finish": "2024-07-05T13:37:36+00:00", + "operating_reset_at": 1720187255, + "operating": 0.692637920379639 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md index 6bd2a2e50b..b0e681e5d5 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -1,54 +1,54 @@ ---- -sidebar_position: 24 ---- - -# Удалить зависимость задач - Удаляет зависимость одной задачи от другой - - - -`Функция УдалитьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | - | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | - | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) -::: -
- - - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьЗависимостьЗадач --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% - -``` - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1720816479.3837, - "finish": 1720816479.41872, - "duration": 0.0350160598754883, - "processing": 0.00787091255187988, - "date_start": "2024-07-12T20:34:39+00:00", - "date_finish": "2024-07-12T20:34:39+00:00", - "operating_reset_at": 1720817079, - "operating": 0 - } -} -``` +--- +sidebar_position: 24 +--- + +# Удалить зависимость задач + Удаляет зависимость одной задачи от другой + + + +`Функция УдалитьЗависимостьЗадач(Знач URL, Знач IDИсточника, Знач IDПриемника, Знач ТипСвязи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDИсточника | --taskfrom | Строка, Число | ID задачи источника связи | + | IDПриемника | --taskto | Строка, Число | ID задачи приемника связи | + | ТипСвязи | --linktype | Строка, Число | Тип связи: 0 старт>старт, 1 старт>финиш, 2 финиш>старт, 3 финиш>финиш | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьЗависимостьЗадач --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% + +``` + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1720816479.3837, + "finish": 1720816479.41872, + "duration": 0.0350160598754883, + "processing": 0.00787091255187988, + "date_start": "2024-07-12T20:34:39+00:00", + "date_finish": "2024-07-12T20:34:39+00:00", + "operating_reset_at": 1720817079, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md index 672f9dbf5b..a2f4178d1a 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md @@ -1,61 +1,61 @@ ---- -sidebar_position: 25 ---- - -# Получить план задач на день - Получает план задач на день текущего пользователя - - - -`Функция ПолучитьПланЗадачНаДень(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьПланЗадачНаДень --url %url% --token %token% - -``` - -```json title="Результат" -{ - "result": [], - "time": { - "start": 1720816513.42336, - "finish": 1720816513.45192, - "duration": 0.0285580158233643, - "processing": 0.000265121459960938, - "date_start": "2024-07-12T20:35:13+00:00", - "date_finish": "2024-07-12T20:35:13+00:00", - "operating_reset_at": 1720817113, - "operating": 0 - } -} -``` +--- +sidebar_position: 25 +--- + +# Получить план задач на день + Получает план задач на день текущего пользователя + + + +`Функция ПолучитьПланЗадачНаДень(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПланЗадачНаДень --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1720816513.42336, + "finish": 1720816513.45192, + "duration": 0.0285580158233643, + "processing": 0.000265121459960938, + "date_start": "2024-07-12T20:35:13+00:00", + "date_finish": "2024-07-12T20:35:13+00:00", + "operating_reset_at": 1720817113, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md index df6d265c23..c20f02e378 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md @@ -1,194 +1,194 @@ ---- -sidebar_position: 21 ---- - -# Отключить звук задачи - Устанавливает режим Без звука для задачи - - - -`Функция ОтключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - - Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ОтключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "task": { - "id": "290", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T14:41:38+00:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-07-03T14:41:45+00:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-07-03T14:41:38+00:00", - "dateStart": null, - "deadline": "2024-07-04T14:41:00+00:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "2", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "Y", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T14:41:45+00:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1720017708.44201, - "finish": 1720017708.51044, - "duration": 0.0684309005737305, - "processing": 0.0346000194549561, - "date_start": "2024-07-03T14:41:48+00:00", - "date_finish": "2024-07-03T14:41:48+00:00", - "operating_reset_at": 1720018308, - "operating": 0 - } -} -``` +--- +sidebar_position: 21 +--- + +# Отключить звук задачи + Устанавливает режим Без звука для задачи + + + +`Функция ОтключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "task": { + "id": "290", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T14:41:38+00:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-07-03T14:41:45+00:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-07-03T14:41:38+00:00", + "dateStart": null, + "deadline": "2024-07-04T14:41:00+00:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "2", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "Y", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T14:41:45+00:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1720017708.44201, + "finish": 1720017708.51044, + "duration": 0.0684309005737305, + "processing": 0.0346000194549561, + "date_start": "2024-07-03T14:41:48+00:00", + "date_finish": "2024-07-03T14:41:48+00:00", + "operating_reset_at": 1720018308, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md index 944edff4da..b5bfba94ea 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -1,194 +1,194 @@ ---- -sidebar_position: 22 ---- - -# Включить звук задачи - Отключает режим Без звука для задачи - - - -`Функция ВключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1078"; - - Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗадачи = "1080"; - - Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ВключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "task": { - "id": "290", - "parentId": null, - "title": "Другой заголовок задачи", - "description": "Другое описание задачи", - "mark": null, - "priority": "1", - "multitask": "N", - "notViewed": "N", - "replicate": "N", - "stageId": "0", - "createdBy": "1", - "createdDate": "2024-07-03T14:41:38+00:00", - "responsibleId": "1", - "changedBy": "1", - "changedDate": "2024-07-03T14:41:45+00:00", - "statusChangedBy": null, - "closedBy": null, - "closedDate": null, - "activityDate": "2024-07-03T14:41:38+00:00", - "dateStart": null, - "deadline": "2024-07-04T14:41:00+00:00", - "startDatePlan": null, - "endDatePlan": null, - "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", - "xmlId": null, - "commentsCount": null, - "serviceCommentsCount": null, - "allowChangeDeadline": "N", - "allowTimeTracking": "N", - "taskControl": "N", - "addInReport": "N", - "forkedByTemplateId": null, - "timeEstimate": "0", - "timeSpentInLogs": null, - "matchWorkTime": "N", - "forumTopicId": null, - "forumId": null, - "siteId": "s1", - "subordinate": "N", - "exchangeModified": null, - "exchangeId": null, - "outlookVersion": "2", - "viewedDate": null, - "sorting": null, - "durationFact": null, - "isMuted": "N", - "isPinned": "N", - "isPinnedInGroup": "N", - "flowId": null, - "descriptionInBbcode": "Y", - "status": "2", - "statusChangedDate": "2024-07-03T14:41:45+00:00", - "durationPlan": null, - "durationType": "days", - "favorite": "N", - "groupId": "0", - "auditors": [], - "accomplices": [], - "checklist": [], - "group": [], - "creator": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "responsible": { - "id": "1", - "name": "Антон Титовец", - "link": "/company/personal/user/1/", - "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "workPosition": null - }, - "accomplicesData": [], - "auditorsData": [], - "newCommentsCount": 0, - "action": { - "accept": false, - "decline": false, - "complete": true, - "approve": false, - "disapprove": false, - "start": true, - "pause": false, - "delegate": true, - "remove": true, - "edit": true, - "defer": true, - "renew": false, - "create": true, - "changeDeadline": true, - "checklistAddItems": true, - "addFavorite": true, - "deleteFavorite": false, - "rate": true, - "edit.originator": false, - "checklist.reorder": true, - "elapsedtime.add": true, - "dayplan.timer.toggle": false, - "edit.plan": true, - "checklist.add": true, - "favorite.add": true, - "favorite.delete": false - }, - "checkListTree": { - "nodeId": 0, - "fields": { - "id": null, - "copiedId": null, - "entityId": null, - "userId": 1, - "createdBy": null, - "parentId": null, - "title": "", - "sortIndex": null, - "displaySortIndex": "", - "isComplete": false, - "isImportant": false, - "completedCount": 0, - "members": [], - "attachments": [] - }, - "action": [], - "descendants": [] - }, - "checkListCanAdd": true - } - }, - "time": { - "start": 1720017709.85465, - "finish": 1720017709.91481, - "duration": 0.0601639747619629, - "processing": 0.0304751396179199, - "date_start": "2024-07-03T14:41:49+00:00", - "date_finish": "2024-07-03T14:41:49+00:00", - "operating_reset_at": 1720018309, - "operating": 0 - } -} -``` +--- +sidebar_position: 22 +--- + +# Включить звук задачи + Отключает режим Без звука для задачи + + + +`Функция ВключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1078"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗадачи = "1080"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "task": { + "id": "290", + "parentId": null, + "title": "Другой заголовок задачи", + "description": "Другое описание задачи", + "mark": null, + "priority": "1", + "multitask": "N", + "notViewed": "N", + "replicate": "N", + "stageId": "0", + "createdBy": "1", + "createdDate": "2024-07-03T14:41:38+00:00", + "responsibleId": "1", + "changedBy": "1", + "changedDate": "2024-07-03T14:41:45+00:00", + "statusChangedBy": null, + "closedBy": null, + "closedDate": null, + "activityDate": "2024-07-03T14:41:38+00:00", + "dateStart": null, + "deadline": "2024-07-04T14:41:00+00:00", + "startDatePlan": null, + "endDatePlan": null, + "guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}", + "xmlId": null, + "commentsCount": null, + "serviceCommentsCount": null, + "allowChangeDeadline": "N", + "allowTimeTracking": "N", + "taskControl": "N", + "addInReport": "N", + "forkedByTemplateId": null, + "timeEstimate": "0", + "timeSpentInLogs": null, + "matchWorkTime": "N", + "forumTopicId": null, + "forumId": null, + "siteId": "s1", + "subordinate": "N", + "exchangeModified": null, + "exchangeId": null, + "outlookVersion": "2", + "viewedDate": null, + "sorting": null, + "durationFact": null, + "isMuted": "N", + "isPinned": "N", + "isPinnedInGroup": "N", + "flowId": null, + "descriptionInBbcode": "Y", + "status": "2", + "statusChangedDate": "2024-07-03T14:41:45+00:00", + "durationPlan": null, + "durationType": "days", + "favorite": "N", + "groupId": "0", + "auditors": [], + "accomplices": [], + "checklist": [], + "group": [], + "creator": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "responsible": { + "id": "1", + "name": "Антон Титовец", + "link": "/company/personal/user/1/", + "icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "workPosition": null + }, + "accomplicesData": [], + "auditorsData": [], + "newCommentsCount": 0, + "action": { + "accept": false, + "decline": false, + "complete": true, + "approve": false, + "disapprove": false, + "start": true, + "pause": false, + "delegate": true, + "remove": true, + "edit": true, + "defer": true, + "renew": false, + "create": true, + "changeDeadline": true, + "checklistAddItems": true, + "addFavorite": true, + "deleteFavorite": false, + "rate": true, + "edit.originator": false, + "checklist.reorder": true, + "elapsedtime.add": true, + "dayplan.timer.toggle": false, + "edit.plan": true, + "checklist.add": true, + "favorite.add": true, + "favorite.delete": false + }, + "checkListTree": { + "nodeId": 0, + "fields": { + "id": null, + "copiedId": null, + "entityId": null, + "userId": 1, + "createdBy": null, + "parentId": null, + "title": "", + "sortIndex": null, + "displaySortIndex": "", + "isComplete": false, + "isImportant": false, + "completedCount": 0, + "members": [], + "attachments": [] + }, + "action": [], + "descendants": [] + }, + "checkListCanAdd": true + } + }, + "time": { + "start": 1720017709.85465, + "finish": 1720017709.91481, + "duration": 0.0601639747619629, + "processing": 0.0304751396179199, + "date_start": "2024-07-03T14:41:49+00:00", + "date_finish": "2024-07-03T14:41:49+00:00", + "operating_reset_at": 1720018309, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md index 566002e2d7..5d9997396a 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 1 ---- - -# Добавить трудозатраты задачи - Добавляет информацию о затраченном времени пользователя в задачу - - - -`Функция ДобавитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач Время, Знач IDПользователя = "", Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | - | Время | --amount | Строка, Число | Затраченное время в секундах | - | IDПользователя | --user | Строка, Число | ID пользователя, затратившего время | - | Текст | --text | Строка | Текст комментария трудозатраты | - | ДатаУстановки | --date | Строка | Дата установки трудозатрат | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1088"; - - Время = 3600; - - Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Текст = "Трудозатраты по обработке"; - IDПользователя = 10; - Время = 7200; - ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); - - Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL - , IDЗадачи - , Время - , IDПользователя - , Текст - , ДатаУстановки - , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьТрудозатратыЗадачи --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% - -``` - -```json title="Результат" -{ - "result": 42, - "time": { - "start": 1720816582.16849, - "finish": 1720816582.22964, - "duration": 0.0611569881439209, - "processing": 0.0315871238708496, - "date_start": "2024-07-12T20:36:22+00:00", - "date_finish": "2024-07-12T20:36:22+00:00", - "operating_reset_at": 1720817182, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Добавить трудозатраты задачи + Добавляет информацию о затраченном времени пользователя в задачу + + + +`Функция ДобавитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач Время, Знач IDПользователя = "", Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | IDПользователя | --user | Строка, Число | ID пользователя, затратившего время | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1088"; + + Время = 3600; + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Текст = "Трудозатраты по обработке"; + IDПользователя = 10; + Время = 7200; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL + , IDЗадачи + , Время + , IDПользователя + , Текст + , ДатаУстановки + , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьТрудозатратыЗадачи --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% + +``` + +```json title="Результат" +{ + "result": 42, + "time": { + "start": 1720816582.16849, + "finish": 1720816582.22964, + "duration": 0.0611569881439209, + "processing": 0.0315871238708496, + "date_start": "2024-07-12T20:36:22+00:00", + "date_finish": "2024-07-12T20:36:22+00:00", + "operating_reset_at": 1720817182, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md index b2e96ca645..bacac8157b 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md @@ -1,66 +1,66 @@ ---- -sidebar_position: 2 ---- - -# Удалить трудозатраты задачи - Удаляет запись о трудозатратах из задачи - - - -`Функция УдалитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1088"; - IDЗаписи = "306"; - - Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗаписи = "308"; - - Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% - -``` - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1720816586.91135, - "finish": 1720816586.96255, - "duration": 0.0512039661407471, - "processing": 0.0238111019134522, - "date_start": "2024-07-12T20:36:26+00:00", - "date_finish": "2024-07-12T20:36:26+00:00", - "operating_reset_at": 1720817186, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Удалить трудозатраты задачи + Удаляет запись о трудозатратах из задачи + + + +`Функция УдалитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1088"; + IDЗаписи = "306"; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗаписи = "308"; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816586.91135, + "finish": 1720816586.96255, + "duration": 0.0512039661407471, + "processing": 0.0238111019134522, + "date_start": "2024-07-12T20:36:26+00:00", + "date_finish": "2024-07-12T20:36:26+00:00", + "operating_reset_at": 1720817186, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md index a9fdf743ed..dc9fdaaa17 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md @@ -1,89 +1,89 @@ ---- -sidebar_position: 3 ---- - -# Получить список трудозатрат задачи - Получает список записей о трудозатратах задачи - - - -`Функция ПолучитьСписокТрудозатратЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1088"; - - Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокТрудозатратЗадачи --url %url% --task %task% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "40", - "TASK_ID": "638", - "USER_ID": "1", - "COMMENT_TEXT": "", - "SECONDS": "3600", - "MINUTES": "60", - "SOURCE": "2", - "CREATED_DATE": "2024-07-12T20:36:21+00:00", - "DATE_START": "2024-07-12T20:36:21+00:00", - "DATE_STOP": "2024-07-12T20:36:21+00:00" - }, - { - "ID": "42", - "TASK_ID": "638", - "USER_ID": "10", - "COMMENT_TEXT": "Трудозатраты по обработке", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-06-12T17:36:21+00:00", - "DATE_START": "2024-07-12T20:36:22+00:00", - "DATE_STOP": "2024-07-12T20:36:22+00:00" - } - ], - "total": 2, - "time": { - "start": 1720816584.48831, - "finish": 1720816584.5364, - "duration": 0.0480880737304688, - "processing": 0.0219790935516357, - "date_start": "2024-07-12T20:36:24+00:00", - "date_finish": "2024-07-12T20:36:24+00:00", - "operating_reset_at": 1720817184, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Получить список трудозатрат задачи + Получает список записей о трудозатратах задачи + + + +`Функция ПолучитьСписокТрудозатратЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1088"; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокТрудозатратЗадачи --url %url% --task %task% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "40", + "TASK_ID": "638", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-07-12T20:36:21+00:00", + "DATE_START": "2024-07-12T20:36:21+00:00", + "DATE_STOP": "2024-07-12T20:36:21+00:00" + }, + { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + } + ], + "total": 2, + "time": { + "start": 1720816584.48831, + "finish": 1720816584.5364, + "duration": 0.0480880737304688, + "processing": 0.0219790935516357, + "date_start": "2024-07-12T20:36:24+00:00", + "date_finish": "2024-07-12T20:36:24+00:00", + "operating_reset_at": 1720817184, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md index c471ce6e9b..f31d423800 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md @@ -1,77 +1,77 @@ ---- -sidebar_position: 4 ---- - -# Получить трудозатраты задачи - Получает информацию о записи трудозатрат задачи по ID - - - -`Функция ПолучитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1088"; - IDЗаписи = "306"; - - Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗаписи = "308"; - - Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": "42", - "TASK_ID": "638", - "USER_ID": "10", - "COMMENT_TEXT": "Трудозатраты по обработке", - "SECONDS": "7200", - "MINUTES": "120", - "SOURCE": "2", - "CREATED_DATE": "2024-06-12T17:36:21+00:00", - "DATE_START": "2024-07-12T20:36:22+00:00", - "DATE_STOP": "2024-07-12T20:36:22+00:00" - }, - "time": { - "start": 1720816583.31997, - "finish": 1720816583.36716, - "duration": 0.0471861362457275, - "processing": 0.0187540054321289, - "date_start": "2024-07-12T20:36:23+00:00", - "date_finish": "2024-07-12T20:36:23+00:00", - "operating_reset_at": 1720817183, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Получить трудозатраты задачи + Получает информацию о записи трудозатрат задачи по ID + + + +`Функция ПолучитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1088"; + IDЗаписи = "306"; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗаписи = "308"; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + }, + "time": { + "start": 1720816583.31997, + "finish": 1720816583.36716, + "duration": 0.0471861362457275, + "processing": 0.0187540054321289, + "date_start": "2024-07-12T20:36:23+00:00", + "date_finish": "2024-07-12T20:36:23+00:00", + "operating_reset_at": 1720817183, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md index 382bd4ca70..2a9e20ce53 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-settings.md @@ -1,73 +1,73 @@ ---- -sidebar_position: 10 ---- - -# Получить настройки учета времени - Получает настройки учета времени пользователя - - - -`Функция ПолучитьНастройкиУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); - - Час = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьНастройкиУчетаВремени --url %url% --userid %userid% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "UF_TIMEMAN": true, - "UF_TM_FREE": false, - "UF_TM_MAX_START": "09:15:00", - "UF_TM_MIN_FINISH": "17:45:00", - "UF_TM_MIN_DURATION": "08:00:00", - "UF_TM_ALLOWED_DELTA": "00:15:00", - "ADMIN": true - }, - "time": { - "start": 1722332243.86487, - "finish": 1722332243.88732, - "duration": 0.0224521160125732, - "processing": 0.00417494773864746, - "date_start": "2024-07-30T09:37:23+00:00", - "date_finish": "2024-07-30T09:37:23+00:00", - "operating_reset_at": 1722332843, - "operating": 0 - } -} -``` +--- +sidebar_position: 10 +--- + +# Получить настройки учета времени + Получает настройки учета времени пользователя + + + +`Функция ПолучитьНастройкиУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.settings](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_settings.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL); + + Час = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьНастройкиУчетаВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьНастройкиУчетаВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "UF_TIMEMAN": true, + "UF_TM_FREE": false, + "UF_TM_MAX_START": "09:15:00", + "UF_TM_MIN_FINISH": "17:45:00", + "UF_TM_MIN_DURATION": "08:00:00", + "UF_TM_ALLOWED_DELTA": "00:15:00", + "ADMIN": true + }, + "time": { + "start": 1722332243.86487, + "finish": 1722332243.88732, + "duration": 0.0224521160125732, + "processing": 0.00417494773864746, + "date_start": "2024-07-30T09:37:23+00:00", + "date_finish": "2024-07-30T09:37:23+00:00", + "operating_reset_at": 1722332843, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md index 886aad993a..d5feccada4 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-timekeeping-status.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 9 ---- - -# Получить статус учета времени - Получает статус учета времени пользователя - - - -`Функция ПолучитьСтатусУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); - - Час = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтатусУчетаВремени --url %url% --userid %userid% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328322.65261, - "finish": 1722328322.6837, - "duration": 0.0310959815979004, - "processing": 0.00899505615234375, - "date_start": "2024-07-30T08:32:02+00:00", - "date_finish": "2024-07-30T08:32:02+00:00", - "operating_reset_at": 1722328922, - "operating": 0 - } -} -``` +--- +sidebar_position: 9 +--- + +# Получить статус учета времени + Получает статус учета времени пользователя + + + +`Функция ПолучитьСтатусУчетаВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.status](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_status.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL); + + Час = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПолучитьСтатусУчетаВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтатусУчетаВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328322.65261, + "finish": 1722328322.6837, + "duration": 0.0310959815979004, + "processing": 0.00899505615234375, + "date_start": "2024-07-30T08:32:02+00:00", + "date_finish": "2024-07-30T08:32:02+00:00", + "operating_reset_at": 1722328922, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md index 705a4b1397..28baaccc8a 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Pause-timekeeping.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 8 ---- - -# Приостановить учет времени - Приостанавливает учет времени пользователя - - - -`Функция ПриостановитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); - - Час = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 1; - - Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПриостановитьУчетВремени --url %url% --userid %userid% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "STATUS": "PAUSED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": "2024-07-30T08:32:00+00:00", - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328320.91942, - "finish": 1722328320.98461, - "duration": 0.0651938915252686, - "processing": 0.0352118015289307, - "date_start": "2024-07-30T08:32:00+00:00", - "date_finish": "2024-07-30T08:32:00+00:00", - "operating_reset_at": 1722328920, - "operating": 0 - } -} -``` +--- +sidebar_position: 8 +--- + +# Приостановить учет времени + Приостанавливает учет времени пользователя + + + +`Функция ПриостановитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.pause](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_pause.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL); + + Час = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 1; + + Результат = OPI_Bitrix24.ПриостановитьУчетВремени(URL, IDПользователя); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПриостановитьУчетВремени --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "STATUS": "PAUSED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": "2024-07-30T08:32:00+00:00", + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328320.91942, + "finish": 1722328320.98461, + "duration": 0.0651938915252686, + "processing": 0.0352118015289307, + "date_start": "2024-07-30T08:32:00+00:00", + "date_finish": "2024-07-30T08:32:00+00:00", + "operating_reset_at": 1722328920, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md index ac5f096282..79442ff475 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Start-timekeeping.md @@ -1,83 +1,83 @@ ---- -sidebar_position: 6 ---- - -# Начать учет времени - Начинает учет времени пользователя - - - -`Функция НачатьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Время | --time | Дата | Время начала учета. Дата должна совпадать с текущей. Текущее время по ум. | - | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.НачатьУчетВремени(URL); - - Час = 3600; - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 1; - Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; - Отчет = "Опоздание"; - - Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, ); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 НачатьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "STATUS": "OPENED", - "TIME_START": "2024-07-30T07:10:51+00:00", - "TIME_FINISH": null, - "DURATION": "00:00:00", - "TIME_LEAKS": "00:09:59", - "ACTIVE": false, - "IP_OPEN": "", - "IP_CLOSE": "93.125.42.204", - "LAT_OPEN": 0, - "LON_OPEN": 0, - "LAT_CLOSE": 0, - "LON_CLOSE": 0, - "TZ_OFFSET": 10800 - }, - "time": { - "start": 1722328319.21856, - "finish": 1722328319.25781, - "duration": 0.0392520427703857, - "processing": 0.014214038848877, - "date_start": "2024-07-30T08:31:59+00:00", - "date_finish": "2024-07-30T08:31:59+00:00", - "operating_reset_at": 1722328919, - "operating": 0.181692123413086 - } -} -``` +--- +sidebar_position: 6 +--- + +# Начать учет времени + Начинает учет времени пользователя + + + +`Функция НачатьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время начала учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.open](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_open.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL); + + Час = 3600; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату() - Час; + Отчет = "Опоздание"; + + Результат = OPI_Bitrix24.НачатьУчетВремени(URL, IDПользователя, Время, Отчет, ); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 НачатьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "STATUS": "OPENED", + "TIME_START": "2024-07-30T07:10:51+00:00", + "TIME_FINISH": null, + "DURATION": "00:00:00", + "TIME_LEAKS": "00:09:59", + "ACTIVE": false, + "IP_OPEN": "", + "IP_CLOSE": "93.125.42.204", + "LAT_OPEN": 0, + "LON_OPEN": 0, + "LAT_CLOSE": 0, + "LON_CLOSE": 0, + "TZ_OFFSET": 10800 + }, + "time": { + "start": 1722328319.21856, + "finish": 1722328319.25781, + "duration": 0.0392520427703857, + "processing": 0.014214038848877, + "date_start": "2024-07-30T08:31:59+00:00", + "date_finish": "2024-07-30T08:31:59+00:00", + "operating_reset_at": 1722328919, + "operating": 0.181692123413086 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md index 93546e54f4..e5da92d2db 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Stop-timekeeping.md @@ -1,58 +1,58 @@ ---- -sidebar_position: 7 ---- - -# Завершить учет времени - Завершает учет времени пользователя - - - -`Функция ЗавершитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | - | Время | --time | Дата | Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум. | - | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = 1; - Время = OPI_Инструменты.ПолучитьТекущуюДату(); - Отчет = "Отгул"; - - Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, ); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ЗавершитьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% - -``` - -```json title="Результат" -{ - "error": "WRONG_DATETIME_FORMAT", - "error_description": "Wrong datetime format" -} -``` +--- +sidebar_position: 7 +--- + +# Завершить учет времени + Завершает учет времени пользователя + + + +`Функция ЗавершитьУчетВремени(Знач URL, Знач IDПользователя = "", Знач Время = "", Знач Отчет = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для учета. Текущий по умолчанию | + | Время | --time | Дата | Время заверш. учета. Дата должна совпадать с текущей. Текущее время по ум. | + | Отчет | --report | Строка | Причина изменения. Обязателен при указании Время и отключенном свободном графике | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [timeman.close](https://dev.1c-bitrix.ru/rest_help/timeman/base/timeman_close.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = 1; + Время = OPI_Инструменты.ПолучитьТекущуюДату(); + Отчет = "Отгул"; + + Результат = OPI_Bitrix24.ЗавершитьУчетВремени(URL, IDПользователя, Время, Отчет, ); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ЗавершитьУчетВремени --url %url% --userid %userid% --time %time% --report %report% --token %token% + +``` + +```json title="Результат" +{ + "error": "WRONG_DATETIME_FORMAT", + "error_description": "Wrong datetime format" +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md index 238e9d24fc..91e65a5597 100644 --- a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md +++ b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 5 ---- - -# Изменить трудозатраты задачи - Изменяет данные записи о трудозатратах задачи - - - -`Функция ИзменитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Время, Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Строка, Число | ID задачи | - | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | - | Время | --amount | Строка, Число | Затраченное время в секундах | - | Текст | --text | Строка | Текст комментария трудозатраты | - | ДатаУстановки | --date | Строка | Дата установки трудозатрат | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDЗадачи = "1088"; - IDЗаписи = "306"; - - Текст = "Забытый в прошлый раз текст"; - Время = 4800; - - Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDЗаписи = "308"; - - Текст = "Новые трудозатраты по обработке"; - Время = 4800; - ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); - - Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL - , IDЗадачи - , IDЗаписи - , Время - , Текст - , ДатаУстановки - , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% - -``` - -```json title="Результат" -{ - "result": null, - "time": { - "start": 1720816585.70407, - "finish": 1720816585.77088, - "duration": 0.0668020248413086, - "processing": 0.0276288986206055, - "date_start": "2024-07-12T20:36:25+00:00", - "date_finish": "2024-07-12T20:36:25+00:00", - "operating_reset_at": 1720817185, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Изменить трудозатраты задачи + Изменяет данные записи о трудозатратах задачи + + + +`Функция ИзменитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Время, Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDЗадачи = "1088"; + IDЗаписи = "306"; + + Текст = "Забытый в прошлый раз текст"; + Время = 4800; + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDЗаписи = "308"; + + Текст = "Новые трудозатраты по обработке"; + Время = 4800; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL + , IDЗадачи + , IDЗаписи + , Время + , Текст + , ДатаУстановки + , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816585.70407, + "finish": 1720816585.77088, + "duration": 0.0668020248413086, + "processing": 0.0276288986206055, + "date_start": "2024-07-12T20:36:25+00:00", + "date_finish": "2024-07-12T20:36:25+00:00", + "operating_reset_at": 1720817185, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md index 0f0210d253..9784b7088f 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md +++ b/docs/ru/md/Bitrix24/Users-managment/Change-user-status.md @@ -1,62 +1,62 @@ ---- -sidebar_position: 5 ---- - -# Изменить статус пользователя - Активирует или деактивирует (увольняет) выбранного пользователя - - - -`Функция ИзменитьСтатусПользователя(Знач URL, Знач IDПользователя, Знач Уволить = Истина, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | - | Уволить | --fire | Булево | Истина > Деактивация, Ложь > Активация | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПользователя = "78"; - - Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = "80"; - - Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьСтатусПользователя --url %url% --userid %userid% --fire %fire% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722328399.68494, - "finish": 1722328399.94913, - "duration": 0.264194965362549, - "processing": 0.229634046554565, - "date_start": "2024-07-30T08:33:19+00:00", - "date_finish": "2024-07-30T08:33:19+00:00", - "operating_reset_at": 1722328999, - "operating": 0.5396409034729 - } -} -``` +--- +sidebar_position: 5 +--- + +# Изменить статус пользователя + Активирует или деактивирует (увольняет) выбранного пользователя + + + +`Функция ИзменитьСтатусПользователя(Знач URL, Знач IDПользователя, Знач Уволить = Истина, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | Уволить | --fire | Булево | Истина > Деактивация, Ложь > Активация | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ + + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПользователя = "78"; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = "80"; + + Результат = OPI_Bitrix24.ИзменитьСтатусПользователя(URL, IDПользователя, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьСтатусПользователя --url %url% --userid %userid% --fire %fire% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722328399.68494, + "finish": 1722328399.94913, + "duration": 0.264194965362549, + "processing": 0.229634046554565, + "date_start": "2024-07-30T08:33:19+00:00", + "date_finish": "2024-07-30T08:33:19+00:00", + "operating_reset_at": 1722328999, + "operating": 0.5396409034729 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Create-user.md b/docs/ru/md/Bitrix24/Users-managment/Create-user.md index 6ad417fe25..c9cbd78071 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Create-user.md +++ b/docs/ru/md/Bitrix24/Users-managment/Create-user.md @@ -1,80 +1,80 @@ ---- -sidebar_position: 3 ---- - -# Создать пользователя - Создает нового пользователя по структуре полей - - - -`Функция СоздатьПользователя(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) - - Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...] - - Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT: [...] -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); - - Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("NAME" , "Виталий"); - СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); - СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); - СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); - - Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьПользователя --url %url% --fields %fields% --token %token% - -``` - -```json title="Результат" -{ - "result": 60, - "time": { - "start": 1722328388.80414, - "finish": 1722328391.95472, - "duration": 3.15058398246765, - "processing": 3.02733707427978, - "date_start": "2024-07-30T08:33:08+00:00", - "date_finish": "2024-07-30T08:33:11+00:00", - "operating_reset_at": 1722328988, - "operating": 3.0273129940033 - } -} -``` +--- +sidebar_position: 3 +--- + +# Создать пользователя + Создает нового пользователя по структуре полей + + + +`Функция СоздатьПользователя(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.add](https://dev.1c-bitrix.ru/rest_help/users/user_add.php) + + Если нужно добавить пользователя экстранета, то в полях необходимо передать: EXTRANET: Y и SONET_GROUP_ID: [...] + + Если нужно добавить пользователя интранета, то обязательно передаётся: UF_DEPARTMENT: [...] +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 7); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Виталий"); + СтруктураПользователя.Вставить("LAST_NAME" , "Альпака"); + СтруктураПользователя.Вставить("PERSONAL_MOBILE", "88003553535"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 1); + + Результат = OPI_Bitrix24.СоздатьПользователя(URL, СтруктураПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьПользователя --url %url% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "result": 60, + "time": { + "start": 1722328388.80414, + "finish": 1722328391.95472, + "duration": 3.15058398246765, + "processing": 3.02733707427978, + "date_start": "2024-07-30T08:33:08+00:00", + "date_finish": "2024-07-30T08:33:11+00:00", + "operating_reset_at": 1722328988, + "operating": 3.0273129940033 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Find-users.md b/docs/ru/md/Bitrix24/Users-managment/Find-users.md index 9f5eba212c..4043433477 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Find-users.md +++ b/docs/ru/md/Bitrix24/Users-managment/Find-users.md @@ -1,277 +1,277 @@ ---- -sidebar_position: 6 ---- - -# Найти пользователей - Получает список пользователей по заданному фильтру - - - -`Функция НайтиПользователей(Знач URL, Знач СтруктураФильтра, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураФильтра | --filter | Структура Из КлючИЗначение | Фильтр. См. ПолучитьСтруктуруФильтраПользователей | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - СтруктураФильтра = Новый Структура; - СтруктураФильтра.Вставить("NAME" , "Виталий"); - СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); - СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); - СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); - СтруктураФильтра.Вставить("USER_TYPE" , "employee"); - - Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - СтруктураФильтра = Новый Структура; - СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); - - Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 НайтиПользователей --url %url% --filter %filter% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "12", - "XML_ID": "56479740", - "ACTIVE": true, - "NAME": "Bay", - "LAST_NAME": "Selonarrend", - "EMAIL": "oarismos@gmail.com", - "LAST_LOGIN": "2024-07-13T07:17:17+00:00", - "DATE_REGISTER": "2024-07-13T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "18", - "XML_ID": "56701916", - "ACTIVE": true, - "EMAIL": "hey@exepmple.com", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "34", - "XML_ID": "56702240", - "ACTIVE": false, - "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "38", - "XML_ID": "56702244", - "ACTIVE": false, - "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "42", - "XML_ID": "56702314", - "ACTIVE": true, - "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "46", - "XML_ID": "56702336", - "ACTIVE": false, - "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "50", - "XML_ID": "56702654", - "ACTIVE": false, - "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-28T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "54", - "XML_ID": "56721830", - "ACTIVE": false, - "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-29T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - }, - { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Антон", - "LAST_NAME": "Титовец", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-07-30T06:49:41+00:00", - "DATE_REGISTER": "2024-02-10T00:00:00+00:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ], - "USER_TYPE": "employee" - }, - { - "ID": "10", - "XML_ID": "56016490", - "ACTIVE": true, - "NAME": "Techno", - "LAST_NAME": "Pizza", - "EMAIL": "iscript13@gmail.com", - "LAST_LOGIN": "2024-07-13T14:46:11+00:00", - "DATE_REGISTER": "2024-06-15T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "LAST_ACTIVITY_DATE": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ], - "USER_TYPE": "employee" - }, - { - "ID": "60", - "XML_ID": "56731232", - "ACTIVE": true, - "NAME": "Виталий", - "LAST_NAME": "Альпака", - "EMAIL": "87394c27-0694-457e-bcc9-39ccf92ffbf7@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-30T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1 - ], - "USER_TYPE": "employee" - } - ], - "total": 11, - "time": { - "start": 1722328393.63268, - "finish": 1722328393.68509, - "duration": 0.0524110794067383, - "processing": 0.0202820301055908, - "date_start": "2024-07-30T08:33:13+00:00", - "date_finish": "2024-07-30T08:33:13+00:00", - "operating_reset_at": 1722328993, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Найти пользователей + Получает список пользователей по заданному фильтру + + + +`Функция НайтиПользователей(Знач URL, Знач СтруктураФильтра, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураФильтра | --filter | Структура Из КлючИЗначение | Фильтр. См. ПолучитьСтруктуруФильтраПользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("NAME" , "Виталий"); + СтруктураФильтра.Вставить("LAST_NAME" , "Альпака"); + СтруктураФильтра.Вставить("WORK_POSITION" , "DevOps инженер"); + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Отдел маркетинга"); + СтруктураФильтра.Вставить("USER_TYPE" , "employee"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + СтруктураФильтра = Новый Структура; + СтруктураФильтра.Вставить("UF_DEPARTMENT_NAME", "Битрикс"); + + Результат = OPI_Bitrix24.НайтиПользователей(URL, СтруктураФильтра, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 НайтиПользователей --url %url% --filter %filter% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "12", + "XML_ID": "56479740", + "ACTIVE": true, + "NAME": "Bay", + "LAST_NAME": "Selonarrend", + "EMAIL": "oarismos@gmail.com", + "LAST_LOGIN": "2024-07-13T07:17:17+00:00", + "DATE_REGISTER": "2024-07-13T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "18", + "XML_ID": "56701916", + "ACTIVE": true, + "EMAIL": "hey@exepmple.com", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "34", + "XML_ID": "56702240", + "ACTIVE": false, + "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "38", + "XML_ID": "56702244", + "ACTIVE": false, + "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "42", + "XML_ID": "56702314", + "ACTIVE": true, + "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "46", + "XML_ID": "56702336", + "ACTIVE": false, + "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "50", + "XML_ID": "56702654", + "ACTIVE": false, + "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-28T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "54", + "XML_ID": "56721830", + "ACTIVE": false, + "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-29T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + }, + { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Антон", + "LAST_NAME": "Титовец", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-07-30T06:49:41+00:00", + "DATE_REGISTER": "2024-02-10T00:00:00+00:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ], + "USER_TYPE": "employee" + }, + { + "ID": "10", + "XML_ID": "56016490", + "ACTIVE": true, + "NAME": "Techno", + "LAST_NAME": "Pizza", + "EMAIL": "iscript13@gmail.com", + "LAST_LOGIN": "2024-07-13T14:46:11+00:00", + "DATE_REGISTER": "2024-06-15T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "LAST_ACTIVITY_DATE": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ], + "USER_TYPE": "employee" + }, + { + "ID": "60", + "XML_ID": "56731232", + "ACTIVE": true, + "NAME": "Виталий", + "LAST_NAME": "Альпака", + "EMAIL": "87394c27-0694-457e-bcc9-39ccf92ffbf7@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-30T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1 + ], + "USER_TYPE": "employee" + } + ], + "total": 11, + "time": { + "start": 1722328393.63268, + "finish": 1722328393.68509, + "duration": 0.0524110794067383, + "processing": 0.0202820301055908, + "date_start": "2024-07-30T08:33:13+00:00", + "date_finish": "2024-07-30T08:33:13+00:00", + "operating_reset_at": 1722328993, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md index 17cba80c6f..42483f5214 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md +++ b/docs/ru/md/Bitrix24/Users-managment/Get-current-user.md @@ -1,82 +1,82 @@ ---- -sidebar_position: 1 ---- - -# Получить текущего пользователя - Получает информацию о текущем пользователе - - - -`Функция ПолучитьТекущегоПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьТекущегоПользователя --url %url% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": "1", - "XML_ID": "53818298", - "ACTIVE": true, - "NAME": "Антон", - "LAST_NAME": "Титовец", - "EMAIL": "no-reply@bitrix24.com", - "LAST_LOGIN": "2024-07-30T06:49:41+00:00", - "DATE_REGISTER": "2024-02-10T00:00:00+00:00", - "IS_ONLINE": "N", - "TIME_ZONE_OFFSET": "0", - "TIMESTAMP_X": "30.07.2024 11:32:54", - "LAST_ACTIVITY_DATE": "2024-07-30 10:04:49", - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 1, - 50 - ] - }, - "time": { - "start": 1722328382.88095, - "finish": 1722328382.91677, - "duration": 0.0358180999755859, - "processing": 0.00372004508972168, - "date_start": "2024-07-30T08:33:02+00:00", - "date_finish": "2024-07-30T08:33:02+00:00", - "operating_reset_at": 1722328982, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить текущего пользователя + Получает информацию о текущем пользователе + + + +`Функция ПолучитьТекущегоПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.current](https://dev.1c-bitrix.ru/rest_help/users/user_current.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьТекущегоПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьТекущегоПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "1", + "XML_ID": "53818298", + "ACTIVE": true, + "NAME": "Антон", + "LAST_NAME": "Титовец", + "EMAIL": "no-reply@bitrix24.com", + "LAST_LOGIN": "2024-07-30T06:49:41+00:00", + "DATE_REGISTER": "2024-02-10T00:00:00+00:00", + "IS_ONLINE": "N", + "TIME_ZONE_OFFSET": "0", + "TIMESTAMP_X": "30.07.2024 11:32:54", + "LAST_ACTIVITY_DATE": "2024-07-30 10:04:49", + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_PHOTO": "https://cdn-ru.bitrix24.by/b28528874/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 1, + 50 + ] + }, + "time": { + "start": 1722328382.88095, + "finish": 1722328382.91677, + "duration": 0.0358180999755859, + "processing": 0.00372004508972168, + "date_start": "2024-07-30T08:33:02+00:00", + "date_finish": "2024-07-30T08:33:02+00:00", + "operating_reset_at": 1722328982, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md index a3f54a5204..e47bf6cc34 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-fields-structure.md @@ -1,126 +1,126 @@ ---- -sidebar_position: 7 ---- - -# Получить стурктуру пользователя - Получает структурау полей для создания или изменения пользователя - - - -`Функция ПолучитьСтурктуруПользователя(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - - Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтурктуруПользователя --url %url% --token %token% - -``` - -```json title="Результат" -{ - "result": { - "ID": "ID", - "XML_ID": "Внешний код", - "ACTIVE": "Активность", - "NAME": "Имя", - "LAST_NAME": "Фамилия", - "SECOND_NAME": "Отчество", - "TITLE": "Список пользователей", - "EMAIL": "E-Mail", - "LAST_LOGIN": "Последняя авторизация", - "DATE_REGISTER": "Дата регистрации", - "TIME_ZONE": "TIME_ZONE", - "IS_ONLINE": "IS_ONLINE", - "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", - "TIMESTAMP_X": "TIMESTAMP_X", - "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", - "PERSONAL_GENDER": "Пол", - "PERSONAL_PROFESSION": "Профессия", - "PERSONAL_WWW": "Домашняя страничка", - "PERSONAL_BIRTHDAY": "Дата рождения", - "PERSONAL_PHOTO": "Фотография", - "PERSONAL_ICQ": "ICQ", - "PERSONAL_PHONE": "Личный телефон", - "PERSONAL_FAX": "Факс", - "PERSONAL_MOBILE": "Личный мобильный", - "PERSONAL_PAGER": "Пейджер", - "PERSONAL_STREET": "Улица проживания", - "PERSONAL_CITY": "Город проживания", - "PERSONAL_STATE": "Область / край", - "PERSONAL_ZIP": "Почтовый индекс", - "PERSONAL_COUNTRY": "Страна", - "PERSONAL_MAILBOX": "Почтовый ящик", - "PERSONAL_NOTES": "Дополнительные заметки", - "WORK_PHONE": "Телефон компании", - "WORK_COMPANY": "Компания", - "WORK_POSITION": "Должность", - "WORK_DEPARTMENT": "Отдел", - "WORK_WWW": "Сайт компании", - "WORK_FAX": "WORK_FAX", - "WORK_PAGER": "WORK_PAGER", - "WORK_STREET": "WORK_STREET", - "WORK_MAILBOX": "WORK_MAILBOX", - "WORK_CITY": "Город работы", - "WORK_STATE": "WORK_STATE", - "WORK_ZIP": "WORK_ZIP", - "WORK_COUNTRY": "WORK_COUNTRY", - "WORK_PROFILE": "WORK_PROFILE", - "WORK_LOGO": "WORK_LOGO", - "WORK_NOTES": "WORK_NOTES", - "UF_SKYPE_LINK": "Ссылка на чат в Skype", - "UF_ZOOM": "Zoom", - "UF_EMPLOYMENT_DATE": "Дата принятия на работу", - "UF_TIMEMAN": "Учет рабочего времени", - "UF_DEPARTMENT": "Подразделения", - "UF_INTERESTS": "Интересы", - "UF_SKILLS": "Навыки", - "UF_WEB_SITES": "Другие сайты", - "UF_XING": "Xing", - "UF_LINKEDIN": "LinkedIn", - "UF_FACEBOOK": "Facebook", - "UF_TWITTER": "Twitter", - "UF_SKYPE": "Skype", - "UF_DISTRICT": "Район", - "UF_PHONE_INNER": "Внутренний телефон", - "USER_TYPE": "USER_TYPE" - }, - "time": { - "start": 1722328384.61197, - "finish": 1722328384.64683, - "duration": 0.0348641872406006, - "processing": 0.000688076019287109, - "date_start": "2024-07-30T08:33:04+00:00", - "date_finish": "2024-07-30T08:33:04+00:00", - "operating_reset_at": 1722328984, - "operating": 0 - } -} -``` +--- +sidebar_position: 7 +--- + +# Получить стурктуру пользователя + Получает структурау полей для создания или изменения пользователя + + + +`Функция ПолучитьСтурктуруПользователя(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.fields](https://dev.1c-bitrix.ru/rest_help/users/user_fields.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтурктуруПользователя(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтурктуруПользователя --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "ID", + "XML_ID": "Внешний код", + "ACTIVE": "Активность", + "NAME": "Имя", + "LAST_NAME": "Фамилия", + "SECOND_NAME": "Отчество", + "TITLE": "Список пользователей", + "EMAIL": "E-Mail", + "LAST_LOGIN": "Последняя авторизация", + "DATE_REGISTER": "Дата регистрации", + "TIME_ZONE": "TIME_ZONE", + "IS_ONLINE": "IS_ONLINE", + "TIME_ZONE_OFFSET": "TIME_ZONE_OFFSET", + "TIMESTAMP_X": "TIMESTAMP_X", + "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE", + "PERSONAL_GENDER": "Пол", + "PERSONAL_PROFESSION": "Профессия", + "PERSONAL_WWW": "Домашняя страничка", + "PERSONAL_BIRTHDAY": "Дата рождения", + "PERSONAL_PHOTO": "Фотография", + "PERSONAL_ICQ": "ICQ", + "PERSONAL_PHONE": "Личный телефон", + "PERSONAL_FAX": "Факс", + "PERSONAL_MOBILE": "Личный мобильный", + "PERSONAL_PAGER": "Пейджер", + "PERSONAL_STREET": "Улица проживания", + "PERSONAL_CITY": "Город проживания", + "PERSONAL_STATE": "Область / край", + "PERSONAL_ZIP": "Почтовый индекс", + "PERSONAL_COUNTRY": "Страна", + "PERSONAL_MAILBOX": "Почтовый ящик", + "PERSONAL_NOTES": "Дополнительные заметки", + "WORK_PHONE": "Телефон компании", + "WORK_COMPANY": "Компания", + "WORK_POSITION": "Должность", + "WORK_DEPARTMENT": "Отдел", + "WORK_WWW": "Сайт компании", + "WORK_FAX": "WORK_FAX", + "WORK_PAGER": "WORK_PAGER", + "WORK_STREET": "WORK_STREET", + "WORK_MAILBOX": "WORK_MAILBOX", + "WORK_CITY": "Город работы", + "WORK_STATE": "WORK_STATE", + "WORK_ZIP": "WORK_ZIP", + "WORK_COUNTRY": "WORK_COUNTRY", + "WORK_PROFILE": "WORK_PROFILE", + "WORK_LOGO": "WORK_LOGO", + "WORK_NOTES": "WORK_NOTES", + "UF_SKYPE_LINK": "Ссылка на чат в Skype", + "UF_ZOOM": "Zoom", + "UF_EMPLOYMENT_DATE": "Дата принятия на работу", + "UF_TIMEMAN": "Учет рабочего времени", + "UF_DEPARTMENT": "Подразделения", + "UF_INTERESTS": "Интересы", + "UF_SKILLS": "Навыки", + "UF_WEB_SITES": "Другие сайты", + "UF_XING": "Xing", + "UF_LINKEDIN": "LinkedIn", + "UF_FACEBOOK": "Facebook", + "UF_TWITTER": "Twitter", + "UF_SKYPE": "Skype", + "UF_DISTRICT": "Район", + "UF_PHONE_INNER": "Внутренний телефон", + "USER_TYPE": "USER_TYPE" + }, + "time": { + "start": 1722328384.61197, + "finish": 1722328384.64683, + "duration": 0.0348641872406006, + "processing": 0.000688076019287109, + "date_start": "2024-07-30T08:33:04+00:00", + "date_finish": "2024-07-30T08:33:04+00:00", + "operating_reset_at": 1722328984, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md index d8019c8734..a0076ef8e2 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user-filter-structure.md @@ -1,33 +1,33 @@ ---- -sidebar_position: 8 ---- - -# Получить структуру фильтра пользователей - Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей - - - -`Функция ПолучитьСтруктуруФильтраПользователей(Знач Пустая = Ложь) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -
- - - - - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтруктуруФильтраПользователей --empty %empty% - -``` - - +--- +sidebar_position: 8 +--- + +# Получить структуру фильтра пользователей + Возвращает структуру полей для фильтрации пользователей в методе НайтиПользователей + + + +`Функция ПолучитьСтруктуруФильтраПользователей(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтруктуруФильтраПользователей --empty %empty% + +``` + + diff --git a/docs/ru/md/Bitrix24/Users-managment/Get-user.md b/docs/ru/md/Bitrix24/Users-managment/Get-user.md index b81cb409e4..148a6bcc44 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Get-user.md +++ b/docs/ru/md/Bitrix24/Users-managment/Get-user.md @@ -1,86 +1,86 @@ ---- -sidebar_position: 2 ---- - -# Получить пользователя - Получает информацию о пользователе по ID - - - -`Функция ПолучитьПользователя(Знач URL, Знач IDПользователя, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для получения | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПользователя = "78"; - - Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = "80"; - - Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьПользователя --url %url% --userid %userid% --token %token% - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "60", - "XML_ID": "56731232", - "ACTIVE": true, - "NAME": "Олег", - "LAST_NAME": "Лама", - "EMAIL": "804d1dbb-7df4-4245-8266-938fc2541978@exepmple.org", - "LAST_LOGIN": "", - "DATE_REGISTER": "2024-07-30T00:00:00+00:00", - "IS_ONLINE": "N", - "TIMESTAMP_X": {}, - "PERSONAL_GENDER": "", - "PERSONAL_BIRTHDAY": "", - "PERSONAL_MOBILE": "88003553535", - "UF_EMPLOYMENT_DATE": "", - "UF_DEPARTMENT": [ - 7 - ], - "USER_TYPE": "employee" - } - ], - "total": 1, - "time": { - "start": 1722328397.72079, - "finish": 1722328397.76914, - "duration": 0.0483510494232178, - "processing": 0.0120601654052734, - "date_start": "2024-07-30T08:33:17+00:00", - "date_finish": "2024-07-30T08:33:17+00:00", - "operating_reset_at": 1722328997, - "operating": 0 - } -} -``` +--- +sidebar_position: 2 +--- + +# Получить пользователя + Получает информацию о пользователе по ID + + + +`Функция ПолучитьПользователя(Знач URL, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.get](https://dev.1c-bitrix.ru/rest_help/users/user_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПользователя = "78"; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = "80"; + + Результат = OPI_Bitrix24.ПолучитьПользователя(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПользователя --url %url% --userid %userid% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "60", + "XML_ID": "56731232", + "ACTIVE": true, + "NAME": "Олег", + "LAST_NAME": "Лама", + "EMAIL": "804d1dbb-7df4-4245-8266-938fc2541978@exepmple.org", + "LAST_LOGIN": "", + "DATE_REGISTER": "2024-07-30T00:00:00+00:00", + "IS_ONLINE": "N", + "TIMESTAMP_X": {}, + "PERSONAL_GENDER": "", + "PERSONAL_BIRTHDAY": "", + "PERSONAL_MOBILE": "88003553535", + "UF_EMPLOYMENT_DATE": "", + "UF_DEPARTMENT": [ + 7 + ], + "USER_TYPE": "employee" + } + ], + "total": 1, + "time": { + "start": 1722328397.72079, + "finish": 1722328397.76914, + "duration": 0.0483510494232178, + "processing": 0.0120601654052734, + "date_start": "2024-07-30T08:33:17+00:00", + "date_finish": "2024-07-30T08:33:17+00:00", + "operating_reset_at": 1722328997, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Users-managment/Update-user.md b/docs/ru/md/Bitrix24/Users-managment/Update-user.md index dc81a4ec0a..bc5a506c9c 100644 --- a/docs/ru/md/Bitrix24/Users-managment/Update-user.md +++ b/docs/ru/md/Bitrix24/Users-managment/Update-user.md @@ -1,79 +1,79 @@ ---- -sidebar_position: 4 ---- - -# Изменить пользователя - Изменяет данные пользователя - - - -`Функция ИзменитьПользователя(Знач URL, Знач IDПользователя, Знач СтруктураПолей, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- -:::tip -Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) -::: -
- - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; - IDПользователя = "78"; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); - - Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "fe3fa966006e9f06006b12e400000001000..."; - IDПользователя = "80"; - Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; - - СтруктураПользователя = Новый Структура; - СтруктураПользователя.Вставить("EMAIL" , Почта); - СтруктураПользователя.Вставить("NAME" , "Олег"); - СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); - СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); - - Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ИзменитьПользователя --url %url% --userid %userid% --fields %fields% --token %token% - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1722328395.63697, - "finish": 1722328395.97568, - "duration": 0.338706016540527, - "processing": 0.310076951980591, - "date_start": "2024-07-30T08:33:15+00:00", - "date_finish": "2024-07-30T08:33:15+00:00", - "operating_reset_at": 1722328995, - "operating": 0.310055017471314 - } -} -``` +--- +sidebar_position: 4 +--- + +# Изменить пользователя + Изменяет данные пользователя + + + +`Функция ИзменитьПользователя(Знач URL, Знач IDПользователя, Знач СтруктураПолей, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDПользователя | --userid | Строка, Число | ID пользователя для изменения | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Данные пользователя. См. ПолучитьСтурктуруПользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/"; + IDПользователя = "78"; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + // Полную структуру можно получить функцией ПолучитьСтурктуруПользователя + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("UF_DEPARTMENT", 1); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя); + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "fe3fa966006e9f06006b12e400000001000..."; + IDПользователя = "80"; + Почта = Строка(Новый УникальныйИдентификатор) + "@exepmple.org"; + + СтруктураПользователя = Новый Структура; + СтруктураПользователя.Вставить("EMAIL" , Почта); + СтруктураПользователя.Вставить("NAME" , "Олег"); + СтруктураПользователя.Вставить("LAST_NAME" , "Лама"); + СтруктураПользователя.Вставить("UF_DEPARTMENT" , 7); + + Результат = OPI_Bitrix24.ИзменитьПользователя(URL, IDПользователя, СтруктураПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьПользователя --url %url% --userid %userid% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1722328395.63697, + "finish": 1722328395.97568, + "duration": 0.338706016540527, + "processing": 0.310076951980591, + "date_start": "2024-07-30T08:33:15+00:00", + "date_finish": "2024-07-30T08:33:15+00:00", + "operating_reset_at": 1722328995, + "operating": 0.310055017471314 + } +} +``` diff --git a/docs/ru/md/VK/Ad-account-management/Pause-advertising.md b/docs/ru/md/VK/Ad-account-management/Pause-advertising.md index e30bb32608..2753e7dc9e 100644 --- a/docs/ru/md/VK/Ad-account-management/Pause-advertising.md +++ b/docs/ru/md/VK/Ad-account-management/Pause-advertising.md @@ -1,51 +1,51 @@ ---- -sidebar_position: 3 ---- - -# Приостановить рекламное объявление - Приостанавливает показ рекламного объявления - - - -`Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | IDОбъявления | --adv | Строка,Число | ID объявления | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - IDКабинета = "1607951446"; - IDОбъявления = "0"; - - Результат = OPI_VK.ПриостановитьРекламноеОбъявление(IDКабинета, IDОбъявления, Параметры); -``` - - - -```sh title="Пример команды CLI" - - oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% - -``` - -```json title="Результат" -{ - "response": [ - { - "id": 1029701085 - } - ] - } -``` +--- +sidebar_position: 3 +--- + +# Приостановить рекламное объявление + Приостанавливает показ рекламного объявления + + + +`Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | + | IDОбъявления | --adv | Строка,Число | ID объявления | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + IDКабинета = "1607951446"; + IDОбъявления = "0"; + + Результат = OPI_VK.ПриостановитьРекламноеОбъявление(IDКабинета, IDОбъявления, Параметры); +``` + + + +```sh title="Пример команды CLI" + + oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% + +``` + +```json title="Результат" +{ + "response": [ + { + "id": 1029701085 + } + ] + } +``` diff --git a/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md b/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md index 435fd43303..c3efac8ef0 100644 --- a/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md +++ b/docs/ru/md/VK/Product-selection-management/Add-product-to-collection.md @@ -1,47 +1,47 @@ ---- -sidebar_position: 5 ---- - -# Добавить товар в подборку - Добавляет товар в подборку - - - -`Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -
- - - - -```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); - - Товар = "9372711"; - Подборка = "125"; - - Результат = OPI_VK.ДобавитьТоварВПодборку(Товар, Подборка, Параметры); -``` - - - -```sh title="Пример команды CLI" - - oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% - -``` - -```json title="Результат" -{ - "response": 1 - } -``` +--- +sidebar_position: 5 +--- + +# Добавить товар в подборку + Добавляет товар в подборку + + + +`Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | + | Подборка | --sel | Строка | ID подборки | + | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + +
+ + + + +```bsl title="Пример кода" + Параметры = ПолучитьПараметрыВК(); + + Товар = "9372711"; + Подборка = "125"; + + Результат = OPI_VK.ДобавитьТоварВПодборку(Товар, Подборка, Параметры); +``` + + + +```sh title="Пример команды CLI" + + oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% + +``` + +```json title="Результат" +{ + "response": 1 + } +``` diff --git a/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md b/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md new file mode 100644 index 0000000000..dd9a5914cc --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/Remove-chat-members.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# Исключить пользователей чата + Исключает пользователей из чата + + + +`Функция ИсключитьПользователейЧата(Знач Токен, Знач IDЧата, Знач Пользователи) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата | + | Пользователи | --members | Строка, Число, Массив Из Строка, Число | Пользователь или пользователи чата для удаления | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete) +::: +
+ + + + + +```sh title="Пример команды CLI" + +oint vkteams ИсключитьПользователейЧата --token %token% --chatid %chatid% --members %members% + +``` + + diff --git a/docs/ru/md/VKTeams/Chat-management/_category_.json b/docs/ru/md/VKTeams/Chat-management/_category_.json new file mode 100644 index 0000000000..3ac3457362 --- /dev/null +++ b/docs/ru/md/VKTeams/Chat-management/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Управление чатами", +"position": "4" +} \ No newline at end of file diff --git a/docs/ru/md/VKTeams/Common-methods/Check-token.md b/docs/ru/md/VKTeams/Common-methods/Check-token.md index fbf40dc630..dca80073af 100644 --- a/docs/ru/md/VKTeams/Common-methods/Check-token.md +++ b/docs/ru/md/VKTeams/Common-methods/Check-token.md @@ -1,45 +1,40 @@ ---- -sidebar_position: 1 ---- - -# Проверить токен - Проверяет работоспособность токена бота - - - -`Функция ПроверитьТокен(Знач Токен) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - Результат = OPI_VKTeams.ПроверитьТокен(Токен); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ПроверитьТокен --token %token% - -``` - -```json title="Результат" -{ - "userId": "1011893356", - "ok": true -} -``` +--- +sidebar_position: 1 +--- + +# Проверить токен + Проверяет работоспособность токена бота + + + +`Функция ПроверитьТокен(Знач Токен) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /self/get](https://teams.vk.com/botapi/#/self/get_self_get) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + Результат = OPI_VKTeams.ПроверитьТокен(Токен); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ПроверитьТокен --token %token% + +``` + + diff --git a/docs/ru/md/VKTeams/Common-methods/Get-events.md b/docs/ru/md/VKTeams/Common-methods/Get-events.md index ac81fe7e15..033bde2582 100644 --- a/docs/ru/md/VKTeams/Common-methods/Get-events.md +++ b/docs/ru/md/VKTeams/Common-methods/Get-events.md @@ -1,61 +1,56 @@ ---- -sidebar_position: 2 ---- - -# Получить события - Получает события бота в Polling режиме - - - -`Функция ПолучитьСобытия(Знач Токен, Знач IDПоследнего, Знач Таймаут = 0) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDПоследнего | --last | Строка, Число | ID последнего обработанного до этого события | - | Таймаут | --timeout | Строка, Число | Время удержания соединения для Long Polling | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDПоследнего = 0; - - Для Н = 1 По 5 Цикл // В реальной работе - бесконечный цикл - - Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); - - События = Результат["events"]; - - // Обработка событий... - - Если Не События.Количество() = 0 Тогда - IDПоследнего = События[События.ВГраница()]["eventId"]; - КонецЕсли; - - КонецЦикла; -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ПолучитьСобытия --token %token% --last %last% --timeout %timeout% - -``` - -```json title="Результат" -{ - "events": [], - "ok": true -} -``` +--- +sidebar_position: 2 +--- + +# Получить события + Получает события бота в Polling режиме + + + +`Функция ПолучитьСобытия(Знач Токен, Знач IDПоследнего, Знач Таймаут = 0) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDПоследнего | --last | Строка, Число | ID последнего обработанного до этого события | + | Таймаут | --timeout | Строка, Число | Время удержания соединения для Long Polling | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /events/get](https://teams.vk.com/botapi/#/events/get_events_get) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDПоследнего = 0; + + Для Н = 1 По 5 Цикл // В реальной работе - бесконечный цикл + + Результат = OPI_VKTeams.ПолучитьСобытия(Токен, IDПоследнего, 3); + + События = Результат["events"]; + + // Обработка событий... + + Если Не События.Количество() = 0 Тогда + IDПоследнего = События[События.ВГраница()]["eventId"]; + КонецЕсли; + + КонецЦикла; +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ПолучитьСобытия --token %token% --last %last% --timeout %timeout% + +``` + + diff --git a/docs/ru/md/VKTeams/Common-methods/Get-file-information.md b/docs/ru/md/VKTeams/Common-methods/Get-file-information.md index c931e853f2..c4f8501edd 100644 --- a/docs/ru/md/VKTeams/Common-methods/Get-file-information.md +++ b/docs/ru/md/VKTeams/Common-methods/Get-file-information.md @@ -1,51 +1,43 @@ ---- -sidebar_position: 3 ---- - -# Получить информацию о файле - Получает информацию о файле по его ID - - - -`Функция ПолучитьИнформациюОФайле(Знач Токен, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDФайла | --fileid | Строка, Число | ID Файла | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDФайла = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; - - Результат = OPI_VKTeams.ПолучитьИнформациюОФайле(Токен, IDФайла); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ПолучитьИнформациюОФайле --token %token% --fileid %fileid% - -``` - -```json title="Результат" -{ - "filename": "ВажныйДокумент.docx", - "size": 24071, - "type": "application", - "url": "https://ub.icq.net/files/get/XrJ30TgJvcpZoiAEu1MC46e1MCbBs3NXwqSkBiZgCEkXOsNmPmAnw2XXpEM4WXMcylct3N2s3XwyMI5Cj7GDKtY6FmpmOHLgYC2xUanmVRf4gtn0zVatipXHgtriTJACrKfemXbqJuLCNOYZJieYS72mwqu1MC/%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", - "ok": true -} -``` +--- +sidebar_position: 3 +--- + +# Получить информацию о файле + Получает информацию о файле по его ID + + + +`Функция ПолучитьИнформациюОФайле(Знач Токен, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDФайла | --fileid | Строка, Число | ID Файла | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /files/getInfo](https://teams.vk.com/botapi/#/files/get_files_getInfo) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDФайла = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; + + Результат = OPI_VKTeams.ПолучитьИнформациюОФайле(Токен, IDФайла); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ПолучитьИнформациюОФайле --token %token% --fileid %fileid% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Delete-message.md b/docs/ru/md/VKTeams/Message-sending/Delete-message.md index 99b553aaa6..ef9268cced 100644 --- a/docs/ru/md/VKTeams/Message-sending/Delete-message.md +++ b/docs/ru/md/VKTeams/Message-sending/Delete-message.md @@ -1,45 +1,45 @@ ---- -sidebar_position: 5 ---- - -# Удалить сообщение - Удаляет сообщение по ID - - - -`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7402287649739767956"; - - Результат = OPI_VKTeams.УдалитьСообщение(Токен, IDЧата, IDСообщения); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams УдалитьСообщение --token %token% --chatid %chatid% --messageid %messageid% - -``` - - +--- +sidebar_position: 5 +--- + +# Удалить сообщение + Удаляет сообщение по ID + + + +`Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/deleteMessages](https://teams.vk.com/botapi/#/messages/get_messages_deleteMessages) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7402287649739767956"; + + Результат = OPI_VKTeams.УдалитьСообщение(Токен, IDЧата, IDСообщения); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams УдалитьСообщение --token %token% --chatid %chatid% --messageid %messageid% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md b/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md index d475155aad..3740e681d2 100644 --- a/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md +++ b/docs/ru/md/VKTeams/Message-sending/Edit-message-text.md @@ -1,59 +1,55 @@ ---- -sidebar_position: 4 ---- - -# Изменить текст сообщения - Изменяет текст сущесствующего сообщения - - - -`Функция ИзменитьТекстСообщения(Знач Токен, Знач IDЧата, Знач IDСообщения, Знач Текст, Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | - | Текст | --text | Строка | Новый текст сообщения | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] - - Метод в документации API: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDСообщения = "7402287649739767956"; - Текст = "Новый текст сообщения"; - - Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст); - - Текст = "Новый полужирный текст сообщения"; - Разметка = "HTML"; - - Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст, Разметка); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ИзменитьТекстСообщения --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod% - -``` - -```json title="Результат" -{ - "ok": true -} -``` +--- +sidebar_position: 4 +--- + +# Изменить текст сообщения + Изменяет текст сущесствующего сообщения + + + +`Функция ИзменитьТекстСообщения(Знач Токен, Знач IDЧата, Знач IDСообщения, Знач Текст, Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | IDСообщения | --messageid | Строка, Число | ID сообщения для редактирования | + | Текст | --text | Строка | Новый текст сообщения | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] + + Метод в документации API: [GET /messages/editText](https://teams.vk.com/botapi/#/messages/get_messages_editText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDСообщения = "7402287649739767956"; + Текст = "Новый текст сообщения"; + + Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст); + + Текст = "Новый полужирный текст сообщения"; + Разметка = "HTML"; + + Результат = OPI_VKTeams.ИзменитьТекстСообщения(Токен, IDЧата, IDСообщения, Текст, Разметка); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ИзменитьТекстСообщения --token %token% --chatid %chatid% --messageid %messageid% --text %text% --parsemod %parsemod% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Forward-message.md b/docs/ru/md/VKTeams/Message-sending/Forward-message.md index 7e6fe56f89..4c312afed9 100644 --- a/docs/ru/md/VKTeams/Message-sending/Forward-message.md +++ b/docs/ru/md/VKTeams/Message-sending/Forward-message.md @@ -1,59 +1,54 @@ ---- -sidebar_position: 8 ---- - -# Переслать сообщение - Переслыает существующее сообщение в текущий диалог - - - -`Функция ПереслатьСообщение(Знач Токен, Знач IDСообщения, Знач IDЧатаИсточника, Знач IDЧата, Знач Текст = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDСообщения | --message | Строка, Число | ID оригинального сообщения | - | IDЧатаИсточника | --fromid | Строка, Число | ID чата источника оригинального сообщения | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | Текст | --text | Строка | Дополнительный текст сообщения | - - - Возвращаемое значение: HTTPОтвет - Переслать сообщение - -
- -:::tip -В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит) - - Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDЧатаИсточника = "689203963@chat.agent"; - IDСообщения = "7402287649739767956"; - - Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата); - - Текст = "Дополнительный текст"; - - Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата, Текст); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ПереслатьСообщение --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text% - -``` - -```json title="Результат" -{ - "msgId": "7401634788940972096", - "ok": true -} -``` +--- +sidebar_position: 8 +--- + +# Переслать сообщение + Переслыает существующее сообщение в текущий диалог + + + +`Функция ПереслатьСообщение(Знач Токен, Знач IDСообщения, Знач IDЧатаИсточника, Знач IDЧата, Знач Текст = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDСообщения | --message | Строка, Число | ID оригинального сообщения | + | IDЧатаИсточника | --fromid | Строка, Число | ID чата источника оригинального сообщения | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | Текст | --text | Строка | Дополнительный текст сообщения | + + + Возвращаемое значение: HTTPОтвет - Переслать сообщение + +
+ +:::tip +В IDЧатаИсточника можно передавать только chatId из событий (код из ссылки на чат не подходит) + + Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + IDЧатаИсточника = "689203963@chat.agent"; + IDСообщения = "7402287649739767956"; + + Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата); + + Текст = "Дополнительный текст"; + + Результат = OPI_VKTeams.ПереслатьСообщение(Токен, IDСообщения, IDЧатаИсточника, IDЧата, Текст); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ПереслатьСообщение --token %token% --message %message% --fromid %fromid% --chatid %chatid% --text %text% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-file.md b/docs/ru/md/VKTeams/Message-sending/Resend-file.md index 0ac0d1d9fa..df13008af6 100644 --- a/docs/ru/md/VKTeams/Message-sending/Resend-file.md +++ b/docs/ru/md/VKTeams/Message-sending/Resend-file.md @@ -1,55 +1,49 @@ ---- -sidebar_position: 6 ---- - -# Переслать файл - Отправляет ранее загруженный файл по его ID - - - -`Функция ПереслатьФайл(Знач Токен, Знач IDЧата, Знач IDФайла, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | IDФайла | --fileid | Строка, Число | ID Файла для отправки | - | Текст | --text | Строка | Подпись к файлу | - | ИмяФайла | --filename | Строка | Отображаемое имя файла | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDФайла = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; - Текст = "Подпись к файлу"; - - Результат = OPI_VKTeams.ПереслатьФайл(Токен, IDЧата, IDФайла, Текст, "ТотЖеДокумент.docx"); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ПереслатьФайл --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod% - -``` - -```json title="Результат" -{ - "fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd", - "msgId": "7401634819005743172", - "ok": true -} -``` +--- +sidebar_position: 6 +--- + +# Переслать файл + Отправляет ранее загруженный файл по его ID + + + +`Функция ПереслатьФайл(Знач Токен, Знач IDЧата, Знач IDФайла, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | IDФайла | --fileid | Строка, Число | ID Файла для отправки | + | Текст | --text | Строка | Подпись к файлу | + | ИмяФайла | --filename | Строка | Отображаемое имя файла | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/sendFile](https://teams.vk.com/botapi/#/messages/get_messages_sendFile) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + IDФайла = "sXhpbA5K2ZCOdG5ROIfRan66ba356d1bd"; + Текст = "Подпись к файлу"; + + Результат = OPI_VKTeams.ПереслатьФайл(Токен, IDЧата, IDФайла, Текст, "ТотЖеДокумент.docx"); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ПереслатьФайл --token %token% --chatid %chatid% --fileid %fileid% --text %text% --filename %filename% --parsemod %parsemod% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Resend-voice.md b/docs/ru/md/VKTeams/Message-sending/Resend-voice.md index 2514ee9948..7b84205a67 100644 --- a/docs/ru/md/VKTeams/Message-sending/Resend-voice.md +++ b/docs/ru/md/VKTeams/Message-sending/Resend-voice.md @@ -1,45 +1,38 @@ ---- -sidebar_position: 7 ---- - -# Переслать голосовое сообщение - Отправляет ранее загруженное голосовое сообщение по ID - - - -`Функция ПереслатьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач IDФайла) Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | IDФайла | --fileid | Строка, Число | ID Файла голосового сообщения | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - IDФайла = "I000bPVBYaNQkn9Fg3oY0066ba35811bd"; - - Результат = OPI_VKTeams.ПереслатьГолосовоеСообщение(Токен, IDЧата, IDФайла); -``` - - - -```sh title="Пример команды CLI" - -oint vkteams ПереслатьГолосовоеСообщение --token "001.3501506236.091..." --chatid "AoLI0egLWBSLR1Ngn2w" --fileid "I000bPVBYaNQkn9Fg3oY0066ba35811bd" - -``` - - +--- +sidebar_position: 7 +--- + +# Переслать голосовое сообщение + Отправляет ранее загруженное голосовое сообщение по ID + + + +`Функция ПереслатьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач IDФайла) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | IDФайла | --fileid | Строка, Число | ID Файла голосового сообщения | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [GET /messages/sendVoice](https://teams.vk.com/botapi/#/messages/get_messages_sendVoice) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint vkteams ПереслатьГолосовоеСообщение --token "001.3501506236.091..." --chatid "AoLI0egLWBSLR1Ngn2w" --fileid "I000bPVBYaNQkn9Fg3oY0066ba35811bd" + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Send-file.md b/docs/ru/md/VKTeams/Message-sending/Send-file.md index 311957558e..7a387d6946 100644 --- a/docs/ru/md/VKTeams/Message-sending/Send-file.md +++ b/docs/ru/md/VKTeams/Message-sending/Send-file.md @@ -1,65 +1,59 @@ ---- -sidebar_position: 2 ---- - -# Отправить файл - Отправляет файл в чат - - - -`Функция ОтправитьФайл(Знач Токен, Знач IDЧата, Знач Файл, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | - | Текст | --text | Строка | Подпись к файлу | - | ИмяФайла | --filename | Строка | Отображаемое имя файла | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Метод в документации API: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - Текст = "Подпись к файлу"; - - Файл = "https://openintegrations.dev/test_data/document.docx"; // URL - ФайлПуть = ПолучитьИмяВременногоФайла("docx"); // Путь - - КопироватьФайл(Файл, ФайлПуть); - - ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл); - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлПуть, Текст); - - Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл, Текст, "ВажныйДокумент.docx"); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ОтправитьФайл --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod% - -``` - -```json title="Результат" -{ - "fileId": "XrJ30XSsGyVg0tOK52eUzi66b7e3a21bd", - "msgId": "7401634797530906691", - "ok": true -} -``` +--- +sidebar_position: 2 +--- + +# Отправить файл + Отправляет файл в чат + + + +`Функция ОтправитьФайл(Знач Токен, Знач IDЧата, Знач Файл, Знач Текст = "", Знач ИмяФайла = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | + | Текст | --text | Строка | Подпись к файлу | + | ИмяФайла | --filename | Строка | Отображаемое имя файла | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Метод в документации API: [POST /messages/sendFile](https://teams.vk.com/botapi/#/messages/post_messages_sendFile) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + Текст = "Подпись к файлу"; + + Файл = "https://openintegrations.dev/test_data/document.docx"; // URL + ФайлПуть = ПолучитьИмяВременногоФайла("docx"); // Путь + + КопироватьФайл(Файл, ФайлПуть); + + ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл); + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, ФайлПуть, Текст); + + Результат = OPI_VKTeams.ОтправитьФайл(Токен, IDЧата, Файл, Текст, "ВажныйДокумент.docx"); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ОтправитьФайл --token %token% --chatid %chatid% --file %file% --text %text% --filename %filename% --parsemod %parsemod% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Send-text-message.md b/docs/ru/md/VKTeams/Message-sending/Send-text-message.md index 9e2b79ce66..82dfb43dac 100644 --- a/docs/ru/md/VKTeams/Message-sending/Send-text-message.md +++ b/docs/ru/md/VKTeams/Message-sending/Send-text-message.md @@ -1,62 +1,57 @@ ---- -sidebar_position: 1 ---- - -# Отправить текстовое сообщение - Отправляет текстовое сообщение в чат - - - -`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач IDЦитируемого = 0, Знач Клавиатура = "", Знач Разметка = "MarkdownV2") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | - | Текст | --text | Строка | Текст сообщения | - | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | - | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | - | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] - - Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "AoLI0egLWBSLR1Ngn2w"; - Текст = "Текст сообщения"; - - Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); - - IDЧата = "689203963@chat.agent"; - IDЦитируемого = "7402287649739767956"; - Текст = "Полужирный текст сообщения"; - Разметка = "HTML"; - - Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст, IDЦитируемого, , Разметка); -``` - - - -```sh title="Пример команды CLI" - - oint vkteams ОтправитьТекстовоеСообщение --token %token% --chatid %chatid% --text %text% --reply %reply% --keyboard %keyboard% --parsemod %parsemod% - -``` - -```json title="Результат" -{ - "msgId": "7401135795345555471", - "ok": true -} -``` +--- +sidebar_position: 1 +--- + +# Отправить текстовое сообщение + Отправляет текстовое сообщение в чат + + + +`Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач IDЦитируемого = 0, Знач Клавиатура = "", Знач Разметка = "MarkdownV2") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки сообщения | + | Текст | --text | Строка | Текст сообщения | + | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | + | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | + | Разметка | --parsemod | Строка | Вид разметки для текста сообщения: MarkdownV2 или HTML | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Можно упомянуть пользователя, добавив в текст его userId в следующем формате @[userId] + + Метод в документации API: [GET /messages/sendText](https://teams.vk.com/botapi/#/messages/get_messages_sendText) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "AoLI0egLWBSLR1Ngn2w"; + Текст = "Текст сообщения"; + + Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); + + IDЧата = "689203963@chat.agent"; + IDЦитируемого = "7402287649739767956"; + Текст = "Полужирный текст сообщения"; + Разметка = "HTML"; + + Результат = OPI_VKTeams.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст, IDЦитируемого, , Разметка); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ОтправитьТекстовоеСообщение --token %token% --chatid %chatid% --text %text% --reply %reply% --keyboard %keyboard% --parsemod %parsemod% + +``` + + diff --git a/docs/ru/md/VKTeams/Message-sending/Send-voice.md b/docs/ru/md/VKTeams/Message-sending/Send-voice.md index 8c7da88f82..f6c7bbc3a6 100644 --- a/docs/ru/md/VKTeams/Message-sending/Send-voice.md +++ b/docs/ru/md/VKTeams/Message-sending/Send-voice.md @@ -1,62 +1,62 @@ ---- -sidebar_position: 3 ---- - -# Отправить голосовое сообщение - Отправляет аудиофайл в качестве голосового сообщения - - - -`Функция ОтправитьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач Файл, Знач ТипФайла = "m4a", Знач IDЦитируемого = 0, Знач Клавиатура = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Токен | --token | Строка | Токен бота | - | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | - | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | - | ТипФайла | --type | Строка | Тип аудиофайла: aac, ogg или m4a | - | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | - | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams - -
- -:::tip -Если вы хотите, чтобы клиент отображал этот файл как воспроизводимое голосовое сообщение, он должен быть в формате aac, ogg или m4a - - Метод в документации API: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) -::: -
- - -```bsl title="Пример кода" - Токен = "001.3501506236.091..."; - IDЧата = "689203963@chat.agent"; - IDЦитируемого = "7402287649739767956"; - Текст = "Подпись к файлу"; - - Файл = "https://openintegrations.dev/test_data/song.m4a" ; // URL - ФайлПуть = ПолучитьИмяВременногоФайла("m4a"); // Путь - - КопироватьФайл(Файл, ФайлПуть); - - ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлПуть, ,IDЦитируемого); - - Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); -``` - - - -```sh title="Пример команды CLI" - -oint vkteams ОтправитьГолосовоеСообщение --token "001.3501506236.091..." --chatid "689203963@chat.agent" --file "https://openintegrations.dev/test_data/song.m4a" --type %type% --reply "7401868177463836806" --keyboard %keyboard% - -``` - - +--- +sidebar_position: 3 +--- + +# Отправить голосовое сообщение + Отправляет аудиофайл в качестве голосового сообщения + + + +`Функция ОтправитьГолосовоеСообщение(Знач Токен, Знач IDЧата, Знач Файл, Знач ТипФайла = "m4a", Знач IDЦитируемого = 0, Знач Клавиатура = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Токен | --token | Строка | Токен бота | + | IDЧата | --chatid | Строка, Число | ID чата для отправки файла | + | Файл | --file | ДвоичныеДанные, Строка | Файл для отправки | + | ТипФайла | --type | Строка | Тип аудиофайла: aac, ogg или m4a | + | IDЦитируемого | --reply | Строка, Число | ID цитируемого сообщения, если необходимо | + | Клавиатура | --keyboard | Массив Из Строка | Кнопки к сообщению, если необходимо | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK Teams + +
+ +:::tip +Если вы хотите, чтобы клиент отображал этот файл как воспроизводимое голосовое сообщение, он должен быть в формате aac, ogg или m4a + + Метод в документации API: [POST /messages/sendVoice](https://teams.vk.com/botapi/#/messages/post_messages_sendVoice) +::: +
+ + +```bsl title="Пример кода" + Токен = "001.3501506236.091..."; + IDЧата = "689203963@chat.agent"; + IDЦитируемого = "7402287649739767956"; + Текст = "Подпись к файлу"; + + Файл = "https://openintegrations.dev/test_data/song.m4a" ; // URL + ФайлПуть = ПолучитьИмяВременногоФайла("m4a"); // Путь + + КопироватьФайл(Файл, ФайлПуть); + + ФайлДД = Новый ДвоичныеДанные(ФайлПуть); // Двоичные + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, ФайлПуть, ,IDЦитируемого); + + Результат = OPI_VKTeams.ОтправитьГолосовоеСообщение(Токен, IDЧата, Файл); +``` + + + +```sh title="Пример команды CLI" + + oint vkteams ОтправитьГолосовоеСообщение --token "001.3501506236.091..." --chatid "689203963@chat.agent" --file "https://openintegrations.dev/test_data/song.m4a" --type %type% --reply "7401868177463836806" --keyboard %keyboard% + +``` + + diff --git a/service/tests_set.json b/service/tests_set.json index b7d866bef0..526077e561 100644 --- a/service/tests_set.json +++ b/service/tests_set.json @@ -1,4 +1,241 @@ { +"Dropbox_ПолучитьСсылкуАвторизации": false, +"Dropbox_ПолучитьТокен": false, +"Dropbox_ОбновитьТокен": false, +"Dropbox_ПолучитьИнформациюОбАккаунте": false, +"Dropbox_ПолучитьДанныеИспользованияПространства": false, +"Dropbox_ПолучитьИнформациюОбОбъекте": false, +"Dropbox_ПолучитьСписокФайловПапки": false, +"Dropbox_ПолучитьПревью": false, +"Dropbox_ЗагрузитьФайл": false, +"Dropbox_ЗагрузитьФайлПоURL": false, +"Dropbox_ПолучитьСтатусЗагрузкиПоURL": false, +"Dropbox_УдалитьОбъект": false, +"Dropbox_КопироватьОбъект": false, +"Dropbox_ПереместитьОбъект": false, +"Dropbox_СоздатьПапку": false, +"Dropbox_СкачатьФайл": false, +"Dropbox_СкачатьПапку": false, +"Dropbox_ПолучитьСписокВерсийОбъекта": false, +"Dropbox_ВосстановитьОбъектКВерсии": false, +"Dropbox_ПолучитьСписокТегов": false, +"Dropbox_ДобавитьТег": false, +"Dropbox_УдалитьТег": false, +"Dropbox_ОпубликоватьПапку": false, +"Dropbox_ОтменитьПубликациюПапки": false, +"Dropbox_ДобавитьПользователейКФайлу": false, +"Dropbox_ДобавитьПользователейКПапке": false, +"Dropbox_ПолучитьСтатусАсинхронногоИзменения": false, +"Dropbox_ОтменитьПубликациюФайла": false, +"Twitter_ПолучитьСсылкуАвторизации": false, +"Twitter_ПолучитьТокен": false, +"Twitter_ОбновитьТокен": false, +"Twitter_ОбработкаВходящегоЗапросаПослеАвторизации": false, +"Twitter_СоздатьПроизвольныйТвит": false, +"Twitter_СоздатьТекстовыйТвит": false, +"Twitter_СоздатьТвитКартинки": false, +"Twitter_СоздатьТвитГифки": false, +"Twitter_СоздатьТвитВидео": false, +"Twitter_СоздатьТвитОпрос": false, +"Twitter_ЗагрузитьМассивВложений": false, +"Bitrix24_ПолучитьСсылкуАвторизацииПриложения": false, +"Bitrix24_ПолучитьТокен": false, +"Bitrix24_ОбновитьТокен": false, +"Bitrix24_СерверноеВремя": false, +"Bitrix24_СоздатьНовость": false, +"Bitrix24_ИзменитьНовость": false, +"Bitrix24_УдалитьНовость": false, +"Bitrix24_ПолучитьСписокПросмотревшихВажное": false, +"Bitrix24_ПолучитьНовости": false, +"Bitrix24_ДобавитьКомментарийНовости": false, +"Bitrix24_ДобавитьПолучателейКНовости": false, +"Bitrix24_ПолучитьЗадачу": false, +"Bitrix24_ПолучитьСписокЗадач": false, +"Bitrix24_СоздатьЗадачу": false, +"Bitrix24_ИзменитьЗадачу": false, +"Bitrix24_УдалитьЗадачу": false, +"Bitrix24_ДобавитьФайлВЗадачу": false, +"Bitrix24_ПринятьЗадачу": false, +"Bitrix24_ОтклонитьЗадачу": false, +"Bitrix24_ЗавершитьЗадачу": false, +"Bitrix24_ВозобновитьЗадачу": false, +"Bitrix24_ОтложитьЗадачу": false, +"Bitrix24_ПриостановитьЗадачу": false, +"Bitrix24_НачатьВыполнениеЗадачи": false, +"Bitrix24_НачатьНаблюдатьЗаЗадачей": false, +"Bitrix24_ПрекратитьНаблюдатьЗаЗадачей": false, +"Bitrix24_ДелегироватьЗадачу": false, +"Bitrix24_ДобавитьЗадачуВИзбранное": false, +"Bitrix24_УбратьЗадачуИзИзбранного": false, +"Bitrix24_ПолучитьИсториюЗадачи": false, +"Bitrix24_ПроверитьДоступКЗадаче": false, +"Bitrix24_ОтключитьЗвукЗадачи": false, +"Bitrix24_ВключитьЗвукЗадачи": false, +"Bitrix24_СоздатьЗависимостьЗадач": false, +"Bitrix24_УдалитьЗависимостьЗадач": false, +"Bitrix24_ПолучитьПланЗадачНаДень": false, +"Bitrix24_ПолучитьСтруктуруЗадачи": false, +"Bitrix24_ПолучитьСтруктуруФильтраЗадач": false, +"Bitrix24_ПолучитьСписокПользовательскихПолейЗадачи": false, +"Bitrix24_ДобавитьПользовательскоеПолеЗадачи": false, +"Bitrix24_ИзменитьПользовательскоеПолеЗадачи": false, +"Bitrix24_ПолучитьПользовательскоеПолеЗадачи": false, +"Bitrix24_УдалитьПользовательскоеПолеЗадачи": false, +"Bitrix24_ДобавитьЭлементЧеклистаЗадачи": false, +"Bitrix24_ИзменитьЭлементЧеклистаЗадачи": false, +"Bitrix24_УдалитьЭлементЧеклистаЗадачи": false, +"Bitrix24_ПолучитьЧеклистЗадачи": false, +"Bitrix24_ПолучитьЭлементЧеклистаЗадачи": false, +"Bitrix24_ВыполнитьЭлементЧеклистаЗадачи": false, +"Bitrix24_ВозобновитьЭлементЧеклистаЗадачи": false, +"Bitrix24_ПолучитьСписокКомментариевЗадачи": false, +"Bitrix24_ПолучитьКомменатрийЗадачи": false, +"Bitrix24_ДобавитьКомментарийЗадачи": false, +"Bitrix24_ИзменитьКомментарийЗадачи": false, +"Bitrix24_УдалитьКомментарийЗадачи": false, +"Bitrix24_ПолучитьСписокРезультатов": false, +"Bitrix24_СоздатьРезультатИзКомментария": false, +"Bitrix24_УдалитьРезультатИзКомментария": false, +"Bitrix24_ПолучитьСтруктуруКомментария": false, +"Bitrix24_ДобавитьСтадиюКанбана": false, +"Bitrix24_ИзменитьСтадиюКанбана": false, +"Bitrix24_УдалитьСтадиюКанбана": false, +"Bitrix24_ПолучитьСтадииКанбана": false, +"Bitrix24_ПеренестиЗадачуВСтадиюКанбана": false, +"Bitrix24_ДобавитьТрудозатратыЗадачи": false, +"Bitrix24_УдалитьТрудозатратыЗадачи": false, +"Bitrix24_ПолучитьСписокТрудозатратЗадачи": false, +"Bitrix24_ПолучитьТрудозатратыЗадачи": false, +"Bitrix24_ИзменитьТрудозатратыЗадачи": false, +"Bitrix24_НачатьУчетВремени": false, +"Bitrix24_ЗавершитьУчетВремени": false, +"Bitrix24_ПриостановитьУчетВремени": false, +"Bitrix24_ПолучитьСтатусУчетаВремени": false, +"Bitrix24_ПолучитьНастройкиУчетаВремени": false, +"Bitrix24_ПолучитьСписокХранилищ": false, +"Bitrix24_ПолучитьХранилищеПриложения": false, +"Bitrix24_ПолучитьХранилище": false, +"Bitrix24_ПереименоватьХранилище": false, +"Bitrix24_ПолучитьСодержимоеХранилища": false, +"Bitrix24_СоздатьКаталогВХранилище": false, +"Bitrix24_ПолучитьИнформациюОКаталоге": false, +"Bitrix24_СоздатьПодкаталог": false, +"Bitrix24_СкопироватьКаталог": false, +"Bitrix24_ПереместитьКаталог": false, +"Bitrix24_УдалитьКаталог": false, +"Bitrix24_ПолучитьВнешнююСсылкуКаталога": false, +"Bitrix24_ПолучитьДочерниеЭлементыКаталога": false, +"Bitrix24_ПоместитьКаталогВКорзину": false, +"Bitrix24_ВосстановитьКаталог": false, +"Bitrix24_ПереименоватьКаталог": false, +"Bitrix24_ПолучитьСтруктуруФильтраКаталога": false, +"Bitrix24_ЗагрузитьФайлВХранилище": false, +"Bitrix24_ЗагрузитьФайлВКаталог": false, +"Bitrix24_ПолучитьИнформациюОФайле": false, +"Bitrix24_УдалитьФайл": false, +"Bitrix24_ПолучитьВнешнююСсылкуФайла": false, +"Bitrix24_ПоместитьФайлВКорзину": false, +"Bitrix24_ВосстановитьФайл": false, +"Bitrix24_СкопироватьФайл": false, +"Bitrix24_ПереместитьФайлВКаталог": false, +"Bitrix24_ПереименоватьФайл": false, +"Bitrix24_СоздатьЧат": false, +"Bitrix24_ПолучитьСписокПользователейЧата": false, +"Bitrix24_ПокинутьЧат": false, +"Bitrix24_ПолучитьПользователей": false, +"Bitrix24_ДобавитьПользователейВЧат": false, +"Bitrix24_ИсключитьПользователяИзЧата": false, +"Bitrix24_ИзменитьЗаголовокЧата": false, +"Bitrix24_ИзменитьЦветЧата": false, +"Bitrix24_ИзменитьКартинкуЧата": false, +"Bitrix24_СменитьВладельцаЧата": false, +"Bitrix24_ОтключитьУведомленияЧата": false, +"Bitrix24_ВключитьУведомленияЧата": false, +"Bitrix24_ПолучитьСписокСообщенийЧата": false, +"Bitrix24_ПолучитьДиалог": false, +"Bitrix24_ПолучитьСписокПользователейДиалога": false, +"Bitrix24_ОтправитьУведомлениеОВводе": false, +"Bitrix24_ПолучитьСтатусПользователя": false, +"Bitrix24_УстановитьСтатусПользователя": false, +"Bitrix24_ПрочитатьВсе": false, +"Bitrix24_ПолучитьКаталогФайловЧата": false, +"Bitrix24_ПолучитьСтруктуруЧата": false, +"Bitrix24_ОтправитьСообщение": false, +"Bitrix24_ИзменитьСообщение": false, +"Bitrix24_УстановитьРеакциюНаСообщение": false, +"Bitrix24_УдалитьСообщение": false, +"Bitrix24_ОтправитьФайл": false, +"Bitrix24_ОтметитьСообщениеКакПрочитанное": false, +"Bitrix24_ОтметитьСообщениеКакНепрочитанное": false, +"Bitrix24_ПолучитьБлокКартинки": false, +"Bitrix24_ПолучитьБлокФайла": false, +"Bitrix24_СоздатьПерсональноеУведомление": false, +"Bitrix24_СоздатьСистемноеУведомление": false, +"Bitrix24_УдалитьУведомление": false, +"Bitrix24_СоздатьПодразделение": false, +"Bitrix24_ИзменитьПодразделение": false, +"Bitrix24_ПолучитьПодразделения": false, +"Bitrix24_УдалитьПодразделение": false, +"Bitrix24_ПолучитьТекущегоПользователя": false, +"Bitrix24_ПолучитьПользователя": false, +"Bitrix24_СоздатьПользователя": false, +"Bitrix24_ИзменитьПользователя": false, +"Bitrix24_ИзменитьСтатусПользователя": false, +"Bitrix24_НайтиПользователей": false, +"Bitrix24_ПолучитьСтурктуруПользователя": false, +"Bitrix24_ПолучитьСтруктуруФильтраПользователей": false, +"Yandex Disk_ПолучитьИнформациюОДиске": false, +"Yandex Disk_СоздатьПапку": false, +"Yandex Disk_ПолучитьОбъект": false, +"Yandex Disk_УдалитьОбъект": false, +"Yandex Disk_СоздатьКопиюОбъекта": false, +"Yandex Disk_ПолучитьСсылкуДляСкачивания": false, +"Yandex Disk_СкачатьФайл": false, +"Yandex Disk_ПолучитьСписокФайлов": false, +"Yandex Disk_ПереместитьОбъект": false, +"Yandex Disk_ЗагрузитьФайл": false, +"Yandex Disk_ЗагрузитьФайлПоURL": false, +"Yandex Disk_ОпубликоватьОбъект": false, +"Yandex Disk_ОтменитьПубликациюОбъекта": false, +"Yandex Disk_ПолучитьСписокОпубликованныхОбъектов": false, +"Yandex Disk_ПолучитьПубличныйОбъект": false, +"Yandex Disk_ПолучитьСсылкуСкачиванияПубличногоОбъекта": false, +"Yandex Disk_СохранитьПубличныйОбъектНаДиск": false, +"Telegram_ПолучитьИнформациюБота": false, +"Telegram_ПолучитьОбновления": false, +"Telegram_УстановитьWebhook": false, +"Telegram_УдалитьWebhook": false, +"Telegram_СкачатьФайл": false, +"Telegram_ОбработатьДанныеTMA": false, +"Telegram_ОтправитьТекстовоеСообщение": false, +"Telegram_ОтправитьКартинку": false, +"Telegram_ОтправитьВидео": false, +"Telegram_ОтправитьАудио": false, +"Telegram_ОтправитьДокумент": false, +"Telegram_ОтправитьГифку": false, +"Telegram_ОтправитьМедиагруппу": false, +"Telegram_ОтправитьМестоположение": false, +"Telegram_ОтправитьКонтакт": false, +"Telegram_ОтправитьОпрос": false, +"Telegram_ПереслатьСообщение": false, +"Telegram_СформироватьКлавиатуруПоМассивуКнопок": false, +"Telegram_Бан": false, +"Telegram_Разбан": false, +"Telegram_СоздатьСсылкуПриглашение": false, +"Telegram_ЗакрепитьСообщение": false, +"Telegram_ОткрепитьСообщение": false, +"Telegram_ПолучитьЧислоУчастников": false, +"Telegram_УдалитьСообщение": false, +"Telegram_ПолучитьСписокИконокАватаров": false, +"Telegram_СоздатьТемуФорума": false, +"Telegram_ИзменитьТемуФорума": false, +"Telegram_ЗакрытьТемуФорума": false, +"Telegram_ОткрытьТемуФорума": false, +"Telegram_УдалитьТемуФорума": false, +"Telegram_СкрытьГлавнуюТемуФорума": false, +"Telegram_ПоказатьГлавнуюТемуФорума": false, +"Telegram_ИзменитьИмяГлавнойТемыФорума": false, +"Telegram_ОчиститьСписокЗакрепленныхСообщенийТемы": false, "Airtable_ПолучитьСписокБаз": false, "Airtable_ПолучитьТаблицыБазы": false, "Airtable_СоздатьБазу": false, @@ -22,180 +259,32 @@ "Airtable_СоздатьКомментарий": false, "Airtable_ИзменитьКомментарий": false, "Airtable_УдалитьКомментарий": false, -"Bitrix24_ПолучитьСсылкуАвторизацииПриложения": true, -"Bitrix24_ПолучитьТокен": true, -"Bitrix24_ОбновитьТокен": true, -"Bitrix24_СерверноеВремя": true, -"Bitrix24_СоздатьНовость": true, -"Bitrix24_ИзменитьНовость": true, -"Bitrix24_УдалитьНовость": true, -"Bitrix24_ПолучитьСписокПросмотревшихВажное": true, -"Bitrix24_ПолучитьНовости": true, -"Bitrix24_ДобавитьКомментарийНовости": true, -"Bitrix24_ДобавитьПолучателейКНовости": true, -"Bitrix24_ПолучитьЗадачу": true, -"Bitrix24_ПолучитьСписокЗадач": true, -"Bitrix24_СоздатьЗадачу": true, -"Bitrix24_ИзменитьЗадачу": true, -"Bitrix24_УдалитьЗадачу": true, -"Bitrix24_ДобавитьФайлВЗадачу": true, -"Bitrix24_ПринятьЗадачу": true, -"Bitrix24_ОтклонитьЗадачу": true, -"Bitrix24_ЗавершитьЗадачу": true, -"Bitrix24_ВозобновитьЗадачу": true, -"Bitrix24_ОтложитьЗадачу": true, -"Bitrix24_ПриостановитьЗадачу": true, -"Bitrix24_НачатьВыполнениеЗадачи": true, -"Bitrix24_НачатьНаблюдатьЗаЗадачей": true, -"Bitrix24_ПрекратитьНаблюдатьЗаЗадачей": true, -"Bitrix24_ДелегироватьЗадачу": true, -"Bitrix24_ДобавитьЗадачуВИзбранное": true, -"Bitrix24_УбратьЗадачуИзИзбранного": true, -"Bitrix24_ПолучитьИсториюЗадачи": true, -"Bitrix24_ПроверитьДоступКЗадаче": true, -"Bitrix24_ОтключитьЗвукЗадачи": true, -"Bitrix24_ВключитьЗвукЗадачи": true, -"Bitrix24_СоздатьЗависимостьЗадач": true, -"Bitrix24_УдалитьЗависимостьЗадач": false, -"Bitrix24_ПолучитьПланЗадачНаДень": true, -"Bitrix24_ПолучитьСтруктуруЗадачи": true, -"Bitrix24_ПолучитьСтруктуруФильтраЗадач": false, -"Bitrix24_ПолучитьСписокПользовательскихПолейЗадачи": true, -"Bitrix24_ДобавитьПользовательскоеПолеЗадачи": true, -"Bitrix24_ИзменитьПользовательскоеПолеЗадачи": true, -"Bitrix24_ПолучитьПользовательскоеПолеЗадачи": true, -"Bitrix24_УдалитьПользовательскоеПолеЗадачи": true, -"Bitrix24_ДобавитьЭлементЧеклистаЗадачи": true, -"Bitrix24_ИзменитьЭлементЧеклистаЗадачи": true, -"Bitrix24_УдалитьЭлементЧеклистаЗадачи": true, -"Bitrix24_ПолучитьЧеклистЗадачи": true, -"Bitrix24_ПолучитьЭлементЧеклистаЗадачи": true, -"Bitrix24_ВыполнитьЭлементЧеклистаЗадачи": true, -"Bitrix24_ВозобновитьЭлементЧеклистаЗадачи": true, -"Bitrix24_ПолучитьСписокКомментариевЗадачи": true, -"Bitrix24_ПолучитьКомменатрийЗадачи": true, -"Bitrix24_ДобавитьКомментарийЗадачи": true, -"Bitrix24_ИзменитьКомментарийЗадачи": true, -"Bitrix24_УдалитьКомментарийЗадачи": true, -"Bitrix24_ПолучитьСписокРезультатов": true, -"Bitrix24_СоздатьРезультатИзКомментария": true, -"Bitrix24_УдалитьРезультатИзКомментария": true, -"Bitrix24_ПолучитьСтруктуруКомментария": false, -"Bitrix24_ДобавитьСтадиюКанбана": true, -"Bitrix24_ИзменитьСтадиюКанбана": true, -"Bitrix24_УдалитьСтадиюКанбана": true, -"Bitrix24_ПолучитьСтадииКанбана": true, -"Bitrix24_ПеренестиЗадачуВСтадиюКанбана": true, -"Bitrix24_ДобавитьТрудозатратыЗадачи": true, -"Bitrix24_УдалитьТрудозатратыЗадачи": true, -"Bitrix24_ПолучитьСписокТрудозатратЗадачи": true, -"Bitrix24_ПолучитьТрудозатратыЗадачи": true, -"Bitrix24_ИзменитьТрудозатратыЗадачи": true, -"Bitrix24_НачатьУчетВремени": true, -"Bitrix24_ЗавершитьУчетВремени": true, -"Bitrix24_ПриостановитьУчетВремени": true, -"Bitrix24_ПолучитьСтатусУчетаВремени": true, -"Bitrix24_ПолучитьНастройкиУчетаВремени": true, -"Bitrix24_ПолучитьСписокХранилищ": true, -"Bitrix24_ПолучитьХранилищеПриложения": true, -"Bitrix24_ПолучитьХранилище": true, -"Bitrix24_ПереименоватьХранилище": true, -"Bitrix24_ПолучитьСодержимоеХранилища": true, -"Bitrix24_СоздатьКаталогВХранилище": true, -"Bitrix24_ПолучитьИнформациюОКаталоге": true, -"Bitrix24_СоздатьПодкаталог": true, -"Bitrix24_СкопироватьКаталог": true, -"Bitrix24_ПереместитьКаталог": true, -"Bitrix24_УдалитьКаталог": true, -"Bitrix24_ПолучитьВнешнююСсылкуКаталога": true, -"Bitrix24_ПолучитьДочерниеЭлементыКаталога": true, -"Bitrix24_ПоместитьКаталогВКорзину": true, -"Bitrix24_ВосстановитьКаталог": true, -"Bitrix24_ПереименоватьКаталог": true, -"Bitrix24_ПолучитьСтруктуруФильтраКаталога": true, -"Bitrix24_ЗагрузитьФайлВХранилище": true, -"Bitrix24_ЗагрузитьФайлВКаталог": true, -"Bitrix24_ПолучитьИнформациюОФайле": true, -"Bitrix24_УдалитьФайл": true, -"Bitrix24_ПолучитьВнешнююСсылкуФайла": true, -"Bitrix24_ПоместитьФайлВКорзину": true, -"Bitrix24_ВосстановитьФайл": true, -"Bitrix24_СкопироватьФайл": true, -"Bitrix24_ПереместитьФайлВКаталог": true, -"Bitrix24_ПереименоватьФайл": true, -"Bitrix24_СоздатьЧат": true, -"Bitrix24_ПолучитьСписокПользователейЧата": true, -"Bitrix24_ПокинутьЧат": true, -"Bitrix24_ПолучитьПользователей": true, -"Bitrix24_ДобавитьПользователейВЧат": true, -"Bitrix24_ИсключитьПользователяИзЧата": true, -"Bitrix24_ИзменитьЗаголовокЧата": true, -"Bitrix24_ИзменитьЦветЧата": true, -"Bitrix24_ИзменитьКартинкуЧата": true, -"Bitrix24_СменитьВладельцаЧата": true, -"Bitrix24_ОтключитьУведомленияЧата": true, -"Bitrix24_ВключитьУведомленияЧата": true, -"Bitrix24_ПолучитьСписокСообщенийЧата": true, -"Bitrix24_ПолучитьДиалог": true, -"Bitrix24_ПолучитьСписокПользователейДиалога": true, -"Bitrix24_ОтправитьУведомлениеОВводе": true, -"Bitrix24_ПолучитьСтатусПользователя": true, -"Bitrix24_УстановитьСтатусПользователя": true, -"Bitrix24_ПрочитатьВсе": true, -"Bitrix24_ПолучитьКаталогФайловЧата": true, -"Bitrix24_ПолучитьСтруктуруЧата": false, -"Bitrix24_ОтправитьСообщение": true, -"Bitrix24_ИзменитьСообщение": true, -"Bitrix24_УстановитьРеакциюНаСообщение": true, -"Bitrix24_УдалитьСообщение": true, -"Bitrix24_ОтправитьФайл": true, -"Bitrix24_ОтметитьСообщениеКакПрочитанное": true, -"Bitrix24_ОтметитьСообщениеКакНепрочитанное": true, -"Bitrix24_ПолучитьБлокКартинки": false, -"Bitrix24_ПолучитьБлокФайла": false, -"Bitrix24_СоздатьПерсональноеУведомление": true, -"Bitrix24_СоздатьСистемноеУведомление": true, -"Bitrix24_УдалитьУведомление": true, -"Bitrix24_СоздатьПодразделение": true, -"Bitrix24_ИзменитьПодразделение": true, -"Bitrix24_ПолучитьПодразделения": true, -"Bitrix24_УдалитьПодразделение": true, -"Bitrix24_ПолучитьТекущегоПользователя": true, -"Bitrix24_ПолучитьПользователя": true, -"Bitrix24_СоздатьПользователя": true, -"Bitrix24_ИзменитьПользователя": true, -"Bitrix24_ИзменитьСтатусПользователя": true, -"Bitrix24_НайтиПользователей": true, -"Bitrix24_ПолучитьСтурктуруПользователя": true, -"Bitrix24_ПолучитьСтруктуруФильтраПользователей": false, -"Dropbox_ПолучитьСсылкуАвторизации": true, -"Dropbox_ПолучитьТокен": true, -"Dropbox_ОбновитьТокен": true, -"Dropbox_ПолучитьИнформациюОбАккаунте": true, -"Dropbox_ПолучитьДанныеИспользованияПространства": true, -"Dropbox_ПолучитьИнформациюОбОбъекте": true, -"Dropbox_ПолучитьСписокФайловПапки": true, -"Dropbox_ПолучитьПревью": true, -"Dropbox_ЗагрузитьФайл": true, -"Dropbox_ЗагрузитьФайлПоURL": true, -"Dropbox_ПолучитьСтатусЗагрузкиПоURL": true, -"Dropbox_УдалитьОбъект": true, -"Dropbox_КопироватьОбъект": true, -"Dropbox_ПереместитьОбъект": true, -"Dropbox_СоздатьПапку": true, -"Dropbox_СкачатьФайл": true, -"Dropbox_СкачатьПапку": true, -"Dropbox_ПолучитьСписокВерсийОбъекта": true, -"Dropbox_ВосстановитьОбъектКВерсии": true, -"Dropbox_ПолучитьСписокТегов": true, -"Dropbox_ДобавитьТег": true, -"Dropbox_УдалитьТег": true, -"Dropbox_ОпубликоватьПапку": true, -"Dropbox_ОтменитьПубликациюПапки": true, -"Dropbox_ДобавитьПользователейКФайлу": true, -"Dropbox_ДобавитьПользователейКПапке": true, -"Dropbox_ПолучитьСтатусАсинхронногоИзменения": false, -"Dropbox_ОтменитьПубликациюФайла": true, +"Google Drive_ПолучитьИнформациюОбОбъекте": false, +"Google Drive_ПолучитьСписокКаталогов": false, +"Google Drive_ПолучитьСписокФайлов": false, +"Google Drive_ЗагрузитьФайл": false, +"Google Drive_СоздатьПапку": false, +"Google Drive_СкачатьФайл": false, +"Google Drive_СкопироватьОбъект": false, +"Google Drive_ОбновитьФайл": false, +"Google Drive_УдалитьОбъект": false, +"Google Drive_ПолучитьОписаниеФайла": false, +"Google Drive_СоздатьКомментарий": false, +"Google Drive_ПолучитьКомментарий": false, +"Google Drive_ПолучитьСписокКомментариев": false, +"Google Drive_УдалитьКомментарий": false, +"VKTeams_ПроверитьТокен": false, +"VKTeams_ПолучитьСобытия": false, +"VKTeams_ПолучитьИнформациюОФайле": false, +"VKTeams_ОтправитьТекстовоеСообщение": false, +"VKTeams_ОтправитьФайл": false, +"VKTeams_ОтправитьГолосовоеСообщение": false, +"VKTeams_ИзменитьТекстСообщения": false, +"VKTeams_УдалитьСообщение": false, +"VKTeams_ПереслатьФайл": false, +"VKTeams_ПереслатьГолосовоеСообщение": false, +"VKTeams_ПереслатьСообщение": false, +"VKTeams_ИсключитьПользователейЧата": false, "Google Calendar_СоздатьКалендарь": false, "Google Calendar_ПолучитьМетаданныеКалендаря": false, "Google Calendar_ИзменитьМетаданныеКалендаря": false, @@ -213,29 +302,6 @@ "Google Calendar_ПереместитьСобытие": false, "Google Calendar_ИзменитьСобытие": false, "Google Calendar_УдалитьСобытие": false, -"Google Drive_ПолучитьИнформациюОбОбъекте": false, -"Google Drive_ПолучитьСписокКаталогов": false, -"Google Drive_ПолучитьСписокФайлов": false, -"Google Drive_ЗагрузитьФайл": false, -"Google Drive_СоздатьПапку": false, -"Google Drive_СкачатьФайл": false, -"Google Drive_СкопироватьОбъект": false, -"Google Drive_ОбновитьФайл": false, -"Google Drive_УдалитьОбъект": false, -"Google Drive_ПолучитьОписаниеФайла": false, -"Google Drive_СоздатьКомментарий": false, -"Google Drive_ПолучитьКомментарий": false, -"Google Drive_ПолучитьСписокКомментариев": false, -"Google Drive_УдалитьКомментарий": false, -"Google Sheets_СоздатьКнигу": false, -"Google Sheets_ПолучитьКнигу": false, -"Google Sheets_ИзменитьНаименованиеКниги": false, -"Google Sheets_ДобавитьЛист": false, -"Google Sheets_УдалитьЛист": false, -"Google Sheets_КопироватьЛист": false, -"Google Sheets_УстановитьЗначенияЯчеек": false, -"Google Sheets_ОчиститьЯчейки": false, -"Google Sheets_ПолучитьЗначенияЯчеек": false, "Notion_СоздатьСтраницу": false, "Notion_СоздатьСтраницуВБазу": false, "Notion_ПолучитьСтраницу": false, @@ -249,6 +315,77 @@ "Notion_УдалитьБлок": false, "Notion_СписокПользователей": false, "Notion_ПолучитьДанныеПользователя": false, +"Viber_УстановитьWebhook": false, +"Viber_ПолучитьИнформациюОКанале": false, +"Viber_ПолучитьДанныеПользователя": false, +"Viber_ПолучитьОнлайнПользователей": false, +"Viber_ОтправитьТекстовоеСообщение": false, +"Viber_ОтправитьКартинку": false, +"Viber_ОтправитьФайл": false, +"Viber_ОтправитьКонтакт": false, +"Viber_ОтправитьЛокацию": false, +"Viber_ОтправитьСсылку": false, +"Viber_СформироватьКлавиатуруИзМассиваКнопок": false, +"Google Sheets_СоздатьКнигу": false, +"Google Sheets_ПолучитьКнигу": false, +"Google Sheets_ИзменитьНаименованиеКниги": false, +"Google Sheets_ДобавитьЛист": false, +"Google Sheets_УдалитьЛист": false, +"Google Sheets_КопироватьЛист": false, +"Google Sheets_УстановитьЗначенияЯчеек": false, +"Google Sheets_ОчиститьЯчейки": false, +"Google Sheets_ПолучитьЗначенияЯчеек": false, +"VK_СоздатьСсылкуПолученияТокена": false, +"VK_СоздатьПост": false, +"VK_СоздатьСоставнойПост": false, +"VK_УдалитьПост": false, +"VK_СоздатьОпрос": false, +"VK_СоздатьАльбом": false, +"VK_УдалитьАльбом": false, +"VK_СоздатьИсторию": false, +"VK_СохранитьКартинкуВАльбом": false, +"VK_УдалитьКартинку": false, +"VK_ЗагрузитьВидеоНаСервер": false, +"VK_ЗагрузитьФотоНаСервер": false, +"VK_СоздатьОбсуждение": false, +"VK_ЗакрытьОбсуждение": false, +"VK_ОткрытьОбсуждение": false, +"VK_НаписатьВОбсуждение": false, +"VK_ПоставитьЛайк": false, +"VK_СделатьРепост": false, +"VK_НаписатьСообщение": false, +"VK_НаписатьКомментарий": false, +"VK_СократитьСсылку": false, +"VK_ПолучитьСтатистику": false, +"VK_ПолучитьСтатистикуПостов": false, +"VK_СоздатьРекламнуюКампанию": false, +"VK_СоздатьРекламноеОбъявление": false, +"VK_ПриостановитьРекламноеОбъявление": false, +"VK_ПолучитьСписокРекламныхКатегорий": false, +"VK_ПолучитьСписокКатегорийТоваров": false, +"VK_ПолучитьСписокТоваров": false, +"VK_ПолучитьТоварыПоИД": false, +"VK_ДобавитьТовар": false, +"VK_ИзменитьТовар": false, +"VK_УдалитьТовар": false, +"VK_СгруппироватьТовары": false, +"VK_ПолучитьОписаниеТовара": false, +"VK_ПолучитьСписокПодборок": false, +"VK_ПолучитьПодборкиПоИД": false, +"VK_СоздатьПодборкуТоваров": false, +"VK_ИзменитьПодборкуТоваров": false, +"VK_ДобавитьТоварВПодборку": false, +"VK_УдалитьТоварИзПодборки": false, +"VK_УдалитьПодборку": false, +"VK_ПолучитьСписокСвойств": false, +"VK_СоздатьСвойствоТовара": false, +"VK_ИзменитьСвойствоТовара": false, +"VK_УдалитьСвойствоТовара": false, +"VK_ДобавитьВариантСвойстваТовара": false, +"VK_ИзменитьВариантСвойстваТовара": false, +"VK_УдалитьВариантСвойстваТовара": false, +"VK_ПолучитьСписокЗаказов": false, +"VK_СформироватьКлавиатуру": false, "Slack_ПолучитьИнформациюОБоте": false, "Slack_ПолучитьСписокРабочихОбластей": false, "Slack_ПолучитьСписокПользователей": false, @@ -285,147 +422,5 @@ "Slack_ДобавитьВнешнийФайл": false, "Slack_ОтправитьВнешнийФайл": false, "Slack_УдалитьВнешнийФайл": false, -"Slack_СформироватьБлокКартинку": false, -"Telegram_ПолучитьИнформациюБота": true, -"Telegram_ПолучитьОбновления": true, -"Telegram_УстановитьWebhook": true, -"Telegram_УдалитьWebhook": true, -"Telegram_СкачатьФайл": true, -"Telegram_ОбработатьДанныеTMA": false, -"Telegram_ОтправитьТекстовоеСообщение": true, -"Telegram_ОтправитьКартинку": true, -"Telegram_ОтправитьВидео": true, -"Telegram_ОтправитьАудио": true, -"Telegram_ОтправитьДокумент": true, -"Telegram_ОтправитьГифку": true, -"Telegram_ОтправитьМедиагруппу": false, -"Telegram_ОтправитьМестоположение": true, -"Telegram_ОтправитьКонтакт": true, -"Telegram_ОтправитьОпрос": true, -"Telegram_ПереслатьСообщение": true, -"Telegram_СформироватьКлавиатуруПоМассивуКнопок": false, -"Telegram_Бан": true, -"Telegram_Разбан": true, -"Telegram_СоздатьСсылкуПриглашение": true, -"Telegram_ЗакрепитьСообщение": true, -"Telegram_ОткрепитьСообщение": true, -"Telegram_ПолучитьЧислоУчастников": true, -"Telegram_УдалитьСообщение": true, -"Telegram_ПолучитьСписокИконокАватаров": false, -"Telegram_СоздатьТемуФорума": true, -"Telegram_ИзменитьТемуФорума": true, -"Telegram_ЗакрытьТемуФорума": true, -"Telegram_ОткрытьТемуФорума": true, -"Telegram_УдалитьТемуФорума": true, -"Telegram_СкрытьГлавнуюТемуФорума": true, -"Telegram_ПоказатьГлавнуюТемуФорума": true, -"Telegram_ИзменитьИмяГлавнойТемыФорума": true, -"Telegram_ОчиститьСписокЗакрепленныхСообщенийТемы": true, -"Twitter_ПолучитьСсылкуАвторизации": false, -"Twitter_ПолучитьТокен": false, -"Twitter_ОбновитьТокен": false, -"Twitter_ОбработкаВходящегоЗапросаПослеАвторизации": false, -"Twitter_СоздатьПроизвольныйТвит": false, -"Twitter_СоздатьТекстовыйТвит": false, -"Twitter_СоздатьТвитКартинки": false, -"Twitter_СоздатьТвитГифки": false, -"Twitter_СоздатьТвитВидео": false, -"Twitter_СоздатьТвитОпрос": false, -"Twitter_ЗагрузитьМассивВложений": false, -"Viber_УстановитьWebhook": false, -"Viber_ПолучитьИнформациюОКанале": false, -"Viber_ПолучитьДанныеПользователя": false, -"Viber_ПолучитьОнлайнПользователей": false, -"Viber_ОтправитьТекстовоеСообщение": false, -"Viber_ОтправитьКартинку": false, -"Viber_ОтправитьФайл": false, -"Viber_ОтправитьКонтакт": false, -"Viber_ОтправитьЛокацию": false, -"Viber_ОтправитьСсылку": false, -"Viber_СформироватьКлавиатуруИзМассиваКнопок": false, -"VK_СоздатьСсылкуПолученияТокена": true, -"VK_СоздатьПост": true, -"VK_СоздатьСоставнойПост": true, -"VK_УдалитьПост": true, -"VK_СоздатьОпрос": true, -"VK_СоздатьАльбом": true, -"VK_УдалитьАльбом": true, -"VK_СоздатьИсторию": true, -"VK_СохранитьКартинкуВАльбом": true, -"VK_УдалитьКартинку": true, -"VK_ЗагрузитьВидеоНаСервер": true, -"VK_ЗагрузитьФотоНаСервер": false, -"VK_СоздатьОбсуждение": true, -"VK_ЗакрытьОбсуждение": true, -"VK_ОткрытьОбсуждение": true, -"VK_НаписатьВОбсуждение": true, -"VK_ПоставитьЛайк": true, -"VK_СделатьРепост": true, -"VK_НаписатьСообщение": true, -"VK_НаписатьКомментарий": true, -"VK_СократитьСсылку": false, -"VK_ПолучитьСтатистику": true, -"VK_ПолучитьСтатистикуПостов": true, -"VK_СоздатьРекламнуюКампанию": true, -"VK_СоздатьРекламноеОбъявление": true, -"VK_ПриостановитьРекламноеОбъявление": true, -"VK_ПолучитьСписокРекламныхКатегорий": false, -"VK_ПолучитьСписокКатегорийТоваров": true, -"VK_ПолучитьСписокТоваров": true, -"VK_ПолучитьТоварыПоИД": true, -"VK_ДобавитьТовар": true, -"VK_ИзменитьТовар": true, -"VK_УдалитьТовар": true, -"VK_СгруппироватьТовары": true, -"VK_ПолучитьОписаниеТовара": false, -"VK_ПолучитьСписокПодборок": true, -"VK_ПолучитьПодборкиПоИД": false, -"VK_СоздатьПодборкуТоваров": true, -"VK_ИзменитьПодборкуТоваров": true, -"VK_ДобавитьТоварВПодборку": true, -"VK_УдалитьТоварИзПодборки": true, -"VK_УдалитьПодборку": true, -"VK_ПолучитьСписокСвойств": true, -"VK_СоздатьСвойствоТовара": true, -"VK_ИзменитьСвойствоТовара": true, -"VK_УдалитьСвойствоТовара": true, -"VK_ДобавитьВариантСвойстваТовара": true, -"VK_ИзменитьВариантСвойстваТовара": true, -"VK_УдалитьВариантСвойстваТовара": true, -"VK_ПолучитьСписокЗаказов": true, -"VK_СформироватьКлавиатуру": true, -"VKTeams_ПроверитьТокен": true, -"VKTeams_ПолучитьСобытия": true, -"VKTeams_ПолучитьИнформациюОФайле": true, -"VKTeams_ОтправитьТекстовоеСообщение": true, -"VKTeams_ОтправитьФайл": true, -"VKTeams_ОтправитьГолосовоеСообщение": true, -"VKTeams_ИзменитьТекстСообщения": true, -"VKTeams_УдалитьСообщение": true, -"VKTeams_ПереслатьФайл": true, -"VKTeams_ПереслатьГолосовоеСообщение": true, -"VKTeams_ПереслатьСообщение": true, -"Yandex Disk_ПолучитьИнформациюОДиске": false, -"Yandex Disk_СоздатьПапку": false, -"Yandex Disk_ПолучитьОбъект": false, -"Yandex Disk_УдалитьОбъект": false, -"Yandex Disk_СоздатьКопиюОбъекта": false, -"Yandex Disk_ПолучитьСсылкуДляСкачивания": false, -"Yandex Disk_СкачатьФайл": false, -"Yandex Disk_ПолучитьСписокФайлов": false, -"Yandex Disk_ПереместитьОбъект": false, -"Yandex Disk_ЗагрузитьФайл": false, -"Yandex Disk_ЗагрузитьФайлПоURL": false, -"Yandex Disk_ОпубликоватьОбъект": false, -"Yandex Disk_ОтменитьПубликациюОбъекта": false, -"Yandex Disk_ПолучитьСписокОпубликованныхОбъектов": false, -"Yandex Disk_ПолучитьПубличныйОбъект": false, -"Yandex Disk_ПолучитьСсылкуСкачиванияПубличногоОбъекта": false, -"Yandex Disk_СохранитьПубличныйОбъектНаДиск": false, -"Telegram_ОтправитьМеидагруппу": true, -"Telegram_ПолучитьСписокАватаровФорума": true, -"VK_СоздатьТоварСоСвойством": true, -"YandexDisk_ПолучитьИнформациюОДиске": true, -"YandexDisk_СоздатьПапку": true, -"VKTeams_ИсключитьПользователейЧата": true +"Slack_СформироватьБлокКартинку": false } \ No newline at end of file