From ccc1aeff0b659881299965d64be5a8be7172627a Mon Sep 17 00:00:00 2001 From: Anton Titovets Date: Wed, 10 Jul 2024 11:59:55 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=BF=D0=BE=D0=BB=D0=BD=D0=B5?= =?UTF-8?q?=D0=BD=D0=B8=D0=B5=20=D0=B4=D0=BE=D0=BA=D0=BE=D0=B2=20=D0=BF?= =?UTF-8?q?=D0=BE=20B24?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/os/docs_examples.os | 7 +- .github/workflows/os/docs_main.os | 65 +- .github/workflows/os/template.md | 18 +- .../Comment-management/Create-comment.md | 15 +- .../Comment-management/Delete-comment.md | 15 +- .../Comment-management/Edit-comment.md | 15 +- .../Comment-management/Get-comments.md | 15 +- .../Record-management/Create-posts.md | 15 +- .../Record-management/Delete-posts.md | 15 +- .../Record-management/Get-list-of-records.md | 15 +- .../Airtable/Record-management/Get-record.md | 15 +- .../Airtable/Table-management/Create-table.md | 15 +- .../Airtable/Table-management/Modify-table.md | 15 +- .../Working-with-databases/Create-database.md | 15 +- .../Get-database-tables.md | 15 +- .../Get-list-of-bases.md | 15 +- .../Working-with-fields/Create-field.md | 15 +- .../Get-attachment-field.md | 15 +- .../Working-with-fields/Get-checkbox-field.md | 15 +- .../Working-with-fields/Get-date-field.md | 15 +- .../Working-with-fields/Get-email-field.md | 15 +- .../Working-with-fields/Get-link-field.md | 15 +- .../Working-with-fields/Get-number-field.md | 15 +- .../Working-with-fields/Get-phone-field.md | 15 +- .../Working-with-fields/Get-string-field.md | 15 +- .../Working-with-fields/Modify-field.md | 15 +- .../Add-task-comment.md | 67 +++ .../Create-result-from-comment.md | 73 +++ .../Delete-result-from-comment.md | 62 ++ .../Delete-task-comment.md | 64 ++ .../Get-comment-structure.md | 33 ++ .../Get-results-list.md | 86 +++ .../Get-task-comment.md | 72 +++ .../Get-task-comments-list.md | 80 +++ .../Update-task-comment.md | 69 +++ .../_category_.json | 4 + .../Feed-posts-managment/Add-post-comment.md | 64 ++ .../Add-post-recipients.md | 15 +- .../Feed-posts-managment/Create-post.md | 17 +- .../Feed-posts-managment/Delete-post.md | 15 +- .../Get-important-post-viewers.md | 15 +- .../Feed-posts-managment/Get-posts.md | 15 +- .../Feed-posts-managment/Update-post.md | 15 +- .../en/md/Bitrix24/Kanban/Add-kanban-stage.md | 71 +++ .../md/Bitrix24/Kanban/Delete-kanban-stage.md | 65 ++ .../md/Bitrix24/Kanban/Get-kanban-stages.md | 554 ++++++++++++++++++ .../Kanban/Move-task-to-kanban-stage.md | 68 +++ docs/en/md/Bitrix24/Kanban/_category_.json | 4 + .../Get-app-auth-link.md | 18 +- .../Settings-and-administartion/Get-token.md | 15 +- .../Refresh-token.md | 15 +- .../Server-time.md | 15 +- .../Create-storage-folder.md | 15 +- .../Create-subfolder.md | 82 +++ .../Delete-file.md | 17 +- .../Delete-folder.md | 17 +- .../Get-app-sotrage.md | 15 +- .../Get-file-external-link.md | 61 ++ .../Get-file-information.md | 80 +++ .../Get-folder-external-link.md | 61 ++ .../Get-folder-filter-structure.md | 59 ++ .../Get-folder-information.md | 77 +++ .../Get-folder-items.md | 98 ++++ .../Get-storage-objects.md | 15 +- .../Get-storage.md | 15 +- .../Get-storages-list.md | 15 +- .../Make-file-copy.md | 87 +++ .../Make-folder-copy.md | 85 +++ .../Mark-file-as-deleted.md | 80 +++ .../Mark-folder-as-deleted.md | 77 +++ .../Move-file-to-folder.md | 87 +++ .../Move-folder.md | 84 +++ .../Rename-file.md | 85 +++ .../Rename-folder.md | 82 +++ .../Rename-storage.md | 15 +- .../Restore-file.md | 80 +++ .../Restore-folder.md | 77 +++ .../Upload-file-to-folder.md | 80 +++ .../Upload-file-to-storage.md | 15 +- .../_category_.json | 2 +- .../Tasks-managment/Add-task-to-favorites.md | 15 +- .../Bitrix24/Tasks-managment/Approve-task.md | 15 +- .../Tasks-managment/Attach-file-to-topic.md | 66 +++ .../Tasks-managment/Check-task-accesses.md | 126 ++++ .../Bitrix24/Tasks-managment/Complete-task.md | 15 +- .../Bitrix24/Tasks-managment/Create-task.md | 19 +- .../Create-tasks-dependencies.md | 70 +++ .../md/Bitrix24/Tasks-managment/Defer-task.md | 15 +- .../Bitrix24/Tasks-managment/Delegate-task.md | 15 +- .../Bitrix24/Tasks-managment/Delete-task.md | 17 +- .../Delete-tasks-dependencies.md | 37 ++ .../Tasks-managment/Disapprove-task.md | 15 +- .../Get-task-fields-structure.md | 17 +- .../Tasks-managment/Get-task-history.md | 15 +- .../md/Bitrix24/Tasks-managment/Get-task.md | 17 +- .../Get-tasks-filter-structure.md | 16 +- .../Tasks-managment/Get-tasks-list.md | 17 +- .../md/Bitrix24/Tasks-managment/Mute-task.md | 192 ++++++ .../md/Bitrix24/Tasks-managment/Pause-task.md | 15 +- .../Remove-task-from-favorites.md | 15 +- .../md/Bitrix24/Tasks-managment/Renew-task.md | 15 +- .../md/Bitrix24/Tasks-managment/Start-task.md | 15 +- .../Tasks-managment/Start-watching-task.md | 15 +- .../Tasks-managment/Stop-watching-task.md | 15 +- .../Bitrix24/Tasks-managment/Unmute-task.md | 192 ++++++ .../Bitrix24/Tasks-managment/Update-task.md | 17 +- .../Get-account-information.md | 17 +- .../Get-authorization-link.md | 15 +- .../Get-space-usage-data.md | 15 +- .../Account-and-authorization/Get-token.md | 15 +- .../Refresh-token.md | 15 +- .../Copy-object.md | 15 +- .../Create-folder.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 15 +- .../Download-folder.md | 15 +- .../Get-list-of-folder-files.md | 13 +- .../Get-object-information.md | 15 +- .../Get-object-version-list.md | 15 +- .../Get-preview.md | 15 +- .../Get-upload-status-by-url.md | 15 +- .../Move-object.md | 15 +- .../Restore-object-to-version.md | 15 +- .../Upload-file-by-url.md | 15 +- .../Upload-file.md | 15 +- .../Add-users-to-file.md | 15 +- .../Add-users-to-folder.md | 15 +- .../Cancel-file-publication.md | 15 +- .../Cancel-folder-publication.md | 15 +- .../Get-asynchronous-change-status.md | 14 +- .../Shared-access-settings/Publish-folder.md | 15 +- docs/en/md/Dropbox/Tags-managment/Add-tag.md | 15 +- .../md/Dropbox/Tags-managment/Delete-tag.md | 15 +- .../md/Dropbox/Tags-managment/Get-tag-list.md | 15 +- .../Add-calendar-to-list.md | 15 +- .../Delete-calendar-from-list.md | 15 +- .../Edit-list-calendar.md | 15 +- .../Get-calendar-list.md | 15 +- .../Get-list-calendar.md | 15 +- .../Clear-main-calendar.md | 15 +- .../Create-calendar.md | 15 +- .../Delete-calendar.md | 15 +- .../Edit-calendar-metadata.md | 15 +- .../Get-calendar-metadata.md | 15 +- .../Event-management/Create-event.md | 15 +- .../Event-management/Delete-event.md | 15 +- .../Event-management/Edit-event.md | 15 +- .../Event-management/Get-event-description.md | 14 +- .../Event-management/Get-event-list.md | 15 +- .../Event-management/Get-event.md | 15 +- .../Event-management/Move-event.md | 15 +- .../Comment-management/Create-comment.md | 15 +- .../Comment-management/Delete-comment.md | 15 +- .../Comment-management/Get-comment-list.md | 15 +- .../Comment-management/Get-comment.md | 15 +- .../Copy-object.md | 15 +- .../Create-folder.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 13 +- .../Get-directories-list.md | 15 +- .../Get-file-description.md | 15 +- .../Get-files-list.md | 15 +- .../Get-object-information.md | 15 +- .../Update-file.md | 15 +- .../Upload-file.md | 15 +- .../Data-managment/Clear-cells.md | 15 +- .../Data-managment/Get-cell-values.md | 15 +- .../Data-managment/Set-cell-values.md | 15 +- .../Create-spreadsheet.md | 15 +- .../Edit-spreadsheet-title.md | 19 +- .../Spreadsheets-managment/Get-spreadsheet.md | 17 +- .../Working-with-sheets/Add-sheet.md | 15 +- .../Working-with-sheets/Copy-sheet.md | 15 +- .../Working-with-sheets/Delete-sheet.md | 15 +- .../Notion/Blocks-managment/Create-block.md | 15 +- .../Notion/Blocks-managment/Delete-block.md | 15 +- .../Notion/Blocks-managment/Return-block.md | 15 +- .../Blocks-managment/Return-child-blocks.md | 15 +- .../Database-management/Create-database.md | 15 +- .../Edit-database-properties.md | 15 +- .../Database-management/Get-database.md | 15 +- .../Create-page-in-database.md | 15 +- .../md/Notion/Page-management/Create-page.md | 15 +- .../Page-management/Edit-page-properties.md | 15 +- docs/en/md/Notion/Page-management/Get-page.md | 15 +- docs/en/md/Notion/Users/Get-user-data.md | 15 +- docs/en/md/Notion/Users/User-list.md | 15 +- .../Block-formation/Generate-image-block.md | 15 +- .../Channel-management/Archive-channel.md | 15 +- .../Channel-management/Create-channel.md | 15 +- .../Channel-management/Get-channel-history.md | 15 +- .../Channel-management/Get-channel-list.md | 15 +- .../Get-channel-user-list.md | 15 +- .../Slack/Channel-management/Get-channel.md | 15 +- .../Invite-users-to-channel.md | 15 +- .../Slack/Channel-management/Join-channel.md | 15 +- .../Kick-user-from-channel.md | 15 +- .../Slack/Channel-management/Leave-channel.md | 15 +- .../Channel-management/Rename-channel.md | 15 +- .../Channel-management/Set-channel-goal.md | 15 +- .../Channel-management/Set-channel-topic.md | 15 +- .../Slack/Dialog-management/Close-dialog.md | 15 +- .../md/Slack/Dialog-management/Open-dialog.md | 15 +- .../Add-external-file.md | 15 +- .../Delete-external-file.md | 15 +- .../Get-external-file-list.md | 15 +- .../Get-external-file.md | 15 +- .../Send-external-file.md | 15 +- .../en/md/Slack/File-managment/Delete-file.md | 15 +- .../md/Slack/File-managment/Get-file-data.md | 15 +- .../md/Slack/File-managment/Get-files-list.md | 15 +- .../Slack/File-managment/Make-file-private.md | 14 +- .../Slack/File-managment/Make-file-public.md | 14 +- .../en/md/Slack/File-managment/Upload-file.md | 15 +- .../Get-bot-information.md | 15 +- .../Management-and-settings/Get-user-list.md | 15 +- .../Get-workspace-list.md | 15 +- .../Message-management/Delete-message.md | 15 +- .../Slack/Message-management/Edit-message.md | 15 +- .../Get-delayed-message-list.md | 15 +- .../Message-management/Get-message-link.md | 15 +- .../Get-message-reply-list.md | 15 +- .../Send-ephemeral-message.md | 15 +- .../Slack/Message-management/Send-message.md | 15 +- docs/en/md/Telegram/Administration/Ban.md | 15 +- .../Administration/Create-invitation-link.md | 15 +- .../Telegram/Administration/Delete-message.md | 15 +- .../Administration/Get-participant-count.md | 15 +- .../md/Telegram/Administration/Pin-message.md | 15 +- docs/en/md/Telegram/Administration/Unban.md | 15 +- .../Telegram/Administration/Unpin-message.md | 15 +- .../Delete-webhook.md | 15 +- .../Download-file.md | 13 +- .../Get-bot-information.md | 17 +- .../Get-updates.md | 17 +- .../Set-webhook.md | 15 +- .../Form-keyboard-from-button-array.md | 15 +- .../Telegram/Data-sending/Forward-message.md | 15 +- .../en/md/Telegram/Data-sending/Send-audio.md | 15 +- .../md/Telegram/Data-sending/Send-contact.md | 15 +- .../md/Telegram/Data-sending/Send-document.md | 15 +- docs/en/md/Telegram/Data-sending/Send-gif.md | 15 +- .../en/md/Telegram/Data-sending/Send-image.md | 15 +- .../md/Telegram/Data-sending/Send-location.md | 15 +- .../Telegram/Data-sending/Send-media-group.md | 15 +- docs/en/md/Telegram/Data-sending/Send-poll.md | 15 +- .../Data-sending/Send-text-message.md | 15 +- .../en/md/Telegram/Data-sending/Send-video.md | 15 +- .../Clear-thread-pinned-messages-list.md | 15 +- .../Close-forum-thread.md | 15 +- .../Create-forum-thread.md | 15 +- .../Delete-forum-topic.md | 15 +- .../Edit-forum-topic.md | 15 +- .../Edit-main-forum-topic-name.md | 15 +- .../Get-avatar-icon-list.md | 15 +- .../Hide-main-forum-topic.md | 15 +- .../Open-forum-thread.md | 15 +- .../Show-main-forum-topic.md | 15 +- .../Get-authorization-link.md | 15 +- .../md/Twitter/Data-and-settings/Get-token.md | 15 +- .../Data-and-settings/Refresh-token.md | 15 +- docs/en/md/Twitter/Tweets/Create-gif-tweet.md | 15 +- .../md/Twitter/Tweets/Create-image-tweet.md | 15 +- .../en/md/Twitter/Tweets/Create-poll-tweet.md | 15 +- .../en/md/Twitter/Tweets/Create-text-tweet.md | 15 +- .../md/Twitter/Tweets/Create-video-tweet.md | 15 +- .../md/VK/Ad-account-management/Create-ad.md | 15 +- .../Create-advertising-campaign.md | 15 +- .../Get-advertising-category-list.md | 15 +- .../Pause-advertising.md | 15 +- .../md/VK/Community-managment/Create-album.md | 15 +- .../Create-composite-post.md | 15 +- .../md/VK/Community-managment/Create-poll.md | 15 +- .../md/VK/Community-managment/Create-post.md | 15 +- .../md/VK/Community-managment/Create-story.md | 15 +- .../md/VK/Community-managment/Delete-album.md | 15 +- .../md/VK/Community-managment/Delete-image.md | 15 +- .../md/VK/Community-managment/Delete-post.md | 15 +- .../Save-image-to-album.md | 15 +- .../Upload-photo-to-server.md | 13 +- .../Upload-video-to-server.md | 15 +- .../Discussion-management/Close-discussion.md | 15 +- .../Create-discussion.md | 15 +- .../Discussion-management/Open-discussion.md | 15 +- .../Write-in-discussion.md | 15 +- .../en/md/VK/Interactive-actions/Like-post.md | 15 +- .../md/VK/Interactive-actions/Make-repost.md | 15 +- .../md/VK/Interactive-actions/Shorten-link.md | 15 +- .../VK/Interactive-actions/Write-comment.md | 15 +- .../VK/Interactive-actions/Write-message.md | 15 +- .../md/VK/Order-management/Get-order-list.md | 15 +- docs/en/md/VK/Others/Form-keyboard.md | 15 +- .../md/VK/Product-management/Add-product.md | 15 +- .../VK/Product-management/Delete-product.md | 15 +- .../md/VK/Product-management/Edit-product.md | 15 +- .../Get-product-category-list.md | 15 +- .../Get-product-description.md | 15 +- .../VK/Product-management/Get-product-list.md | 15 +- .../Product-management/Get-products-by-id.md | 15 +- .../VK/Product-management/Group-products.md | 15 +- .../Add-product-property-variant.md | 15 +- .../Create-product-property.md | 15 +- .../Delete-product-property-variant.md | 15 +- .../Delete-product-property.md | 15 +- .../Edit-product-property-variant.md | 15 +- .../Edit-product-property.md | 15 +- .../Get-property-list.md | 15 +- .../Add-product-to-collection.md | 15 +- .../Create-product-collection.md | 15 +- .../Delete-selection.md | 15 +- .../Edit-product-collection.md | 15 +- .../Get-selection-list.md | 15 +- .../Get-selections-by-id.md | 15 +- .../Remove-product-from-selection.md | 15 +- .../md/VK/Statistics/Get-post-statistics.md | 15 +- docs/en/md/VK/Statistics/Get-statistics.md | 15 +- .../Create-token-retrieval-link.md | 15 +- .../Create-keyboard-from-array-button.md | 15 +- .../md/Viber/Message-sending/Send-contact.md | 15 +- docs/en/md/Viber/Message-sending/Send-file.md | 15 +- .../en/md/Viber/Message-sending/Send-image.md | 15 +- docs/en/md/Viber/Message-sending/Send-link.md | 15 +- .../md/Viber/Message-sending/Send-location.md | 15 +- .../Message-sending/Send-text-message.md | 15 +- .../Get-channel-information.md | 15 +- .../Get-online-users.md | 15 +- .../Settings-and-information/Get-user-data.md | 15 +- .../Settings-and-information/Set-webhook.md | 15 +- .../Create-folder.md | 15 +- .../Create-object-copy.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 13 +- .../Get-disk-information.md | 15 +- .../Get-download-link.md | 15 +- .../Get-files-list.md | 15 +- .../File-and-folder-management/Get-object.md | 15 +- .../File-and-folder-management/Move-object.md | 15 +- .../Upload-file-by-url.md | 15 +- .../File-and-folder-management/Upload-file.md | 15 +- .../Cancel-object-publication.md | 15 +- .../Get-download-link-for-public-object.md | 15 +- .../Manage-public-access/Get-public-object.md | 15 +- .../Get-published-objects-list.md | 15 +- .../Manage-public-access/Publish-object.md | 15 +- .../Save-public-object-to-disk.md | 15 +- docs/ru/cli/Bitrix24/ВключитьЗвукЗадачи.txt | 1 + docs/ru/cli/Bitrix24/ВосстановитьКаталог.txt | 1 + docs/ru/cli/Bitrix24/ВосстановитьФайл.txt | 1 + .../Bitrix24/ДобавитьКомментарийЗадачи.txt | 1 + .../Bitrix24/ДобавитьКомментарийНовости.txt | 1 + .../ru/cli/Bitrix24/ДобавитьСтадиюКанбана.txt | 1 + docs/ru/cli/Bitrix24/ДобавитьФайлВЗадачу.txt | 1 + .../ru/cli/Bitrix24/ЗагрузитьФайлВКаталог.txt | 1 + .../Bitrix24/ИзменитьКомментарийЗадачи.txt | 1 + docs/ru/cli/Bitrix24/ОтключитьЗвукЗадачи.txt | 1 + docs/ru/cli/Bitrix24/ПереименоватьКаталог.txt | 1 + docs/ru/cli/Bitrix24/ПереименоватьФайл.txt | 1 + docs/ru/cli/Bitrix24/ПереместитьКаталог.txt | 1 + .../cli/Bitrix24/ПереместитьФайлВКаталог.txt | 1 + .../ПеренестиЗадачуВСтадиюКанбана.txt | 1 + .../ПолучитьВнешнююСсылкуКаталога.txt | 1 + .../Bitrix24/ПолучитьВнешнююСсылкуФайла.txt | 1 + .../ПолучитьДочерниеЭлементыКаталога.txt | 1 + .../Bitrix24/ПолучитьИнформациюОКаталоге.txt | 1 + .../cli/Bitrix24/ПолучитьИнформациюОФайле.txt | 1 + .../Bitrix24/ПолучитьКомменатрийЗадачи.txt | 1 + .../Bitrix24/ПолучитьСписокРезультатов.txt | 1 + .../ru/cli/Bitrix24/ПолучитьСтадииКанбана.txt | 1 + .../Bitrix24/ПолучитьСтруктуруКомментария.txt | 1 + .../ПолучитьСтруктуруФильтраКаталога.txt | 1 + .../cli/Bitrix24/ПоместитьКаталогВКорзину.txt | 1 + .../ru/cli/Bitrix24/ПоместитьФайлВКорзину.txt | 1 + .../cli/Bitrix24/ПроверитьДоступКЗадаче.txt | 1 + docs/ru/cli/Bitrix24/СкопироватьКаталог.txt | 1 + docs/ru/cli/Bitrix24/СкопироватьФайл.txt | 1 + .../cli/Bitrix24/СоздатьЗависимостьЗадач.txt | 1 + docs/ru/cli/Bitrix24/СоздатьПодкаталог.txt | 1 + .../СоздатьРезультатИзКомментария.txt | 1 + .../cli/Bitrix24/УдалитьЗависимостьЗадач.txt | 1 + .../cli/Bitrix24/УдалитьКомментарийЗадачи.txt | 1 + .../УдалитьРезультатИзКомментария.txt | 1 + docs/ru/cli/Bitrix24/УдалитьСтадиюКанбана.txt | 1 + docs/ru/data/Bitrix24/ВключитьЗвукЗадачи.json | 5 + .../ru/data/Bitrix24/ВосстановитьКаталог.json | 5 + docs/ru/data/Bitrix24/ВосстановитьФайл.json | 5 + .../Bitrix24/ДобавитьКомментарийЗадачи.json | 5 + .../Bitrix24/ДобавитьКомментарийНовости.json | 5 + .../data/Bitrix24/ДобавитьСтадиюКанбана.json | 4 + .../ru/data/Bitrix24/ДобавитьФайлВЗадачу.json | 6 + .../data/Bitrix24/ЗагрузитьФайлВКаталог.json | 7 + .../Bitrix24/ИзменитьКомментарийЗадачи.json | 6 + .../ru/data/Bitrix24/ОтключитьЗвукЗадачи.json | 5 + .../data/Bitrix24/ПереименоватьКаталог.json | 6 + docs/ru/data/Bitrix24/ПереименоватьФайл.json | 6 + docs/ru/data/Bitrix24/ПереместитьКаталог.json | 6 + .../Bitrix24/ПереместитьФайлВКаталог.json | 6 + .../ПеренестиЗадачуВСтадиюКанбана.json | 6 + .../ПолучитьВнешнююСсылкуКаталога.json | 5 + .../Bitrix24/ПолучитьВнешнююСсылкуФайла.json | 5 + .../ПолучитьДочерниеЭлементыКаталога.json | 5 + .../Bitrix24/ПолучитьИнформациюОКаталоге.json | 5 + .../Bitrix24/ПолучитьИнформациюОФайле.json | 5 + .../Bitrix24/ПолучитьКомменатрийЗадачи.json | 6 + .../ПолучитьСписокКомментариевЗадачи.json | 5 + .../Bitrix24/ПолучитьСписокРезультатов.json | 5 + .../ПолучитьСсылкуАвторизацииПриложения.json | 4 + .../data/Bitrix24/ПолучитьСтадииКанбана.json | 4 + .../ПолучитьСтруктуруФильтраКаталога.json | 4 + .../Bitrix24/ПоместитьКаталогВКорзину.json | 5 + .../data/Bitrix24/ПоместитьФайлВКорзину.json | 5 + .../data/Bitrix24/ПроверитьДоступКЗадаче.json | 5 + docs/ru/data/Bitrix24/СкопироватьКаталог.json | 6 + docs/ru/data/Bitrix24/СкопироватьФайл.json | 6 + .../Bitrix24/СоздатьЗависимостьЗадач.json | 6 + docs/ru/data/Bitrix24/СоздатьПодкаталог.json | 5 + .../СоздатьРезультатИзКомментария.json | 5 + .../Bitrix24/УдалитьКомментарийЗадачи.json | 6 + .../УдалитьРезультатИзКомментария.json | 5 + .../data/Bitrix24/УдалитьСтадиюКанбана.json | 5 + .../VK/ДобавитьВариантСвойстваТовара.json | 3 + docs/ru/data/VK/ДобавитьТовар.json | 5 + docs/ru/data/VK/ДобавитьТоварВПодборку.json | 4 + docs/ru/data/VK/ЗагрузитьВидеоНаСервер.json | 3 + .../VK/ИзменитьВариантСвойстваТовара.json | 4 + docs/ru/data/VK/ИзменитьПодборкуТоваров.json | 3 + docs/ru/data/VK/ИзменитьСвойствоТовара.json | 3 + docs/ru/data/VK/ИзменитьТовар.json | 3 + docs/ru/data/VK/НаписатьКомментарий.json | 3 + docs/ru/data/VK/ПолучитьТоварыПоИД.json | 4 + docs/ru/data/VK/ПоставитьЛайк.json | 3 + .../VK/ПриостановитьРекламноеОбъявление.json | 4 + docs/ru/data/VK/СгруппироватьТовары.json | 4 + docs/ru/data/VK/СоздатьПодборкуТоваров.json | 3 + .../data/VK/СоздатьРекламноеОбъявление.json | 5 + docs/ru/data/VK/СоздатьРекламнуюКампанию.json | 3 + docs/ru/data/VK/СоздатьТоварСоСвойством.json | 6 + .../data/VK/УдалитьВариантСвойстваТовара.json | 3 + docs/ru/data/VK/УдалитьПодборку.json | 3 + docs/ru/data/VK/УдалитьСвойствоТовара.json | 3 + docs/ru/data/VK/УдалитьТовар.json | 3 + docs/ru/data/VK/УдалитьТоварИзПодборки.json | 4 + .../examples/Bitrix24/ВключитьЗвукЗадачи.txt | 11 + .../examples/Bitrix24/ВосстановитьКаталог.txt | 10 + .../ru/examples/Bitrix24/ВосстановитьФайл.txt | 10 + .../Bitrix24/ДобавитьКомментарийЗадачи.txt | 15 + .../Bitrix24/ДобавитьКомментарийНовости.txt | 12 + .../Bitrix24/ДобавитьСтадиюКанбана.txt | 16 + .../examples/Bitrix24/ДобавитьФайлВЗадачу.txt | 12 + .../Bitrix24/ЗагрузитьФайлВКаталог.txt | 18 + .../Bitrix24/ИзменитьКомментарийЗадачи.txt | 16 + .../examples/Bitrix24/ОтключитьЗвукЗадачи.txt | 11 + .../Bitrix24/ПереименоватьКаталог.txt | 14 + .../examples/Bitrix24/ПереименоватьФайл.txt | 14 + .../examples/Bitrix24/ПереместитьКаталог.txt | 16 + .../Bitrix24/ПереместитьФайлВКаталог.txt | 16 + .../ПеренестиЗадачуВСтадиюКанбана.txt | 14 + .../ПолучитьВнешнююСсылкуКаталога.txt | 10 + .../Bitrix24/ПолучитьВнешнююСсылкуФайла.txt | 10 + .../ПолучитьДочерниеЭлементыКаталога.txt | 10 + .../Bitrix24/ПолучитьИнформациюОКаталоге.txt | 10 + .../Bitrix24/ПолучитьИнформациюОФайле.txt | 10 + .../Bitrix24/ПолучитьКомменатрийЗадачи.txt | 12 + .../ПолучитьСписокКомментариевЗадачи.txt | 10 + .../Bitrix24/ПолучитьСписокРезультатов.txt | 10 + .../ПолучитьСсылкуАвторизацииПриложения.txt | 4 + .../Bitrix24/ПолучитьСтадииКанбана.txt | 9 + .../ПолучитьСтруктуруФильтраКаталога.txt | 9 + .../Bitrix24/ПоместитьКаталогВКорзину.txt | 10 + .../Bitrix24/ПоместитьФайлВКорзину.txt | 10 + .../Bitrix24/ПроверитьДоступКЗадаче.txt | 15 + .../examples/Bitrix24/СкопироватьКаталог.txt | 17 + docs/ru/examples/Bitrix24/СкопироватьФайл.txt | 16 + .../Bitrix24/СоздатьЗависимостьЗадач.txt | 17 + .../examples/Bitrix24/СоздатьПодкаталог.txt | 14 + .../СоздатьРезультатИзКомментария.txt | 11 + .../Bitrix24/УдалитьКомментарийЗадачи.txt | 12 + .../УдалитьРезультатИзКомментария.txt | 11 + .../Bitrix24/УдалитьСтадиюКанбана.txt | 13 + .../examples/VK/СоздатьТоварСоСвойством.txt | 50 ++ .../Comment-management/Create-comment.md | 15 +- .../Comment-management/Delete-comment.md | 15 +- .../Comment-management/Edit-comment.md | 15 +- .../Comment-management/Get-comments.md | 15 +- .../Record-management/Create-posts.md | 15 +- .../Record-management/Delete-posts.md | 15 +- .../Record-management/Get-list-of-records.md | 15 +- .../Airtable/Record-management/Get-record.md | 15 +- .../Airtable/Table-management/Create-table.md | 15 +- .../Airtable/Table-management/Modify-table.md | 15 +- .../Working-with-databases/Create-database.md | 15 +- .../Get-database-tables.md | 15 +- .../Get-list-of-bases.md | 15 +- .../Working-with-fields/Create-field.md | 15 +- .../Get-attachment-field.md | 15 +- .../Working-with-fields/Get-checkbox-field.md | 15 +- .../Working-with-fields/Get-date-field.md | 15 +- .../Working-with-fields/Get-email-field.md | 15 +- .../Working-with-fields/Get-link-field.md | 15 +- .../Working-with-fields/Get-number-field.md | 15 +- .../Working-with-fields/Get-phone-field.md | 15 +- .../Working-with-fields/Get-string-field.md | 15 +- .../Working-with-fields/Modify-field.md | 15 +- .../Add-task-comment.md | 67 +++ .../Create-result-from-comment.md | 73 +++ .../Delete-result-from-comment.md | 62 ++ .../Delete-task-comment.md | 64 ++ .../Get-comment-structure.md | 33 ++ .../Get-results-list.md | 86 +++ .../Get-task-comment.md | 72 +++ .../Get-task-comments-list.md | 80 +++ .../Update-task-comment.md | 69 +++ .../_category_.json | 4 + .../Feed-posts-managment/Add-post-comment.md | 64 ++ .../Add-post-recipients.md | 15 +- .../Feed-posts-managment/Create-post.md | 17 +- .../Feed-posts-managment/Delete-post.md | 15 +- .../Get-important-post-viewers.md | 15 +- .../Feed-posts-managment/Get-posts.md | 15 +- .../Feed-posts-managment/Update-post.md | 15 +- .../ru/md/Bitrix24/Kanban/Add-kanban-stage.md | 71 +++ .../md/Bitrix24/Kanban/Delete-kanban-stage.md | 65 ++ .../md/Bitrix24/Kanban/Get-kanban-stages.md | 554 ++++++++++++++++++ .../Kanban/Move-task-to-kanban-stage.md | 68 +++ docs/ru/md/Bitrix24/Kanban/_category_.json | 4 + .../Get-app-auth-link.md | 18 +- .../Settings-and-administartion/Get-token.md | 15 +- .../Refresh-token.md | 15 +- .../Server-time.md | 15 +- .../Create-storage-folder.md | 15 +- .../Create-subfolder.md | 82 +++ .../Delete-file.md | 17 +- .../Delete-folder.md | 17 +- .../Get-app-sotrage.md | 15 +- .../Get-file-external-link.md | 61 ++ .../Get-file-information.md | 80 +++ .../Get-folder-external-link.md | 61 ++ .../Get-folder-filter-structure.md | 59 ++ .../Get-folder-information.md | 77 +++ .../Get-folder-items.md | 98 ++++ .../Get-storage-objects.md | 15 +- .../Get-storage.md | 15 +- .../Get-storages-list.md | 15 +- .../Make-file-copy.md | 87 +++ .../Make-folder-copy.md | 85 +++ .../Mark-file-as-deleted.md | 80 +++ .../Mark-folder-as-deleted.md | 77 +++ .../Move-file-to-folder.md | 87 +++ .../Move-folder.md | 84 +++ .../Rename-file.md | 85 +++ .../Rename-folder.md | 82 +++ .../Rename-storage.md | 15 +- .../Restore-file.md | 80 +++ .../Restore-folder.md | 77 +++ .../Upload-file-to-folder.md | 80 +++ .../Upload-file-to-storage.md | 15 +- .../_category_.json | 2 +- .../Tasks-managment/Add-task-to-favorites.md | 15 +- .../Bitrix24/Tasks-managment/Approve-task.md | 15 +- .../Tasks-managment/Attach-file-to-topic.md | 66 +++ .../Tasks-managment/Check-task-accesses.md | 126 ++++ .../Bitrix24/Tasks-managment/Complete-task.md | 15 +- .../Bitrix24/Tasks-managment/Create-task.md | 19 +- .../Create-tasks-dependencies.md | 70 +++ .../md/Bitrix24/Tasks-managment/Defer-task.md | 15 +- .../Bitrix24/Tasks-managment/Delegate-task.md | 15 +- .../Bitrix24/Tasks-managment/Delete-task.md | 17 +- .../Delete-tasks-dependencies.md | 37 ++ .../Tasks-managment/Disapprove-task.md | 15 +- .../Get-task-fields-structure.md | 17 +- .../Tasks-managment/Get-task-history.md | 15 +- .../md/Bitrix24/Tasks-managment/Get-task.md | 17 +- .../Get-tasks-filter-structure.md | 16 +- .../Tasks-managment/Get-tasks-list.md | 17 +- .../md/Bitrix24/Tasks-managment/Mute-task.md | 192 ++++++ .../md/Bitrix24/Tasks-managment/Pause-task.md | 15 +- .../Remove-task-from-favorites.md | 15 +- .../md/Bitrix24/Tasks-managment/Renew-task.md | 15 +- .../md/Bitrix24/Tasks-managment/Start-task.md | 15 +- .../Tasks-managment/Start-watching-task.md | 15 +- .../Tasks-managment/Stop-watching-task.md | 15 +- .../Bitrix24/Tasks-managment/Unmute-task.md | 192 ++++++ .../Bitrix24/Tasks-managment/Update-task.md | 17 +- .../Get-account-information.md | 15 +- .../Get-authorization-link.md | 15 +- .../Get-space-usage-data.md | 15 +- .../Account-and-authorization/Get-token.md | 15 +- .../Refresh-token.md | 15 +- .../Copy-object.md | 15 +- .../Create-folder.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 15 +- .../Download-folder.md | 15 +- .../Get-list-of-folder-files.md | 13 +- .../Get-object-information.md | 15 +- .../Get-object-version-list.md | 15 +- .../Get-preview.md | 15 +- .../Get-upload-status-by-url.md | 15 +- .../Move-object.md | 15 +- .../Restore-object-to-version.md | 15 +- .../Upload-file-by-url.md | 15 +- .../Upload-file.md | 15 +- .../Add-users-to-file.md | 15 +- .../Add-users-to-folder.md | 15 +- .../Cancel-file-publication.md | 15 +- .../Cancel-folder-publication.md | 15 +- .../Get-asynchronous-change-status.md | 14 +- .../Shared-access-settings/Publish-folder.md | 15 +- docs/ru/md/Dropbox/Tags-managment/Add-tag.md | 15 +- .../md/Dropbox/Tags-managment/Delete-tag.md | 15 +- .../md/Dropbox/Tags-managment/Get-tag-list.md | 15 +- .../Add-calendar-to-list.md | 15 +- .../Delete-calendar-from-list.md | 15 +- .../Edit-list-calendar.md | 15 +- .../Get-calendar-list.md | 15 +- .../Get-list-calendar.md | 15 +- .../Clear-main-calendar.md | 15 +- .../Create-calendar.md | 15 +- .../Delete-calendar.md | 15 +- .../Edit-calendar-metadata.md | 15 +- .../Get-calendar-metadata.md | 15 +- .../Event-management/Create-event.md | 15 +- .../Event-management/Delete-event.md | 15 +- .../Event-management/Edit-event.md | 15 +- .../Event-management/Get-event-description.md | 14 +- .../Event-management/Get-event-list.md | 15 +- .../Event-management/Get-event.md | 15 +- .../Event-management/Move-event.md | 15 +- .../Comment-management/Create-comment.md | 15 +- .../Comment-management/Delete-comment.md | 15 +- .../Comment-management/Get-comment-list.md | 15 +- .../Comment-management/Get-comment.md | 15 +- .../Copy-object.md | 15 +- .../Create-folder.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 13 +- .../Get-directories-list.md | 15 +- .../Get-file-description.md | 15 +- .../Get-files-list.md | 15 +- .../Get-object-information.md | 15 +- .../Update-file.md | 15 +- .../Upload-file.md | 15 +- .../Data-managment/Clear-cells.md | 15 +- .../Data-managment/Get-cell-values.md | 15 +- .../Data-managment/Set-cell-values.md | 15 +- .../Create-spreadsheet.md | 15 +- .../Edit-spreadsheet-title.md | 15 +- .../Spreadsheets-managment/Get-spreadsheet.md | 15 +- .../Working-with-sheets/Add-sheet.md | 15 +- .../Working-with-sheets/Copy-sheet.md | 15 +- .../Working-with-sheets/Delete-sheet.md | 15 +- .../Notion/Blocks-managment/Create-block.md | 15 +- .../Notion/Blocks-managment/Delete-block.md | 15 +- .../Notion/Blocks-managment/Return-block.md | 15 +- .../Blocks-managment/Return-child-blocks.md | 15 +- .../Database-management/Create-database.md | 15 +- .../Edit-database-properties.md | 15 +- .../Database-management/Get-database.md | 15 +- .../Create-page-in-database.md | 15 +- .../md/Notion/Page-management/Create-page.md | 15 +- .../Page-management/Edit-page-properties.md | 15 +- docs/ru/md/Notion/Page-management/Get-page.md | 15 +- docs/ru/md/Notion/Users/Get-user-data.md | 15 +- docs/ru/md/Notion/Users/User-list.md | 15 +- .../Block-formation/Generate-image-block.md | 15 +- .../Channel-management/Archive-channel.md | 15 +- .../Channel-management/Create-channel.md | 15 +- .../Channel-management/Get-channel-history.md | 15 +- .../Channel-management/Get-channel-list.md | 15 +- .../Get-channel-user-list.md | 15 +- .../Slack/Channel-management/Get-channel.md | 15 +- .../Invite-users-to-channel.md | 15 +- .../Slack/Channel-management/Join-channel.md | 15 +- .../Kick-user-from-channel.md | 15 +- .../Slack/Channel-management/Leave-channel.md | 15 +- .../Channel-management/Rename-channel.md | 15 +- .../Channel-management/Set-channel-goal.md | 15 +- .../Channel-management/Set-channel-topic.md | 15 +- .../Slack/Dialog-management/Close-dialog.md | 15 +- .../md/Slack/Dialog-management/Open-dialog.md | 15 +- .../Add-external-file.md | 15 +- .../Delete-external-file.md | 15 +- .../Get-external-file-list.md | 15 +- .../Get-external-file.md | 15 +- .../Send-external-file.md | 15 +- .../ru/md/Slack/File-managment/Delete-file.md | 15 +- .../md/Slack/File-managment/Get-file-data.md | 15 +- .../md/Slack/File-managment/Get-files-list.md | 15 +- .../Slack/File-managment/Make-file-private.md | 14 +- .../Slack/File-managment/Make-file-public.md | 14 +- .../ru/md/Slack/File-managment/Upload-file.md | 15 +- .../Get-bot-information.md | 15 +- .../Management-and-settings/Get-user-list.md | 15 +- .../Get-workspace-list.md | 15 +- .../Message-management/Delete-message.md | 15 +- .../Slack/Message-management/Edit-message.md | 15 +- .../Get-delayed-message-list.md | 15 +- .../Message-management/Get-message-link.md | 15 +- .../Get-message-reply-list.md | 15 +- .../Send-ephemeral-message.md | 15 +- .../Slack/Message-management/Send-message.md | 15 +- docs/ru/md/Telegram/Administration/Ban.md | 15 +- .../Administration/Create-invitation-link.md | 15 +- .../Telegram/Administration/Delete-message.md | 15 +- .../Administration/Get-participant-count.md | 15 +- .../md/Telegram/Administration/Pin-message.md | 15 +- docs/ru/md/Telegram/Administration/Unban.md | 15 +- .../Telegram/Administration/Unpin-message.md | 15 +- .../Delete-webhook.md | 15 +- .../Download-file.md | 13 +- .../Get-bot-information.md | 17 +- .../Get-updates.md | 17 +- .../Set-webhook.md | 15 +- .../Form-keyboard-from-button-array.md | 15 +- .../Telegram/Data-sending/Forward-message.md | 15 +- .../ru/md/Telegram/Data-sending/Send-audio.md | 15 +- .../md/Telegram/Data-sending/Send-contact.md | 15 +- .../md/Telegram/Data-sending/Send-document.md | 15 +- docs/ru/md/Telegram/Data-sending/Send-gif.md | 15 +- .../ru/md/Telegram/Data-sending/Send-image.md | 15 +- .../md/Telegram/Data-sending/Send-location.md | 15 +- .../Telegram/Data-sending/Send-media-group.md | 15 +- docs/ru/md/Telegram/Data-sending/Send-poll.md | 15 +- .../Data-sending/Send-text-message.md | 15 +- .../ru/md/Telegram/Data-sending/Send-video.md | 15 +- .../Clear-thread-pinned-messages-list.md | 15 +- .../Close-forum-thread.md | 15 +- .../Create-forum-thread.md | 15 +- .../Delete-forum-topic.md | 15 +- .../Edit-forum-topic.md | 15 +- .../Edit-main-forum-topic-name.md | 15 +- .../Get-avatar-icon-list.md | 15 +- .../Hide-main-forum-topic.md | 15 +- .../Open-forum-thread.md | 15 +- .../Show-main-forum-topic.md | 15 +- .../Get-authorization-link.md | 15 +- .../md/Twitter/Data-and-settings/Get-token.md | 15 +- .../Data-and-settings/Refresh-token.md | 15 +- docs/ru/md/Twitter/Tweets/Create-gif-tweet.md | 15 +- .../md/Twitter/Tweets/Create-image-tweet.md | 15 +- .../ru/md/Twitter/Tweets/Create-poll-tweet.md | 15 +- .../ru/md/Twitter/Tweets/Create-text-tweet.md | 15 +- .../md/Twitter/Tweets/Create-video-tweet.md | 15 +- .../md/VK/Ad-account-management/Create-ad.md | 15 +- .../Create-advertising-campaign.md | 15 +- .../Get-advertising-category-list.md | 15 +- .../Pause-advertising.md | 15 +- .../md/VK/Community-managment/Create-album.md | 15 +- .../Create-composite-post.md | 15 +- .../md/VK/Community-managment/Create-poll.md | 15 +- .../md/VK/Community-managment/Create-post.md | 15 +- .../md/VK/Community-managment/Create-story.md | 15 +- .../md/VK/Community-managment/Delete-album.md | 15 +- .../md/VK/Community-managment/Delete-image.md | 15 +- .../md/VK/Community-managment/Delete-post.md | 15 +- .../Save-image-to-album.md | 15 +- .../Upload-photo-to-server.md | 13 +- .../Upload-video-to-server.md | 15 +- .../Discussion-management/Close-discussion.md | 15 +- .../Create-discussion.md | 15 +- .../Discussion-management/Open-discussion.md | 15 +- .../Write-in-discussion.md | 15 +- .../ru/md/VK/Interactive-actions/Like-post.md | 15 +- .../md/VK/Interactive-actions/Make-repost.md | 15 +- .../md/VK/Interactive-actions/Shorten-link.md | 15 +- .../VK/Interactive-actions/Write-comment.md | 15 +- .../VK/Interactive-actions/Write-message.md | 15 +- .../md/VK/Order-management/Get-order-list.md | 15 +- docs/ru/md/VK/Others/Form-keyboard.md | 15 +- .../md/VK/Product-management/Add-product.md | 15 +- .../VK/Product-management/Delete-product.md | 15 +- .../md/VK/Product-management/Edit-product.md | 15 +- .../Get-product-category-list.md | 15 +- .../Get-product-description.md | 15 +- .../VK/Product-management/Get-product-list.md | 15 +- .../Product-management/Get-products-by-id.md | 15 +- .../VK/Product-management/Group-products.md | 15 +- .../Add-product-property-variant.md | 15 +- .../Create-product-property.md | 15 +- .../Delete-product-property-variant.md | 15 +- .../Delete-product-property.md | 15 +- .../Edit-product-property-variant.md | 15 +- .../Edit-product-property.md | 15 +- .../Get-property-list.md | 15 +- .../Add-product-to-collection.md | 15 +- .../Create-product-collection.md | 15 +- .../Delete-selection.md | 15 +- .../Edit-product-collection.md | 15 +- .../Get-selection-list.md | 15 +- .../Get-selections-by-id.md | 15 +- .../Remove-product-from-selection.md | 15 +- .../md/VK/Statistics/Get-post-statistics.md | 15 +- docs/ru/md/VK/Statistics/Get-statistics.md | 15 +- .../Create-token-retrieval-link.md | 15 +- .../Create-keyboard-from-array-button.md | 15 +- .../md/Viber/Message-sending/Send-contact.md | 15 +- docs/ru/md/Viber/Message-sending/Send-file.md | 15 +- .../ru/md/Viber/Message-sending/Send-image.md | 15 +- docs/ru/md/Viber/Message-sending/Send-link.md | 15 +- .../md/Viber/Message-sending/Send-location.md | 15 +- .../Message-sending/Send-text-message.md | 15 +- .../Get-channel-information.md | 15 +- .../Get-online-users.md | 15 +- .../Settings-and-information/Get-user-data.md | 15 +- .../Settings-and-information/Set-webhook.md | 15 +- .../Create-folder.md | 15 +- .../Create-object-copy.md | 15 +- .../Delete-object.md | 15 +- .../Download-file.md | 13 +- .../Get-disk-information.md | 15 +- .../Get-download-link.md | 15 +- .../Get-files-list.md | 15 +- .../File-and-folder-management/Get-object.md | 15 +- .../File-and-folder-management/Move-object.md | 15 +- .../Upload-file-by-url.md | 15 +- .../File-and-folder-management/Upload-file.md | 15 +- .../Cancel-object-publication.md | 15 +- .../Get-download-link-for-public-object.md | 15 +- .../Manage-public-access/Get-public-object.md | 15 +- .../Get-published-objects-list.md | 15 +- .../Manage-public-access/Publish-object.md | 15 +- .../Save-public-object-to-disk.md | 15 +- service/dictionaries/en.json | 3 +- src/ru/OInt/core/Modules/OPI_Bitrix24.os | 3 + src/ru/OInt/lib.config | 24 +- .../src/CommonModules/OPI_Bitrix24/Module.bsl | 3 + 825 files changed, 13405 insertions(+), 3686 deletions(-) create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md create mode 100644 docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json create mode 100644 docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md create mode 100644 docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md create mode 100644 docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md create mode 100644 docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md create mode 100644 docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md create mode 100644 docs/en/md/Bitrix24/Kanban/_category_.json create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-information.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Move-folder.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Rename-file.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Rename-folder.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Restore-file.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Restore-folder.md create mode 100644 docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Mute-task.md create mode 100644 docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md create mode 100644 docs/ru/cli/Bitrix24/ВключитьЗвукЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/ВосстановитьКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/ВосстановитьФайл.txt create mode 100644 docs/ru/cli/Bitrix24/ДобавитьКомментарийЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/ДобавитьКомментарийНовости.txt create mode 100644 docs/ru/cli/Bitrix24/ДобавитьСтадиюКанбана.txt create mode 100644 docs/ru/cli/Bitrix24/ДобавитьФайлВЗадачу.txt create mode 100644 docs/ru/cli/Bitrix24/ЗагрузитьФайлВКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/ИзменитьКомментарийЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/ОтключитьЗвукЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/ПереименоватьКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/ПереименоватьФайл.txt create mode 100644 docs/ru/cli/Bitrix24/ПереместитьКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/ПереместитьФайлВКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьИнформациюОКаталоге.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьИнформациюОФайле.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьКомменатрийЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьСписокРезультатов.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьСтадииКанбана.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьСтруктуруКомментария.txt create mode 100644 docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt create mode 100644 docs/ru/cli/Bitrix24/ПоместитьКаталогВКорзину.txt create mode 100644 docs/ru/cli/Bitrix24/ПоместитьФайлВКорзину.txt create mode 100644 docs/ru/cli/Bitrix24/ПроверитьДоступКЗадаче.txt create mode 100644 docs/ru/cli/Bitrix24/СкопироватьКаталог.txt create mode 100644 docs/ru/cli/Bitrix24/СкопироватьФайл.txt create mode 100644 docs/ru/cli/Bitrix24/СоздатьЗависимостьЗадач.txt create mode 100644 docs/ru/cli/Bitrix24/СоздатьПодкаталог.txt create mode 100644 docs/ru/cli/Bitrix24/СоздатьРезультатИзКомментария.txt create mode 100644 docs/ru/cli/Bitrix24/УдалитьЗависимостьЗадач.txt create mode 100644 docs/ru/cli/Bitrix24/УдалитьКомментарийЗадачи.txt create mode 100644 docs/ru/cli/Bitrix24/УдалитьРезультатИзКомментария.txt create mode 100644 docs/ru/cli/Bitrix24/УдалитьСтадиюКанбана.txt create mode 100644 docs/ru/data/Bitrix24/ВключитьЗвукЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ВосстановитьКаталог.json create mode 100644 docs/ru/data/Bitrix24/ВосстановитьФайл.json create mode 100644 docs/ru/data/Bitrix24/ДобавитьКомментарийЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ДобавитьКомментарийНовости.json create mode 100644 docs/ru/data/Bitrix24/ДобавитьСтадиюКанбана.json create mode 100644 docs/ru/data/Bitrix24/ДобавитьФайлВЗадачу.json create mode 100644 docs/ru/data/Bitrix24/ЗагрузитьФайлВКаталог.json create mode 100644 docs/ru/data/Bitrix24/ИзменитьКомментарийЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ОтключитьЗвукЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ПереименоватьКаталог.json create mode 100644 docs/ru/data/Bitrix24/ПереименоватьФайл.json create mode 100644 docs/ru/data/Bitrix24/ПереместитьКаталог.json create mode 100644 docs/ru/data/Bitrix24/ПереместитьФайлВКаталог.json create mode 100644 docs/ru/data/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуКаталога.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуФайла.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьДочерниеЭлементыКаталога.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьИнформациюОКаталоге.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьИнформациюОФайле.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьКомменатрийЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьСписокКомментариевЗадачи.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьСписокРезультатов.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьСтадииКанбана.json create mode 100644 docs/ru/data/Bitrix24/ПолучитьСтруктуруФильтраКаталога.json create mode 100644 docs/ru/data/Bitrix24/ПоместитьКаталогВКорзину.json create mode 100644 docs/ru/data/Bitrix24/ПоместитьФайлВКорзину.json create mode 100644 docs/ru/data/Bitrix24/ПроверитьДоступКЗадаче.json create mode 100644 docs/ru/data/Bitrix24/СкопироватьКаталог.json create mode 100644 docs/ru/data/Bitrix24/СкопироватьФайл.json create mode 100644 docs/ru/data/Bitrix24/СоздатьЗависимостьЗадач.json create mode 100644 docs/ru/data/Bitrix24/СоздатьПодкаталог.json create mode 100644 docs/ru/data/Bitrix24/СоздатьРезультатИзКомментария.json create mode 100644 docs/ru/data/Bitrix24/УдалитьКомментарийЗадачи.json create mode 100644 docs/ru/data/Bitrix24/УдалитьРезультатИзКомментария.json create mode 100644 docs/ru/data/Bitrix24/УдалитьСтадиюКанбана.json create mode 100644 docs/ru/data/VK/ДобавитьВариантСвойстваТовара.json create mode 100644 docs/ru/data/VK/ДобавитьТовар.json create mode 100644 docs/ru/data/VK/ДобавитьТоварВПодборку.json create mode 100644 docs/ru/data/VK/ЗагрузитьВидеоНаСервер.json create mode 100644 docs/ru/data/VK/ИзменитьВариантСвойстваТовара.json create mode 100644 docs/ru/data/VK/ИзменитьПодборкуТоваров.json create mode 100644 docs/ru/data/VK/ИзменитьСвойствоТовара.json create mode 100644 docs/ru/data/VK/ИзменитьТовар.json create mode 100644 docs/ru/data/VK/НаписатьКомментарий.json create mode 100644 docs/ru/data/VK/ПолучитьТоварыПоИД.json create mode 100644 docs/ru/data/VK/ПоставитьЛайк.json create mode 100644 docs/ru/data/VK/ПриостановитьРекламноеОбъявление.json create mode 100644 docs/ru/data/VK/СгруппироватьТовары.json create mode 100644 docs/ru/data/VK/СоздатьПодборкуТоваров.json create mode 100644 docs/ru/data/VK/СоздатьРекламноеОбъявление.json create mode 100644 docs/ru/data/VK/СоздатьРекламнуюКампанию.json create mode 100644 docs/ru/data/VK/СоздатьТоварСоСвойством.json create mode 100644 docs/ru/data/VK/УдалитьВариантСвойстваТовара.json create mode 100644 docs/ru/data/VK/УдалитьПодборку.json create mode 100644 docs/ru/data/VK/УдалитьСвойствоТовара.json create mode 100644 docs/ru/data/VK/УдалитьТовар.json create mode 100644 docs/ru/data/VK/УдалитьТоварИзПодборки.json create mode 100644 docs/ru/examples/Bitrix24/ВключитьЗвукЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ВосстановитьКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/ВосстановитьФайл.txt create mode 100644 docs/ru/examples/Bitrix24/ДобавитьКомментарийЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ДобавитьКомментарийНовости.txt create mode 100644 docs/ru/examples/Bitrix24/ДобавитьСтадиюКанбана.txt create mode 100644 docs/ru/examples/Bitrix24/ДобавитьФайлВЗадачу.txt create mode 100644 docs/ru/examples/Bitrix24/ЗагрузитьФайлВКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/ИзменитьКомментарийЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ОтключитьЗвукЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ПереименоватьКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/ПереименоватьФайл.txt create mode 100644 docs/ru/examples/Bitrix24/ПереместитьКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/ПереместитьФайлВКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьИнформациюОКаталоге.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьИнформациюОФайле.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьКомменатрийЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьСписокКомментариевЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьСписокРезультатов.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьСтадииКанбана.txt create mode 100644 docs/ru/examples/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt create mode 100644 docs/ru/examples/Bitrix24/ПоместитьКаталогВКорзину.txt create mode 100644 docs/ru/examples/Bitrix24/ПоместитьФайлВКорзину.txt create mode 100644 docs/ru/examples/Bitrix24/ПроверитьДоступКЗадаче.txt create mode 100644 docs/ru/examples/Bitrix24/СкопироватьКаталог.txt create mode 100644 docs/ru/examples/Bitrix24/СкопироватьФайл.txt create mode 100644 docs/ru/examples/Bitrix24/СоздатьЗависимостьЗадач.txt create mode 100644 docs/ru/examples/Bitrix24/СоздатьПодкаталог.txt create mode 100644 docs/ru/examples/Bitrix24/СоздатьРезультатИзКомментария.txt create mode 100644 docs/ru/examples/Bitrix24/УдалитьКомментарийЗадачи.txt create mode 100644 docs/ru/examples/Bitrix24/УдалитьРезультатИзКомментария.txt create mode 100644 docs/ru/examples/Bitrix24/УдалитьСтадиюКанбана.txt create mode 100644 docs/ru/examples/VK/СоздатьТоварСоСвойством.txt create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md create mode 100644 docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json create mode 100644 docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md create mode 100644 docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md create mode 100644 docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md create mode 100644 docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md create mode 100644 docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md create mode 100644 docs/ru/md/Bitrix24/Kanban/_category_.json create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md create mode 100644 docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md create mode 100644 docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md diff --git a/.github/workflows/os/docs_examples.os b/.github/workflows/os/docs_examples.os index d0d0e61aea..d83fcc7349 100644 --- a/.github/workflows/os/docs_examples.os +++ b/.github/workflows/os/docs_examples.os @@ -176,7 +176,12 @@ РазбитоеЗначение = СтрРазделить(Текст, "=", Ложь); ИмяПараметра = ОпределитьИмяПараметра(Текст); - Значение = OPI_ПолучениеДанныхТестов.ПолучитьПараметр(ИмяПараметра); + + Попытка + Значение = OPI_ПолучениеДанныхТестов.ПолучитьПараметр(ИмяПараметра); + Исключение + Возврат Текст; + КонецПопытки; ЗакрытьСекретныеДанные(Значение, ИмяПараметра); diff --git a/.github/workflows/os/docs_main.os b/.github/workflows/os/docs_main.os index 406d83b231..339be0a316 100644 --- a/.github/workflows/os/docs_main.os +++ b/.github/workflows/os/docs_main.os @@ -143,6 +143,7 @@ Макет = СтрЗаменить(Макет, "@Объявление" , СтруктураМетода["Объявление"]); Макет = СтрЗаменить(Макет, "@ВозвращаемоеЗначение", СтруктураМетода["ВозвращаемоеЗначение"]); Макет = СтрЗаменить(Макет, "@Результат" , Результат); + Макет = СтрЗаменить(Макет, "@Примечание" , СтруктураМетода["Примечание"]); ТаблицаПараметров = ""; Вызов1С = ПолучитьВызов1С(СтруктураМетода["ИмяМодуля"], СтруктураМетода["ИмяМетода"]); @@ -361,7 +362,8 @@ СтруктураДанных.Вставить("ЕстьCLI", Истина); КонецЕсли; - МассивКомментария = СтрРазделить(ТекстКомментария, "//", Ложь); + ТекстКомментария = СтрЗаменить(ТекстКомментария, "//", "$"); + МассивКомментария = СтрРазделить(ТекстКомментария, "$", Ложь); Если МассивКомментария.Количество() = 0 Тогда Возврат Новый Массив; @@ -375,9 +377,12 @@ Процедура СформироватьСтруктуруМетода(Знач МассивКомментария, МассивПараметров, СтруктураДанных) - ОписаниеМетода = ""; - ЗаписыватьПараметры = Ложь; - ЗаписыватьОписание = Истина; + ОписаниеМетода = ""; + ЗаписыватьПараметры = Ложь; + ЗаписыватьПримечание = Ложь; + ЗаписыватьОписание = Истина; + + ТекстПримечания = ""; Счетчик = 0; Для Каждого СтрокаКомментария Из МассивКомментария Цикл @@ -393,8 +398,14 @@ КонецЕсли; Если СтрНайти(СтрокаКомментария, "Параметры:") > 0 Тогда - ЗаписыватьПараметры = Истина; - ЗаписыватьОписание = Ложь; + ЗаписыватьПараметры = Истина; + ЗаписыватьОписание = Ложь; + ЗаписыватьПримечание = Ложь; + + ИначеЕсли СтрНайти(СтрокаКомментария, "Примечание:") > 0 Тогда + ЗаписыватьПараметры = Ложь; + ЗаписыватьОписание = Ложь; + ЗаписыватьПримечание = Истина; ИначеЕсли СтрНайти(СтрокаКомментария, "Возвращаемое значение:") > 0 Тогда СтруктураДанных.Вставить("ВозвращаемоеЗначение", МассивКомментария[Счетчик]); @@ -406,14 +417,33 @@ МассивПараметров.Добавить(СтрокаКомментария); + ИначеЕсли ЗаписыватьПримечание = Истина Тогда + + ТекстПримечания = ТекстПримечания + СтрокаКомментария + Символы.ПС; + Иначе Продолжить; КонецЕсли; КонецЦикла; - СтруктураДанных.Вставить("Описание" , ОписаниеМетода); - СтруктураДанных.Вставить("Заголовок", СтрЗаменить(СокрЛП(МассивКомментария[0]), "!NOCLI", "")); + ТекстПримечания = СокрЛП(ТекстПримечания); + + Если ЗначениеЗаполнено(ТекстПримечания) Тогда + + ТекстПримечания = СтрЗаменить(ТекстПримечания, "@", "https://"); + + ТекстПримечания = ":::tip" + + Символы.ПС + + ТекстПримечания + + Символы.ПС + + ":::"; + + КонецЕсли; + + СтруктураДанных.Вставить("Описание" , ОписаниеМетода); + СтруктураДанных.Вставить("Заголовок" , СтрЗаменить(СокрЛП(МассивКомментария[0]), "!NOCLI", "")); + СтруктураДанных.Вставить("Примечание", ТекстПримечания); КонецПроцедуры @@ -492,6 +522,18 @@ КонецЕсли; + Если ЗначениеЗаполнено(Результат) Тогда + + Результат = "```bsl title=""Пример кода""" + + Символы.ПС + + Результат + + Символы.ПС + + "```" + + Символы.ПС; + + КонецЕсли; + + Возврат Результат; КонецФункции @@ -636,6 +678,13 @@ Если ЗначениеЗаполнено(Результат) Тогда Результат = Лев(Результат, СтрДлина(Результат) - 1); + + Результат = "```json title=""Результат""" + + Символы.ПС + + Результат + + Символы.ПС + + "```"; + КонецЕсли; Возврат СокрЛП(Результат); diff --git a/.github/workflows/os/template.md b/.github/workflows/os/template.md index 52501f5629..c2fa4e90fd 100644 --- a/.github/workflows/os/template.md +++ b/.github/workflows/os/template.md @@ -6,6 +6,11 @@ sidebar_position: @Счетчик @Описание +@Примечание + +
+ + *@Объявление* | Параметр | CLI опция | Тип | Назначение | @@ -14,11 +19,9 @@ sidebar_position: @Счетчик Возвращаемое значение: @ВозвращаемоеЗначение -```bsl title="Пример кода" - -@Вызов1С - -``` + +@Вызов1С + ```sh title="Пример команды CLI" @@ -26,9 +29,4 @@ sidebar_position: @Счетчик ``` - -```json title="Результат" - @Результат - -``` diff --git a/docs/en/md/Airtable/Comment-management/Create-comment.md b/docs/en/md/Airtable/Comment-management/Create-comment.md index e6081425c9..90694b75af 100644 --- a/docs/en/md/Airtable/Comment-management/Create-comment.md +++ b/docs/en/md/Airtable/Comment-management/Create-comment.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a comment for a record in the table + + +
+ + *Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 2 Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "id": "comL1oGEDJvIQlMs1", "author": { "id": "usrFlaAHlTfYWAbVW", @@ -53,5 +57,4 @@ sidebar_position: 2 "createdTime": "2024-05-10T19:39:51.561Z", "lastUpdatedTime": null } - ``` diff --git a/docs/en/md/Airtable/Comment-management/Delete-comment.md b/docs/en/md/Airtable/Comment-management/Delete-comment.md index 9ede76990e..b9c128749b 100644 --- a/docs/en/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/en/md/Airtable/Comment-management/Delete-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes a comment for a table record + + +
+ + *Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 4 Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -39,12 +45,9 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "id": "comL1oGEDJvIQlMs1", "deleted": true } - ``` diff --git a/docs/en/md/Airtable/Comment-management/Edit-comment.md b/docs/en/md/Airtable/Comment-management/Edit-comment.md index 0127497ea1..8870ee8b4f 100644 --- a/docs/en/md/Airtable/Comment-management/Edit-comment.md +++ b/docs/en/md/Airtable/Comment-management/Edit-comment.md @@ -6,6 +6,11 @@ sidebar_position: 3 Changes the text of an existing comment + + +
+ + *Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -32,8 +37,9 @@ sidebar_position: 3 Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "id": "comL1oGEDJvIQlMs1", "author": { "id": "usrFlaAHlTfYWAbVW", @@ -55,5 +59,4 @@ sidebar_position: 3 "createdTime": "2024-05-10T19:39:52Z", "lastUpdatedTime": "2024-05-10T19:39:51.967Z" } - ``` diff --git a/docs/en/md/Airtable/Comment-management/Get-comments.md b/docs/en/md/Airtable/Comment-management/Get-comments.md index 35a6a4f314..f2febf7a9c 100644 --- a/docs/en/md/Airtable/Comment-management/Get-comments.md +++ b/docs/en/md/Airtable/Comment-management/Get-comments.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of comments for a record in the table + + +
+ + *Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -29,8 +34,9 @@ sidebar_position: 1 Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "comments": [ { "id": "comL1oGEDJvIQlMs1", @@ -57,5 +61,4 @@ sidebar_position: 1 ], "offset": null } - ``` diff --git a/docs/en/md/Airtable/Record-management/Create-posts.md b/docs/en/md/Airtable/Record-management/Create-posts.md index a8f0dd96cb..1209e0eaba 100644 --- a/docs/en/md/Airtable/Record-management/Create-posts.md +++ b/docs/en/md/Airtable/Record-management/Create-posts.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates one or an array of records by description or an array of field value descriptions + + +
+ + *Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -36,8 +41,9 @@ sidebar_position: 3 Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "records": [ { "id": "recjHNKNZBWLZkZ7A", @@ -68,5 +72,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/en/md/Airtable/Record-management/Delete-posts.md b/docs/en/md/Airtable/Record-management/Delete-posts.md index 650253cf12..37bd353d75 100644 --- a/docs/en/md/Airtable/Record-management/Delete-posts.md +++ b/docs/en/md/Airtable/Record-management/Delete-posts.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes one or an array of records by identifiers + + +
+ + *Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -31,8 +36,9 @@ sidebar_position: 4 Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "records": [ { "deleted": true, @@ -55,5 +59,4 @@ sidebar_position: 4 } ] } - ``` diff --git a/docs/en/md/Airtable/Record-management/Get-list-of-records.md b/docs/en/md/Airtable/Record-management/Get-list-of-records.md index bd9a7a5e48..f8dc260e35 100644 --- a/docs/en/md/Airtable/Record-management/Get-list-of-records.md +++ b/docs/en/md/Airtable/Record-management/Get-list-of-records.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of records of the selected table + + +
+ + *Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -27,8 +32,9 @@ sidebar_position: 1 Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "records": [ { "id": "recGyJ0MlN1H3GMuN", @@ -67,5 +71,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Airtable/Record-management/Get-record.md b/docs/en/md/Airtable/Record-management/Get-record.md index 6aaae5c7bf..dddfa60acc 100644 --- a/docs/en/md/Airtable/Record-management/Get-record.md +++ b/docs/en/md/Airtable/Record-management/Get-record.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets row data of the table by identifier + + +
+ + *Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -28,8 +33,9 @@ sidebar_position: 2 Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "id": "recV6DxeLQMBNJrUk", "createdTime": "2024-05-10T19:39:51Z", "fields": { @@ -48,5 +52,4 @@ sidebar_position: 2 "String": "Hello\n" } } - ``` diff --git a/docs/en/md/Airtable/Table-management/Create-table.md b/docs/en/md/Airtable/Table-management/Create-table.md index 893acd2be1..93246d574e 100644 --- a/docs/en/md/Airtable/Table-management/Create-table.md +++ b/docs/en/md/Airtable/Table-management/Create-table.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a new table in the base + + +
+ + *Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; TableName = "TestTable2"; @@ -39,8 +44,9 @@ sidebar_position: 1 Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -48,10 +54,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "id": "tblT64aWyrMUAbUmF", "name": "TestTable2", "description": "NewTable", @@ -122,5 +126,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Airtable/Table-management/Modify-table.md b/docs/en/md/Airtable/Table-management/Modify-table.md index 213dd5fd03..0f3d4203c5 100644 --- a/docs/en/md/Airtable/Table-management/Modify-table.md +++ b/docs/en/md/Airtable/Table-management/Modify-table.md @@ -6,6 +6,11 @@ sidebar_position: 2 Changes the name and/or description of the base + + +
+ + *Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 2 Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "id": "tblT64aWyrMUAbUmF", "name": "Test table 2 (change.)", "description": "New table (change.)", @@ -113,5 +117,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/en/md/Airtable/Working-with-databases/Create-database.md b/docs/en/md/Airtable/Working-with-databases/Create-database.md index c77c294aca..0bc5899819 100644 --- a/docs/en/md/Airtable/Working-with-databases/Create-database.md +++ b/docs/en/md/Airtable/Working-with-databases/Create-database.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates a new database + + +
+ + *Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Workspace = "wspdf8yl1yZz3PmWZ"; Name = "TestDatabase"; @@ -36,8 +41,9 @@ sidebar_position: 3 Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "id": "applEsyJmBRm12AuN", "tables": [ { @@ -80,5 +84,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md b/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md index 536cda604e..a38bd86770 100644 --- a/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md +++ b/docs/en/md/Airtable/Working-with-databases/Get-database-tables.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the schema of base tables + + +
+ + *Function GetDatabaseTables(Val Token, Val Base) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "tables": [ { "id": "tblqZzW78Rvsdt9gt", @@ -67,5 +71,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md index 2042ef0900..d15987383b 100644 --- a/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ b/docs/en/md/Airtable/Working-with-databases/Get-list-of-bases.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of available bases + + +
+ + *Function GetListOfBases(Val Token, Val Indent = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,15 +21,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Response = OPI_Airtable.GetListOfBases(Token); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "bases": [ { "id": "appGarzKZ0lu3gzoa", @@ -84,5 +88,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Create-field.md b/docs/en/md/Airtable/Working-with-fields/Create-field.md index c59a975270..51fcc9d19e 100644 --- a/docs/en/md/Airtable/Working-with-fields/Create-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Create-field.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a new field in the table + + +
+ + *Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -29,8 +34,9 @@ sidebar_position: 1 Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "type": "number", "options": { "precision": 0 @@ -49,5 +53,4 @@ sidebar_position: 1 "id": "fld3IbFtHZtBHQwsk", "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md b/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md index a3248d49bc..9164dab5e3 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-attachment-field.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gets the description of a file field + + +
+ + *Function GetAttachmentField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 5 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Attachment"; Response = OPI_Airtable.GetAttachmentField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "name": "Attachment", "type": "multipleAttachments" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md b/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md index 9d665afbc3..cd17e309f8 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-checkbox-field.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets the description of a boolean field + + +
+ + *Function GetCheckboxField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 6 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Checkbox"; Response = OPI_Airtable.GetCheckboxField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "name": "Checkbox", "type": "checkbox", "options": { @@ -43,5 +47,4 @@ sidebar_position: 6 "color": "yellowBright" } } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-date-field.md b/docs/en/md/Airtable/Working-with-fields/Get-date-field.md index 6e160442c9..4ae74d90a3 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-date-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-date-field.md @@ -6,6 +6,11 @@ sidebar_position: 7 Gets the description of a date field + + +
+ + *Function GetDateField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 7 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Date"; Response = OPI_Airtable.GetDateField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "name": "Date", "type": "date", "options": { @@ -45,5 +49,4 @@ sidebar_position: 7 } } } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-email-field.md b/docs/en/md/Airtable/Working-with-fields/Get-email-field.md index a827b200ab..dd5397c5c4 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-email-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-email-field.md @@ -6,6 +6,11 @@ sidebar_position: 8 Gets the description of an email field + + +
+ + *Function GetEmailField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 8 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Email"; Response = OPI_Airtable.GetEmailField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "name": "Email", "type": "email" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-link-field.md b/docs/en/md/Airtable/Working-with-fields/Get-link-field.md index a4f457e366..daa170f433 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-link-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-link-field.md @@ -6,6 +6,11 @@ sidebar_position: 10 Gets the description of a URL field + + +
+ + *Function GetLinkField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 10 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Link"; Response = OPI_Airtable.GetLinkField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "name": "Link", "type": "url" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-number-field.md b/docs/en/md/Airtable/Working-with-fields/Get-number-field.md index 078afd3785..331c569fb7 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-number-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-number-field.md @@ -6,6 +6,11 @@ sidebar_position: 4 Gets the description of a numeric field + + +
+ + *Function GetNumberField(Val Name, Val Precision = 0) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 4 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Number"; Precision = "0"; @@ -25,8 +30,9 @@ sidebar_position: 4 Response = OPI_Airtable.GetNumberField(Name, Precision); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,15 +40,12 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "name": "Number", "type": "number", "options": { "precision": 0 } } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md b/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md index f316995118..ebd440b4a0 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-phone-field.md @@ -6,6 +6,11 @@ sidebar_position: 9 Gets the description of a phone number field + + +
+ + *Function GetPhoneField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 9 Returns: Structure - Field description + ```bsl title="Code example" - Name = "Phone"; Response = OPI_Airtable.GetPhoneField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "name": "Phone", "type": "phoneNumber" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Get-string-field.md b/docs/en/md/Airtable/Working-with-fields/Get-string-field.md index a9cc1017eb..e3b9dc2310 100644 --- a/docs/en/md/Airtable/Working-with-fields/Get-string-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Get-string-field.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets the description of a string field + + +
+ + *Function GetStringField(Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -15,16 +20,17 @@ sidebar_position: 3 Returns: Structure - Field description + ```bsl title="Code example" - Name = "String"; Response = OPI_Airtable.GetStringField(Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "name": "String", "type": "richText" } - ``` diff --git a/docs/en/md/Airtable/Working-with-fields/Modify-field.md b/docs/en/md/Airtable/Working-with-fields/Modify-field.md index fea078cb54..3a0c155521 100644 --- a/docs/en/md/Airtable/Working-with-fields/Modify-field.md +++ b/docs/en/md/Airtable/Working-with-fields/Modify-field.md @@ -6,6 +6,11 @@ sidebar_position: 2 Changes the name and/or description of an existing table field + + +
+ + *Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Airtable + ```bsl title="Code example" - Base = "apptm8Xqo7TwMaipQ"; Table = "tbl9G4jVoTJpxYwSY"; @@ -32,8 +37,9 @@ sidebar_position: 2 Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "type": "number", "options": { "precision": 0 @@ -53,5 +57,4 @@ sidebar_position: 2 "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)", "description": "New description" } - ``` 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 new file mode 100644 index 0000000000..311f2ab103 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -0,0 +1,67 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "504"; + + Text = "Task impossible, let's split up"; + + Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text); + + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 new file mode 100644 index 0000000000..837258ebb8 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -0,0 +1,73 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + CommentID = "1718"; + + Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + CommentID = "1720"; + + 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 new file mode 100644 index 0000000000..1cc31d309a --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -0,0 +1,62 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + CommentID = "1718"; + + Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + CommentID = "1720"; + + 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 new file mode 100644 index 0000000000..cd166d0014 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -0,0 +1,64 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "504"; + CommentID = "1718"; + + Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + CommentID = "1720"; + + 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 new file mode 100644 index 0000000000..d2ae3a0b23 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -0,0 +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 Key-Value - 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 new file mode 100644 index 0000000000..e4a6625f66 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -0,0 +1,86 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "504"; + + Result = OPI_Bitrix24.GetResultsList(URL, TaskID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 new file mode 100644 index 0000000000..3edeaeb3f9 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -0,0 +1,72 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + CommentID = "1718"; + TaskID = "504"; + + Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + CommentID = "1720"; + + 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 new file mode 100644 index 0000000000..f9ca3640af --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -0,0 +1,80 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "504"; + + Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 new file mode 100644 index 0000000000..fb78ba9fdc --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -0,0 +1,69 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "504"; + CommentID = "1718"; + + Text = "The task has been changed, do not split up"; + + Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + CommentID = "1720"; + + 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/Comments-and-results-managment/_category_.json b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json new file mode 100644 index 0000000000..cb2da26e66 --- /dev/null +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Comments and results managment", +"position": "5" +} \ No newline at end of file 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 new file mode 100644 index 0000000000..ad1047d906 --- /dev/null +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md @@ -0,0 +1,64 @@ +--- +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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + Text = "Comment for post"; + PostID = "260"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text); + + + Text = "Another comment"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Feed-posts-managment/Add-post-recipients.md b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md index 2e7d54687c..6312e283b4 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md @@ -6,6 +6,11 @@ sidebar_position: 7 Adds new groups or users to the recipients + + +
+ + *Function AddPostRecipients(Val URL, Val PostID, Val Visibility, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - Visibility = "UA"; PostID = "124"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -31,8 +36,9 @@ sidebar_position: 7 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token); - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1718473318.17435, @@ -56,5 +60,4 @@ sidebar_position: 7 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md index ccc915e7c4..4289739307 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md @@ -6,6 +6,13 @@ sidebar_position: 1 Create a new post at news feed +:::tip +API method: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +::: + +
+ + *Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -21,8 +28,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - Text = "Text of post"; Title = "Post title"; Image1 = "https://openintegrations.dev/test_data/picture.jpg"; @@ -42,8 +49,9 @@ sidebar_position: 1 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.CreatePost(URL, Text,, Files, Title,, Token); - ``` + + ```sh title="CLI command example" @@ -51,10 +59,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "result": 18, "time": { "start": 1718130364.82176, @@ -67,5 +73,4 @@ sidebar_position: 1 "operating": 0.637988090515137 } } - ``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md index d18b302fd3..88eb9537f4 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Delete-post.md @@ -6,6 +6,11 @@ sidebar_position: 3 Remove post from a news feed + + +
+ + *Function DeletePost(Val URL, Val PostID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - PostID = "122"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -30,8 +35,9 @@ sidebar_position: 3 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.DeletePost(URL, PostID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1718130367.40777, @@ -55,5 +59,4 @@ sidebar_position: 3 "operating": 0.310499906539917 } } - ``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md b/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md index b0b1f364f2..68c6bfbf82 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md @@ -6,6 +6,11 @@ sidebar_position: 4 Return list of important post viewers ids + + +
+ + *Function GetImportantPostViewers(Val URL, Val PostID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - PostID = "122"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -29,8 +34,9 @@ sidebar_position: 4 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "result": [ "1" ], @@ -56,5 +60,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md b/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md index b0e556cd5d..7135c41154 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Get-posts.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gen post or array of post with ID or rights selection + + +
+ + *Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - PostID = "124"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -30,8 +35,9 @@ sidebar_position: 5 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetPosts(URL, PostID,, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "result": [ { "ID": "40", @@ -410,5 +414,4 @@ sidebar_position: 5 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md index 9cca015e6a..4d812cfabe 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -6,6 +6,11 @@ sidebar_position: 2 Change post data + + +
+ + *Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -21,8 +26,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - Text = "New post text"; Title = "New post title"; Image1 = "https://openintegrations.dev/test_data/picture.jpg"; @@ -41,8 +46,9 @@ sidebar_position: 2 PostID = "122"; Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title, Token); - ``` + + ```sh title="CLI command example" @@ -50,10 +56,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "result": 86, "time": { "start": 1718473311.53949, @@ -66,5 +70,4 @@ sidebar_position: 2 "operating": 0.326629877090454 } } - ``` diff --git a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md new file mode 100644 index 0000000000..1aa9b946ef --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -0,0 +1,71 @@ +--- +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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + Name = "New stage"; + Color = "0026FF"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6); + + + PrevStageID = Result["result"]; + + Name = "New stage 2"; + Color = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 new file mode 100644 index 0000000000..7b01a41e1c --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 2 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + StageID = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True); + + + StageID = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 new file mode 100644 index 0000000000..e781764e3a --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -0,0 +1,554 @@ +--- +sidebar_position: 3 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.GetKanbanStages(URL,, True); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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 withplanandроinаны", + "SORT": "4000", + "COLOR": "00C4FB", + "SYSTEM_TYPE": "", + "ENTITY_ID": "1", + "ENTITY_TYPE": "U", + "ADDITIONAL_FILTER": [], + "TO_UPDATE": [], + "TO_UPDATE_ACCESS": null + }, + "4": { + "ID": "4", + "TITLE": "Сделаю to notделе", + "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 new file mode 100644 index 0000000000..871ef258ba --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 4 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + TaskID = "528"; + StageID = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID); + + + StageID = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/_category_.json b/docs/en/md/Bitrix24/Kanban/_category_.json new file mode 100644 index 0000000000..1213e3f67d --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Kanban", +"position": "6" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md b/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md index c014be6e85..d7844f91f2 100644 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Forms a link for authorization via the browser + + +
+ + *Function GetAppAuthLink(Val Domain, Val ClientID) Export* | Parameter | CLI option | Type | Destination | @@ -16,11 +21,15 @@ sidebar_position: 1 Returns: String - URL for browser transition + ```bsl title="Code example" + Domain = "b24-ar17wx.bitrix24.by"; + ClientID = "local.6667fc928a50a9.70414732"; + + Result = OPI_Bitrix24.GetAppAuthLink(Domain, ClientID); +``` - -``` ```sh title="CLI command example" @@ -28,9 +37,6 @@ sidebar_position: 1 ``` - ```json title="Result" - -"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" - + "https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" ``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md b/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md index beb900d7c3..23b7f6d88c 100644 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Get token by auth code + + +
+ + *Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - ClientID = "local.6667fc928a50a9.70414732"; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "error": "expired_token", "error_description": "The authorization token provided has expired." } - ``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md b/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md index 7043ab2fa2..9e8e0e8ae9 100644 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Update token by refresh token + + +
+ + *Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - ClientID = "local.6667fc928a50a9.70414732"; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; Refresh = "a95e9b66006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh); - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "access_token": "63a46866006e9f06006b12e4000000010000071997e1f54c1043e9f7193734af3018df", "expires": 1718133859, "expires_in": 3600, @@ -49,5 +53,4 @@ sidebar_position: 3 "user_id": 1, "refresh_token": "53239066006e9f06006b12e4000000010000078523b1fc75d58d6f0fa98b4632bc70ce" } - ``` diff --git a/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md b/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md index d8d60adbe5..6b932dfd2b 100644 --- a/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md +++ b/docs/en/md/Bitrix24/Settings-and-administartion/Server-time.md @@ -6,6 +6,11 @@ sidebar_position: 4 Get current server time + + +
+ + *Function ServerTime(Val URL, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Result = OPI_Bitrix24.ServerTime(URL); @@ -27,8 +32,9 @@ sidebar_position: 4 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.ServerTime(URL, Token); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "result": "2024-06-13T18:40:54+00:00", "time": { "start": 1718304054.57877, @@ -52,5 +56,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md index 114ccce646..dcf8f67f89 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md @@ -6,6 +6,11 @@ sidebar_position: 7 Create new foldera at the storage + + +
+ + *Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - StorageID = 3; Name = "New catalog"; Filename2 = "New folder 2"; @@ -34,8 +39,9 @@ sidebar_position: 7 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); - ``` + + ```sh title="CLI command example" @@ -43,10 +49,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "result": { "ID": 574, "NAME": "New catalog", @@ -75,5 +79,4 @@ sidebar_position: 7 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md new file mode 100644 index 0000000000..2e4e6e700b --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 9 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + FolderID = "2490"; + Name = "New subfolder"; + Filename2 = "New subfolder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2); + + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Delete-file.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-file.md index 42adf2ca59..2a9dc6013a 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-file.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-file.md @@ -1,11 +1,16 @@ --- -sidebar_position: 8 +sidebar_position: 12 --- # Delete file Delete file by ID + + +
+ + *Function DeleteFile(Val URL, Val FileID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; FileID = "488"; @@ -30,8 +35,9 @@ sidebar_position: 8 FileID = "478"; Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1718783933.86753, @@ -55,5 +59,4 @@ sidebar_position: 8 "operating": 3.73615193367004 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-folder.md index edfe7a09ed..1710e8fea3 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-folder.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Delete-folder.md @@ -1,11 +1,16 @@ --- -sidebar_position: 9 +sidebar_position: 13 --- # Delete folder Remove folder with subfolders + + +
+ + *Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; FolderID = "480"; @@ -30,8 +35,9 @@ sidebar_position: 9 FolderID = "482"; Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1719047257.50616, @@ -55,5 +59,4 @@ sidebar_position: 9 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md index 6062538e9c..bc8c33efe1 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md @@ -6,6 +6,11 @@ sidebar_position: 2 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 | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "b24-ar17wx.bitrix24.by"; Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetAppSotrage(URL, Token); - ``` + + ```sh title="CLI command example" @@ -32,8 +38,3 @@ sidebar_position: 2 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md new file mode 100644 index 0000000000..35edd1ea0c --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 21 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FileID = "2484"; + + Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-file-information.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-information.md new file mode 100644 index 0000000000..6ce02f3020 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-file-information.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 20 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FileID = "2484"; + + Result = OPI_Bitrix24.GetFileInformation(URL, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-folder-external-link.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md new file mode 100644 index 0000000000..d5dfcdf8c0 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 14 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FolderID = "2490"; + + Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-folder-filter-structure.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md new file mode 100644 index 0000000000..18910c1d65 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 27 +--- + +# 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 not-webhook method used | + + + Returns: Structure of Key-Value - Fields structure + + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.GetFolderFilterStructure(URL); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-folder-information.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md new file mode 100644 index 0000000000..9e59f5ee94 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 8 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FolderID = "2490"; + + Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-folder-items.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md new file mode 100644 index 0000000000..34c8158c61 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md @@ -0,0 +1,98 @@ +--- +sidebar_position: 15 +--- + +# 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 Key-Value | Items filter (see GetFolderFilterStructure) | + | Token | --token | String | Access token, when not-webhook 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/4swokunb3tk7h7dt/"; + FolderID = "2490"; + + Result = OPI_Bitrix24.GetFolderItems(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Get-storage-objects.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md index 4c3fb1fa79..e56f3c64fd 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md @@ -6,6 +6,11 @@ sidebar_position: 5 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 | @@ -17,8 +22,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; StorageID = 3; Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); @@ -28,8 +33,9 @@ sidebar_position: 5 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "result": [ { "ID": "568", @@ -95,5 +99,4 @@ sidebar_position: 5 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage.md index 96ccc08d27..ab1723aeeb 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storage.md @@ -6,6 +6,11 @@ sidebar_position: 3 Get information about storage + + +
+ + *Function GetStorage(Val URL, Val StorageID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; StorageID = 3; @@ -29,8 +34,9 @@ sidebar_position: 3 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "result": { "ID": "3", "NAME": "Main drive", @@ -62,5 +66,4 @@ sidebar_position: 3 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md index e2def9e47d..9a9b777410 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Get list of available files storages + + +
+ + *Function GetStoragesList(Val URL, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Result = OPI_Bitrix24.GetStoragesList(URL); @@ -26,8 +31,9 @@ sidebar_position: 1 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetStoragesList(URL, Token); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "result": [ { "ID": "3", @@ -116,5 +120,4 @@ sidebar_position: 1 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md new file mode 100644 index 0000000000..adec4cbabd --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 24 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + FolderID = "2488"; + FileID = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID); + + + FolderID = "2490"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token); + + Check_BitrixFile(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/Storages-and-files-managment/Make-folder-copy.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md new file mode 100644 index 0000000000..d3256a960e --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 10 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + DestinationID = "2492"; + FolderID = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID); + + + DestinationID = "2494"; + FolderID = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token); + + Check_BitrixFile(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/Storages-and-files-managment/Mark-file-as-deleted.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md new file mode 100644 index 0000000000..860b119d63 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 22 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FileID = "2484"; + + Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Mark-folder-as-deleted.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md new file mode 100644 index 0000000000..6e6285c0b3 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 16 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FolderID = "2490"; + + Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Move-file-to-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md new file mode 100644 index 0000000000..1e2a240122 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 25 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + FolderID = "2492"; + FileID = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID); + + + FolderID = "2494"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token); + + Check_BitrixFile(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/Storages-and-files-managment/Move-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Move-folder.md new file mode 100644 index 0000000000..dc79df40e7 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Move-folder.md @@ -0,0 +1,84 @@ +--- +sidebar_position: 11 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + DestinationID = "2488"; + FolderID = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID); + + + FolderID = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token); + + Check_BitrixFile(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/Storages-and-files-managment/Rename-file.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-file.md new file mode 100644 index 0000000000..9a97bf98c6 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-file.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 26 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + Name = "New file name.jpg"; + Filename2 = "New file name 2.jpg"; + + FileID2 = "2482"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2); + + + FileID = "2484"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Rename-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-folder.md new file mode 100644 index 0000000000..b762661a75 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-folder.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 18 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + Name = "New catalog"; + Filename2 = "New folder 2"; + + FolderID2 = "2488"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2); + + + FolderID = "2490"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Rename-storage.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-storage.md index 61ddff3cfa..61a50cbe10 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-storage.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Rename-storage.md @@ -6,6 +6,11 @@ sidebar_position: 4 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 | @@ -18,16 +23,17 @@ sidebar_position: 4 Returns: HTTPResponse - Rename storage + ```bsl title="Code example" - Name = "New storage name"; URL = "b24-ar17wx.bitrix24.by"; Token = "b9df7366006e9f06006b12e400000001000..."; StorageID = "18"; Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "result": { "ID": "18", "NAME": "New storage name", @@ -59,5 +63,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/Restore-file.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Restore-file.md new file mode 100644 index 0000000000..1b07a2e88d --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Restore-file.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 23 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FileID = "2484"; + + Result = OPI_Bitrix24.RestoreFile(URL, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Restore-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Restore-folder.md new file mode 100644 index 0000000000..0be5af7acc --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Restore-folder.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 17 +--- + +# 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 not-webhook 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/4swokunb3tk7h7dt/"; + FolderID = "2490"; + + Result = OPI_Bitrix24.RestoreFolder(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Upload-file-to-folder.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md new file mode 100644 index 0000000000..484ffb8a23 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 19 +--- + +# 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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```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 = "2490"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID); + + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Storages-and-files-managment/Upload-file-to-storage.md b/docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md index 6d8a96c95f..3557ee6326 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md @@ -6,6 +6,11 @@ sidebar_position: 6 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 | @@ -20,8 +25,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - Filename2 = "Picture2.jpg"; Name = "Picture1.jpg"; @@ -40,8 +45,9 @@ sidebar_position: 6 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token); - ``` + + ```sh title="CLI command example" @@ -49,10 +55,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "result": { "ID": 356, "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", @@ -84,5 +88,4 @@ sidebar_position: 6 "operating": 0.227726936340332 } } - ``` diff --git a/docs/en/md/Bitrix24/Storages-and-files-managment/_category_.json b/docs/en/md/Bitrix24/Storages-and-files-managment/_category_.json index 557e06e361..300185e9f7 100644 --- a/docs/en/md/Bitrix24/Storages-and-files-managment/_category_.json +++ b/docs/en/md/Bitrix24/Storages-and-files-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Storages and files managment", -"position": "5" +"position": "7" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md b/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md index bb1341112d..ff5442cac7 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md @@ -6,6 +6,11 @@ sidebar_position: 17 Add task to favorites list + + +
+ + *Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 17 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 17 TaskID = "170"; Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 17 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1718569733.98858, @@ -55,5 +59,4 @@ sidebar_position: 17 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md index a8ffeb30ef..fd6f8578ef 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md @@ -6,6 +6,11 @@ sidebar_position: 7 Approve task by ID + + +
+ + *Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 7 TaskID = "170"; Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -213,5 +217,4 @@ sidebar_position: 7 "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 new file mode 100644 index 0000000000..f25e5321fa --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -0,0 +1,66 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "500"; + FileID = "2480"; + + Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + TaskID = "502"; + + 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 new file mode 100644 index 0000000000..3439aab9c4 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -0,0 +1,126 @@ +--- +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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + ArrayOfUsers = New Array; + ArrayOfUsers.Add("1"); + ArrayOfUsers.Add("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + TaskID = "500"; + + Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + TaskID = "502"; + + 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/Complete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md index 1136e1e105..52abf522c2 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md @@ -6,6 +6,11 @@ sidebar_position: 9 Complete task by ID + + +
+ + *Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 9 TaskID = "170"; Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 9 "operating": 0.312941789627075 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md b/docs/en/md/Bitrix24/Tasks-managment/Create-task.md index dcbd0b7678..f2f0dd8934 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-task.md @@ -1,24 +1,29 @@ --- -sidebar_position: 4 +sidebar_position: 3 --- # Create task Create new task by fields structure (see GetTaskFieldsStructure) + + +
+ + *Function CreateTask(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 Key-Value | Task fields structure | + | FieldsStructure | --fields | Structure of Key-Value | Task fields structure (see GetTaskFieldsStructure) | | Token | --token | String | Access token, when not-webhook method used | Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() CurrentDate = OPI_Tools.GetCurrentDate(); @@ -43,8 +48,9 @@ sidebar_position: 4 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token); - ``` + + ```sh title="CLI command example" @@ -52,10 +58,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -198,5 +202,4 @@ sidebar_position: 4 "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 new file mode 100644 index 0000000000..fecaea83d3 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -0,0 +1,70 @@ +--- +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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + +```bsl title="Code example" + FromID = "500"; + DestinationID = "502"; + LinkType = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType); + + + FromID = "502"; + DestinationID = "500"; + LinkType = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + + 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/Defer-task.md b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md index cd5ef7c159..d568aba7b3 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md @@ -6,6 +6,11 @@ sidebar_position: 11 Defer task by ID + + +
+ + *Function DeferTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 11 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 11 TaskID = "170"; Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 11 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 11 "operating": 0.131969928741455 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md index 4465a56974..8e06423c6f 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md @@ -6,6 +6,11 @@ sidebar_position: 16 Delegate task to another user + + +
+ + *Function DelegateTask(Val URL, Val TaskID, Val UserID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 16 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; UserID = "10"; @@ -32,8 +37,9 @@ sidebar_position: 16 TaskID = "170"; Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token); - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 16 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "154", @@ -197,5 +201,4 @@ sidebar_position: 16 "operating": 0.450687170028686 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md index 7ee5975938..2ebb20b90f 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 6 +sidebar_position: 5 --- # Delete task Delete task by ID + + +
+ + *Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 6 TaskID = "170"; Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "result": { "task": true }, @@ -57,5 +61,4 @@ sidebar_position: 6 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md new file mode 100644 index 0000000000..f0f5e291b6 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -0,0 +1,37 @@ +--- +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 not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + + + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% + +``` + + diff --git a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md index 6af5a0f184..4ca1738c2e 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md @@ -6,6 +6,11 @@ sidebar_position: 8 Disapprove task by ID + + +
+ + *Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 8 TaskID = "170"; Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,12 +45,9 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "error": 1048582, "error_description": "Action on the task is not allowed" } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md index 1ecbd39c50..1597d51b7c 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md @@ -1,11 +1,16 @@ --- -sidebar_position: 1 +sidebar_position: 25 --- # Get task fields structure Gets a structure with a description of the fields for creating a task + + +
+ + *Function GetTaskFieldsStructure(Val URL, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Result = OPI_Bitrix24.GetTaskFieldsStructure(URL); @@ -27,8 +32,9 @@ sidebar_position: 1 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "result": { "fields": { "ID": { @@ -420,5 +424,4 @@ sidebar_position: 1 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md index 104a893323..a9c6dadb3d 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md @@ -6,6 +6,11 @@ sidebar_position: 19 Get history of task changing + + +
+ + *Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 19 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 19 TaskID = "170"; Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 19 ``` - ```json title="Result" - -{ + { "result": { "list": [ { @@ -298,5 +302,4 @@ sidebar_position: 19 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task.md index 186f813a3d..5003aad43a 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 2 +sidebar_position: 1 --- # Get task Get task by ID + + +
+ + *Function GetTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 2 TaskID = "170"; Result = OPI_Bitrix24.GetTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 2 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md index bb1e848e7f..a34d6cea0a 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md @@ -1,11 +1,16 @@ --- -sidebar_position: 21 +sidebar_position: 26 --- # Get structure of tasks filter Return filter structure for GetTasksList + + +
+ + *Function GetTasksFilterStructure(Val Clear = False) Export* | Parameter | CLI option | Type | Destination | @@ -15,11 +20,9 @@ sidebar_position: 21 Returns: Structure of Key-Value - Fields structure -```bsl title="Code example" - -``` + ```sh title="CLI command example" @@ -28,8 +31,3 @@ sidebar_position: 21 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md index 85029ea2c5..6f47c907aa 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md @@ -1,11 +1,16 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- # Get tasks list Get tasks list (50 at one response max)) + + +
+ + *Function GetTasksList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - // Full filter structer you can find at GetTasksFilterStructure method Filter = New Structure; Filter.Insert("CREATED_BY", 1); @@ -35,8 +40,9 @@ sidebar_position: 3 Token = "b9df7366006e9f06006b12e400000001000..."; Result = OPI_Bitrix24.GetTasksList(URL,, Indent, Token); - ``` + + ```sh title="CLI command example" @@ -44,10 +50,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "result": { "tasks": [ { @@ -4015,5 +4019,4 @@ sidebar_position: 3 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md new file mode 100644 index 0000000000..aeceae89ad --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md @@ -0,0 +1,192 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "500"; + + Result = OPI_Bitrix24.MuteTask(URL, TaskID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + TaskID = "502"; + + 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/Pause-task.md b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md index 7fc134f9ed..3710ef5c82 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md @@ -6,6 +6,11 @@ sidebar_position: 12 Pause a task by ID + + +
+ + *Function PauseTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 12 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 12 TaskID = "170"; Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 12 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 12 "operating": 0.149271011352539 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md b/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md index e99b61025f..48106fe922 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md @@ -6,6 +6,11 @@ sidebar_position: 18 Delete task from favorites list + + +
+ + *Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 18 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 18 TaskID = "170"; Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 18 ``` - ```json title="Result" - -{ + { "result": true, "time": { "start": 1718569735.08926, @@ -55,5 +59,4 @@ sidebar_position: 18 "operating": 0 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md index 432e599606..f4ab78c376 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md @@ -6,6 +6,11 @@ sidebar_position: 10 Returns a task to work by ID + + +
+ + *Function RenewTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 10 TaskID = "170"; Result = OPI_Bitrix24.RenewTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 10 "operating": 0.26146388053894 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md b/docs/en/md/Bitrix24/Tasks-managment/Start-task.md index 220fa42c73..bf6a1298ba 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-task.md @@ -6,6 +6,11 @@ sidebar_position: 13 Start a task by ID + + +
+ + *Function StartTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 13 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 13 TaskID = "170"; Result = OPI_Bitrix24.StartTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 13 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 13 "operating": 0.14000415802002 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md index 9389c8fcc4..7fba2c6efc 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md @@ -6,6 +6,11 @@ sidebar_position: 14 Start watching a task by ID + + +
+ + *Function StartWatchingTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 14 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 14 TaskID = "170"; Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 14 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -195,5 +199,4 @@ sidebar_position: 14 "operating": 0.279598951339722 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md index 3328097156..56d7706052 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md @@ -6,6 +6,11 @@ sidebar_position: 15 Stop watching a task by ID + + +
+ + *Function StopWatchingTask(Val URL, Val TaskID, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 15 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; TaskID = "168"; @@ -30,8 +35,9 @@ sidebar_position: 15 TaskID = "170"; Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID, Token); - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 15 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 15 "operating": 0.175670862197876 } } - ``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md new file mode 100644 index 0000000000..9d83ca66f3 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -0,0 +1,192 @@ +--- +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 not-webhook 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/4swokunb3tk7h7dt/"; + TaskID = "500"; + + Result = OPI_Bitrix24.UnmuteTask(URL, TaskID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "56898d66006e9f06006b12e400000001000..."; + TaskID = "502"; + + 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/Tasks-managment/Update-task.md b/docs/en/md/Bitrix24/Tasks-managment/Update-task.md index 6a1b608ca9..46a94c2aac 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Update-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Update-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 5 +sidebar_position: 4 --- # Update task Update a task + + +
+ + *Function UpdateTask(Val URL, Val TaskID, Val FieldsStructure, Val Token = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + ```bsl title="Code example" - // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() TaskData = New Structure; @@ -38,8 +43,9 @@ sidebar_position: 5 TaskID = "170"; Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData, Token); - ``` + + ```sh title="CLI command example" @@ -47,10 +53,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "result": { "task": { "id": "110", @@ -193,5 +197,4 @@ sidebar_position: 5 "operating": 0.202054023742676 } } - ``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md index b9bb6e9da4..2790b7fe0d 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md @@ -6,6 +6,11 @@ sidebar_position: 4 Gets account information + + +
+ + *Function GetAccountInformation(Val Token, Val Account = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,13 +21,14 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.GetAccountInformation(Token); - ``` + + ```sh title="CLI command example" @@ -30,17 +36,15 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", "name": { "given_name": "Anton", "surname": "Titovets", "familiar_name": "Anton", "display_name": "Anton Titovets", - "abbreviated_name": "АТ" + "abbreviated_name": "AT" }, "email": "bayselonarrend@gmail.com", "email_verified": true, @@ -58,5 +62,4 @@ sidebar_position: 4 "home_namespace_id": "3179550035" } } - ``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md index fedff6859e..9af190428c 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Generates an authorization link for browser transition + + +
+ + *Function GetAuthorizationLink(Val AppKey) Export* | Parameter | CLI option | Type | Destination | @@ -15,12 +20,13 @@ sidebar_position: 1 Returns: String - URL for browser transition + ```bsl title="Code example" - AppKey = "oynqxds..."; Result = OPI_Dropbox.GetAuthorizationLink(AppKey); - ``` + + ```sh title="CLI command example" @@ -28,9 +34,6 @@ sidebar_position: 1 ``` - ```json title="Result" - -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" - + "https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" ``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md b/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md index 55f89f9d00..3d83c2fb09 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gets information on the amount of used disk space + + +
+ + *Function GetSpaceUsageData(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,13 +20,14 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.GetSpaceUsageData(Token); - ``` + + ```sh title="CLI command example" @@ -29,15 +35,12 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "used": 1477493597, "allocation": { ".tag": "individual", "allocated": 2147483648 } } - ``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Get-token.md b/docs/en/md/Dropbox/Account-and-authorization/Get-token.md index d791adf927..fd018226f8 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Get-token.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets token based on the code from the GetAuthorizationLink page + + +
+ + *Function GetToken(Val AppKey, Val AppSecret, Val Code) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - AppKey = "oynqxds..."; AppSecret = "tk2oewn..."; Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "error": "invalid_grant", "error_description": "code doesn't exist or has expired" } - ``` diff --git a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md index 8eff2d1839..6af858f484 100644 --- a/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md +++ b/docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets a new token based on the refresh token + + +
+ + *Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - AppKey = "oynqxds..."; AppSecret = "tk2oewn..."; RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); - ``` + + ```sh title="CLI command example" @@ -33,13 +39,10 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", "token_type": "bearer", "expires_in": 14400 } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md index 3c65dcfff6..4e5aeef935 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Copy-object.md @@ -6,6 +6,11 @@ sidebar_position: 8 Copies a file or directory to the selected path + + +
+ + *Function CopyObject(Val Token, Val From, Val Target) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Original = "/New/pic.png"; Copy = "/New/pic_copy.png"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.CopyObject(Token, Original, Copy); - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "metadata": { ".tag": "file", "name": "pic_copy.png", @@ -51,5 +55,4 @@ sidebar_position: 8 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md index e1bf3dd637..2b2a49946e 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 10 Creates an empty directory at the selected path + + +
+ + *Function CreateFolder(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New catalog"; Result = OPI_Dropbox.CreateFolder(Token, Path); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "metadata": { "name": "New catalog", "path_lower": "/new catalog", @@ -42,5 +46,4 @@ sidebar_position: 10 "id": "id:kJU6-a-pT48AAAAAAAABZA" } } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md index d84d2919a7..15c94caeed 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 7 Deletes an object from the cloud drive + + +
+ + *Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Path = "/New/pic.png"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.DeleteObject(Token, Path); - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "metadata": { ".tag": "file", "name": "pic.png", @@ -50,5 +54,4 @@ sidebar_position: 7 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-file.md b/docs/en/md/Dropbox/File-and-directory-management/Download-file.md index 3d723c92aa..3acd379b85 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-file.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 11 Downloads a file by the specified path or ID + + +
+ + *Function DownloadFile(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 11 Returns: BinaryData - binary data of the file + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/pic.png"; Result = OPI_Dropbox.DownloadFile(Token, Path); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 11 ``` - ```json title="Result" - -NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… - + NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md index 340c6b5fa4..0474291b19 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Download-folder.md @@ -6,6 +6,11 @@ sidebar_position: 12 Downloads a zip archive with the contents of the specified directory + + +
+ + *Function DownloadFolder(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 12 Returns: BinaryData - binary data of the zip archive with the contents of the directory + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New"; Result = OPI_Dropbox.DownloadFolder(Token, Path); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 12 ``` - ```json title="Result" - -NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… - + NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md b/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md index 1c675e465c..cb27fec4b9 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified + + +
+ + *Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,14 +23,15 @@ sidebar_position: 2 Returns: HTTPResponse - Get list of folder files + ```bsl title="Code example" - Path = "/New"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); - ``` + + ```sh title="CLI command example" @@ -33,9 +39,7 @@ sidebar_position: 2 ``` - ```json title="Result" - { "entries": [ { @@ -68,5 +72,4 @@ sidebar_position: 2 "cursor": "AAEXfuMhG6Xl2ENYH4uAoLS_nOUV4SC7ChaMxK4ZIphj9x5INumYZrHv6jqph4fgkOy6PpFTTaaJ4BTjzVGZnTk7tB5wCCp1Eogn8gCW-Agz-ej4X6ir5p-KX63vBgDV0OZ-boy78oUXMJeOtU9sjEij34BoqBCtWYOFje4PXhEV3KwVySRWzPlXSEq9arMo1AaP8PFuDxx6JTxSGRdcQwnc", "has_more": false } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md index 682d33e0e3..70e6d0eaea 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets information about a file or directory + + +
+ + *Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Path = "/New/pic.png"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { ".tag": "file", "name": "pic.png", "path_lower": "/new/pic.png", @@ -48,5 +52,4 @@ sidebar_position: 1 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md b/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md index 8189555e9a..dc9aa26828 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md @@ -6,6 +6,11 @@ sidebar_position: 13 Gets the list of versions (revisions) of the object + + +
+ + *Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 13 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/pic.png"; Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 13 ``` - ```json title="Result" - -{ + { "is_deleted": false, "entries": [ { @@ -52,5 +56,4 @@ sidebar_position: 13 } ] } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md index 218663a796..5d58f232be 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-preview.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets PDF or HTML preview of the object (for documents only) + + +
+ + *Function GetPreview(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 3 Returns: BinaryData - document preview + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/mydoc.docx"; Result = OPI_Dropbox.GetPreview(Token, Path); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 3 ``` - ```json title="Result" - -NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… - + NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md b/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md index 61665701ed..0cdc0b6d51 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets the upload status of the file by URL + + +
+ + *Function GetUploadStatusByURL(Val Token, Val JobID) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; WorkID = "G8YbueOu2nsAAAAAAAAAAQ"; Status = "in_progress"; @@ -31,8 +36,9 @@ sidebar_position: 6 EndDo; - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { ".tag": "complete", "name": "url_doc.docx", "path_lower": "/new/url_doc.docx", @@ -56,5 +60,4 @@ sidebar_position: 6 "is_downloadable": true, "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Move-object.md b/docs/en/md/Dropbox/File-and-directory-management/Move-object.md index d3feb21df9..6090a634ed 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Move-object.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Move-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Moves an object to the selected path + + +
+ + *Function MoveObject(Val Token, Val From, Val Target) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - OriginalPath = "/New/pic.png"; TargetPath = "/pic.png"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "metadata": { ".tag": "file", "name": "pic.png", @@ -51,5 +55,4 @@ sidebar_position: 9 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md b/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md index de60635264..cfef95e399 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md @@ -6,6 +6,11 @@ sidebar_position: 14 Restores object state to required version (revision) + + +
+ + *Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 14 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Version = "61a0b76320a6fbd841553"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/pic.png"; Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 14 ``` - ```json title="Result" - -{ + { "name": "pic.png", "path_lower": "/new/pic.png", "path_display": "/New/pic.png", @@ -48,5 +52,4 @@ sidebar_position: 14 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md b/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md index f1b70c6c5d..53728139ca 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 5 Uploads a file to the cloud drive by fetching it from the specified URL + + +
+ + *Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Path = "/New/url_doc.docx"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; URL = "https://openintegrations.dev/test_data/document.docx"; Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { ".tag": "async_job_id", "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" } - ``` diff --git a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md index ff68ecfae6..4765ed7531 100644 --- a/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/en/md/Dropbox/File-and-directory-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Uploads a file to the cloud drive + + +
+ + *Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Path = "/New/pic.png"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Image = "https://openintegrations.dev/test_data/picture.jpg"; @@ -28,8 +33,9 @@ sidebar_position: 4 FileCopy(Image, ImagePath); Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "name": "pic.png", "path_lower": "/new/pic.png", "path_display": "/New/pic.png", @@ -52,5 +56,4 @@ sidebar_position: 4 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md index c899fbb98d..144bef27b3 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Defines access to the file for an external user + + +
+ + *Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export* | Parameter | CLI option | Type | Destination | @@ -18,15 +23,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Email = "h5bk6ft62s@privaterelay.appleid.com"; File = "kJU6-a-pT48AAAAAAAAABw"; Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -[ + [ { "member": { ".tag": "email", @@ -55,5 +59,4 @@ sidebar_position: 3 ] } ] - ``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md index b405074b3a..4006d90261 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md @@ -6,6 +6,11 @@ sidebar_position: 4 Grants external users access to the directory + + +
+ + *Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export* | Parameter | CLI option | Type | Destination | @@ -18,15 +23,16 @@ sidebar_position: 4 Returns: Undefined - empty response + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Email = "h5bk6ft62s@privaterelay.appleid.com"; Folder = "5022319569"; // shared_folder_id Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); - ``` + + ```sh title="CLI command example" @@ -34,9 +40,6 @@ sidebar_position: 4 ``` - ```json title="Result" - -{} - + {} ``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md index c3510b6742..7879b86702 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md @@ -6,6 +6,11 @@ sidebar_position: 6 Prohibits access to the file for external users + + +
+ + *Function CancelFilePublication(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; File = "kJU6-a-pT48AAAAAAAAABw"; Result = OPI_Dropbox.CancelFilePublication(Token, File); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 6 ``` - ```json title="Result" - -{} - + {} ``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md index 28803195ab..90193d5813 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md @@ -6,6 +6,11 @@ sidebar_position: 2 Cancels the public access mode for the directory + + +
+ + *Function CancelFolderPublication(Val Token, Val FolderID) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Folder = "5022319569"; @@ -30,8 +35,9 @@ sidebar_position: 2 CurrentStatus = Result[".tag"]; OPI_Tools.Pause(3); EndDo; - ``` + + ```sh title="CLI command example" @@ -39,11 +45,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { ".tag": "complete" } - ``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md b/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md index 74ee0eaeaa..706eabe340 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md @@ -6,6 +6,11 @@ sidebar_position: 5 Get async job status for access changes + + +
+ + *Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export* | Parameter | CLI option | Type | Destination | @@ -16,11 +21,9 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox -```bsl title="Code example" - -``` + ```sh title="CLI command example" @@ -29,8 +32,3 @@ sidebar_position: 5 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md index 248cb23556..e93bf2f921 100644 --- a/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md +++ b/docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md @@ -6,6 +6,11 @@ sidebar_position: 1 Sets the directory to public access mode + + +
+ + *Function PublishFolder(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New"; Result = OPI_Dropbox.PublishFolder(Token, Path); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { ".tag": "complete", "access_type": { ".tag": "owner" @@ -63,5 +67,4 @@ sidebar_position: 1 }, "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" } - ``` diff --git a/docs/en/md/Dropbox/Tags-managment/Add-tag.md b/docs/en/md/Dropbox/Tags-managment/Add-tag.md index 1b4f3e784f..bfd4974ef2 100644 --- a/docs/en/md/Dropbox/Tags-managment/Add-tag.md +++ b/docs/en/md/Dropbox/Tags-managment/Add-tag.md @@ -6,6 +6,11 @@ sidebar_position: 2 Add new tag to file or folder + + +
+ + *Function AddTag(Val Token, Val Path, Val Tag) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Tag = "Important"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/mydoc.docx"; Result = OPI_Dropbox.AddTag(Token, Path, Tag); - ``` + + ```sh title="CLI command example" @@ -33,9 +39,6 @@ sidebar_position: 2 ``` - ```json title="Result" - -{} - + {} ``` diff --git a/docs/en/md/Dropbox/Tags-managment/Delete-tag.md b/docs/en/md/Dropbox/Tags-managment/Delete-tag.md index efc6452b04..19458c9c9c 100644 --- a/docs/en/md/Dropbox/Tags-managment/Delete-tag.md +++ b/docs/en/md/Dropbox/Tags-managment/Delete-tag.md @@ -6,6 +6,11 @@ sidebar_position: 3 Deletes the text tag of a file or directory + + +
+ + *Function DeleteTag(Val Token, Val Path, Val Tag) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Tag = "Important"; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Path = "/New/mydoc.docx"; Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); - ``` + + ```sh title="CLI command example" @@ -33,9 +39,6 @@ sidebar_position: 3 ``` - ```json title="Result" - -{} - + {} ``` diff --git a/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md b/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md index fbf4a9b913..3f974c725b 100644 --- a/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md +++ b/docs/en/md/Dropbox/Tags-managment/Get-tag-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of tags of the selected files + + +
+ + *Function GetTagList(Val Token, Val Paths) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Dropbox + ```bsl title="Code example" - Token = "sl.B22821SXrkmxs9KAaC6M_ax_M33mEcEvKz9sqgcMO8Xwn0bvpx4_57UQqLR_gEuPS_Yk5yd3Tv..."; PathsArray = New Array; @@ -25,8 +30,9 @@ sidebar_position: 1 PathsArray.Add("/New/mydoc.docx"); Result = OPI_Dropbox.GetTagList(Token, PathsArray); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "paths_to_tags": [ { "path": "/New/Dogs.mp3", @@ -54,5 +58,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md index 52c344f9a1..6b2ccbd0eb 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Adds an existing calendar to the user's list + + +
+ + *Function AddCalendarToList(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -53,5 +57,4 @@ sidebar_position: 2 "etag": "\"1708423365033000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md index 2e3d69d536..5844c9c151 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md @@ -6,6 +6,11 @@ sidebar_position: 4 Removes a calendar from the user's list + + +
+ + *Function DeleteCalendarFromList(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 4 ``` - ```json title="Result" - -"" - + "" ``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md b/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md index 56caab8e9a..ecaecf809c 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 5 Edits the properties of a calendar from the user's list + + +
+ + *Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Black = "#000000"; @@ -29,8 +34,9 @@ sidebar_position: 5 Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -59,5 +63,4 @@ sidebar_position: 5 "etag": "\"1708424005038000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md b/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md index badd047c3f..11c04d6864 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets an array of account calendars + + +
+ + *Function GetCalendarList(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Array of calendar data mappings + ```bsl title="Code example" - Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -[ + [ { "conferenceProperties": { "allowedConferenceSolutionTypes": [ @@ -169,5 +173,4 @@ sidebar_position: 1 "kind": "calendar#calendarListEntry" } ] - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md b/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md index 4ca68c04dd..77d50929f2 100644 --- a/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets a calendar from the user's list by ID + + +
+ + *Function GetListCalendar(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -52,5 +56,4 @@ sidebar_position: 3 "etag": "\"1708423563386000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md index 707a448e81..7e397668ed 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 4 Clears the event list of the primary calendar + + +
+ + *Function ClearMainCalendar(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,13 +20,14 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.ClearMainCalendar(Token); - ``` + + ```sh title="CLI command example" @@ -29,9 +35,6 @@ sidebar_position: 4 ``` - ```json title="Result" - -"" - + "" ``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md index e07ab298fb..c300326dcb 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates an empty calendar + + +
+ + *Function CreateCalendar(Val Token, Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -46,5 +50,4 @@ sidebar_position: 1 "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md index 031c67ae42..ede6f70f79 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 5 Deletes a calendar by ID + + +
+ + *Function DeleteCalendar(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0..."); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 5 ``` - ```json title="Result" - -"" - + "" ``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md index 9c4f77bfff..a6d1414365 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md @@ -6,6 +6,11 @@ sidebar_position: 3 Edits properties of an existing calendar + + +
+ + *Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,16 +23,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Name = "TestCalendar (change.)"; Description = "TestDescription"; Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -51,5 +55,4 @@ sidebar_position: 3 "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md b/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md index 332ee20094..dddfee9fae 100644 --- a/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md +++ b/docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets calendar information by ID + + +
+ + *Function GetCalendarMetadata(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -47,5 +51,4 @@ sidebar_position: 2 "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Create-event.md b/docs/en/md/Google_Calendar/Event-management/Create-event.md index fb9bd68d0b..da7b3304e3 100644 --- a/docs/en/md/Google_Calendar/Event-management/Create-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Create-event.md @@ -6,6 +6,11 @@ sidebar_position: 4 Creates a new event + + +
+ + *Function CreateEvent(Val Token, Val Calendar, Val EventDescription) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response + ```bsl title="Code example" - Attachments = New Map; Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); @@ -36,8 +41,9 @@ sidebar_position: 4 Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMap); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "eventType": "default", "attachments": [ { @@ -94,5 +98,4 @@ sidebar_position: 4 "etag": "\"3417013976948000\"", "kind": "calendar#event" } - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Delete-event.md b/docs/en/md/Google_Calendar/Event-management/Delete-event.md index aecaf70b0f..16a2cc8def 100644 --- a/docs/en/md/Google_Calendar/Event-management/Delete-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Delete-event.md @@ -6,6 +6,11 @@ sidebar_position: 7 Deletes an event by ID + + +
+ + *Function DeleteEvent(Val Token, Val Calendar, Val Event) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -32,9 +38,6 @@ sidebar_position: 7 ``` - ```json title="Result" - -"" - + "" ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Edit-event.md b/docs/en/md/Google_Calendar/Event-management/Edit-event.md index 05ec9695ba..a275dc2abc 100644 --- a/docs/en/md/Google_Calendar/Event-management/Edit-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Edit-event.md @@ -6,6 +6,11 @@ sidebar_position: 6 Edits an existing event + + +
+ + *Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - EventMap = New Map; EventMap.Insert("Description", "Test event description (change.)"); @@ -27,8 +32,9 @@ sidebar_position: 6 Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMap, "j4nonfcc0m2..."); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "eventType": "default", "attachments": [ { @@ -85,5 +89,4 @@ sidebar_position: 6 "etag": "\"3417542724802000\"", "kind": "calendar#event" } - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-description.md b/docs/en/md/Google_Calendar/Event-management/Get-event-description.md index cad649a2f3..0c4dae4cd9 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-description.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-description.md @@ -6,6 +6,11 @@ sidebar_position: 1 + + +
+ + *Function GetEventDescription() Export* | Parameter | CLI option | Type | Destination | @@ -14,11 +19,9 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Empty event template -```bsl title="Code example" - -``` + ```sh title="CLI command example" @@ -26,10 +29,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -EventMap = New Map; + EventMap = New Map; EventMap.Insert("Description", ""); // Event description EventMap.Insert("Title", "New event"); // Title events EventMap.Insert("Venue", ""); // String description of the venue of the event @@ -37,5 +38,4 @@ EventMap = New Map; EventMap.Insert("EndDate", EventMap["StartDate"] + 3600); // Date of end events EventMap.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file EventMap.Insert("SendNotifications", True); // Indication of sending notifications to participants - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event-list.md b/docs/en/md/Google_Calendar/Event-management/Get-event-list.md index 382f388f28..8af58d7624 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event-list.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the list of all calendar events + + +
+ + *Function GetEventList(Val Token, Val Calendar) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Array of event maps + ```bsl title="Code example" - Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0..."); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -[ + [ { "eventType": "default", "attachments": [ @@ -82,5 +86,4 @@ sidebar_position: 2 "kind": "calendar#event" }, ] - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Get-event.md b/docs/en/md/Google_Calendar/Event-management/Get-event.md index 5cde0e3be6..4d4060a7fa 100644 --- a/docs/en/md/Google_Calendar/Event-management/Get-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Get-event.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets an event by ID + + +
+ + *Function GetEvent(Val Token, Val Calendar, Val Event) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "eventType": "default", "attachments": [ { @@ -81,5 +85,4 @@ sidebar_position: 3 "etag": "\"3417013976948000\"", "kind": "calendar#event" } - ``` diff --git a/docs/en/md/Google_Calendar/Event-management/Move-event.md b/docs/en/md/Google_Calendar/Event-management/Move-event.md index 166d13fe5b..2900f0bb6a 100644 --- a/docs/en/md/Google_Calendar/Event-management/Move-event.md +++ b/docs/en/md/Google_Calendar/Event-management/Move-event.md @@ -6,6 +6,11 @@ sidebar_position: 5 Moves an event to another calendar + + +
+ + *Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export* | Parameter | CLI option | Type | Destination | @@ -18,14 +23,15 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "eventType": "default", "attachments": [ { @@ -82,5 +86,4 @@ sidebar_position: 5 "etag": "\"3417540102468000\"", "kind": "calendar#event" } - ``` diff --git a/docs/en/md/Google_Drive/Comment-management/Create-comment.md b/docs/en/md/Google_Drive/Comment-management/Create-comment.md index c029319e3a..1db11bd009 100644 --- a/docs/en/md/Google_Drive/Comment-management/Create-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Create-comment.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a comment for a file or directory + + +
+ + *Function CreateComment(Val Token, Val Identifier, Val Comment) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; Comment = "NewComment"; @@ -26,8 +31,9 @@ sidebar_position: 1 Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "content": "NewComment", "htmlContent": "NewComment", "author": { @@ -54,5 +58,4 @@ sidebar_position: 1 "deleted": false, "id": "AAABI3NNNAY" } - ``` diff --git a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md b/docs/en/md/Google_Drive/Comment-management/Delete-comment.md index dc6257761e..ea9a9f960a 100644 --- a/docs/en/md/Google_Drive/Comment-management/Delete-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Delete-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes comment by ID + + +
+ + *Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map - ``` + + ```sh title="CLI command example" @@ -33,9 +39,6 @@ sidebar_position: 4 ``` - ```json title="Result" - -'' - + '' ``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md index 09f8a104c4..c6fed21867 100644 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets the list of all comments of the object + + +
+ + *Function GetCommentList(Val Token, Val ObjectID) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "comments": [ { "content": "NewComment", @@ -57,5 +61,4 @@ sidebar_position: 3 ], "kind": "drive#commentList" } - ``` diff --git a/docs/en/md/Google_Drive/Comment-management/Get-comment.md b/docs/en/md/Google_Drive/Comment-management/Get-comment.md index 1d51978783..7dd5257b3c 100644 --- a/docs/en/md/Google_Drive/Comment-management/Get-comment.md +++ b/docs/en/md/Google_Drive/Comment-management/Get-comment.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets comment by ID + + +
+ + *Function GetComment(Val Token, Val ObjectID, Val CommentID) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; CommentID = AAABI3NNNAY; @@ -26,8 +31,9 @@ sidebar_position: 2 Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "content": "NewComment", "htmlContent": "NewComment", "author": { @@ -54,5 +58,4 @@ sidebar_position: 2 "deleted": false, "id": "AAABI3NNNAY" } - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md b/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md index 7458d994fb..ac12ded957 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md @@ -6,6 +6,11 @@ sidebar_position: 7 Copies file or directory + + +
+ + *Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - NewName = "CopiedFile.jpeg"; NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; @@ -28,8 +33,9 @@ sidebar_position: 7 Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -37,14 +43,11 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "mimeType": "image/jpeg", "name": "CopiedFile.jpeg", "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", "kind": "drive#file" } - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md b/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md index 7bbcfc214b..2b6a9e47ec 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates an empty directory on the drive + + +
+ + *Function CreateFolder(Val Token, Val Name, Val Parent = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Name = "TestFolder"; Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -34,14 +40,11 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "mimeType": "application/vnd.google-apps.folder", "name": "TestFolder", "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", "kind": "drive#file" } - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md b/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md index 5528a17eb7..1806dc1477 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Deletes file or directory by ID + + +
+ + *Function DeleteObject(Val Token, Val Identifier) Export* | Parameter | CLI option | Type | Destination | @@ -16,15 +21,16 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map - ``` + + ```sh title="CLI command example" @@ -32,9 +38,6 @@ sidebar_position: 9 ``` - ```json title="Result" - -'' - + '' ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md index 509a7ce04b..dcb9bc7ece 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets file by ID + + +
+ + *Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 6 Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified + ```bsl title="Code example" - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -34,9 +40,6 @@ sidebar_position: 6 ``` - ```json title="Result" - - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md index 0994e634e2..d12ad565fa 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the list of drive directories + + +
+ + *Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Array of directory mappings + ```bsl title="Code example" - Name = "Description"; Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -[ + [ { "linkShareMetadata": { "securityUpdateEnabled": true, @@ -142,5 +146,4 @@ sidebar_position: 2 "kind": "drive#file" } ] - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md index 73ea36528a..c3175caf10 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md @@ -6,6 +6,11 @@ sidebar_position: 10 + + +
+ + *Function GetFileDescription() Export* | Parameter | CLI option | Type | Destination | @@ -14,8 +19,8 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - File description + ```bsl title="Code example" - Description = New Map; Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file @@ -25,8 +30,9 @@ sidebar_position: 10 Return Description; - ``` + + ```sh title="CLI command example" @@ -35,8 +41,3 @@ sidebar_position: 10 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md index 33b9d24767..07dca87569 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets the list of files + + +
+ + *Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Array of file mappings + ```bsl title="Code example" - Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -[ + [ { "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", "linkShareMetadata": { @@ -171,5 +175,4 @@ sidebar_position: 3 "size": "2114025" } ] - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md b/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md index 13eef35651..fe8553762e 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets information about a folder or file by ID + + +
+ + *Function GetObjectInformation(Val Token, Val Identifier) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "linkShareMetadata": { "securityUpdateEnabled": true, "securityUpdateEligible": false @@ -140,5 +144,4 @@ sidebar_position: 1 "kind": "drive#file", "thumbnailVersion": "0" } - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md index 5a1242536e..3f6d304f6a 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Update-file.md @@ -6,6 +6,11 @@ sidebar_position: 8 Updates file binary data + + +
+ + *Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - NewName = "Updated file.jpeg"; ReplacementImage = "C:\OPI\image2.jpg"; @@ -28,8 +33,9 @@ sidebar_position: 8 Response = OPI_GoogleDrive.UpdateFile(Token, Identifier, ReplacementImage, NewName) //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -37,14 +43,11 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "mimeType": "image/jpeg", "name": "UpdatedFile.jpg", "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", "kind": "drive#file" } - ``` diff --git a/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md b/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md index ee44b7a92a..60cda1c6da 100644 --- a/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md +++ b/docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Uploads a file to the drive + + +
+ + *Function UploadFile(Val Token, Val File, Val Description) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Description = New Map; Description.Insert("MIME", "image/jpeg"); @@ -31,8 +36,9 @@ sidebar_position: 4 Response = OPI_GoogleDrive.UploadFile(Token, Image, Description); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -40,14 +46,11 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "mimeType": "image/jpeg", "name": "New file.jpg", "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", "kind": "drive#file" } - ``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md b/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md index b2c39f8aea..8b42be7749 100644 --- a/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md +++ b/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md @@ -6,6 +6,11 @@ sidebar_position: 2 Clears the value in cells + + +
+ + *Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - CellsArray = New Array; CellsArray.Add("B2"); @@ -32,8 +37,9 @@ sidebar_position: 2 Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "clearedRanges": [ "'Sheet2'!B2", @@ -52,5 +56,4 @@ sidebar_position: 2 "'Sheet2'!B4" ] } - ``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md b/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md index 56b8197403..fd18fa3827 100644 --- a/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md +++ b/docs/en/md/Google_Sheets/Data-managment/Get-cell-values.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets cell values of the table + + +
+ + *Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - CellsArray = New Array; CellsArray.Add("B2"); @@ -32,8 +37,9 @@ sidebar_position: 3 Response = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "valueRanges": [ { @@ -76,5 +80,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md b/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md index 1ea75884cb..7cf293e4bf 100644 --- a/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md +++ b/docs/en/md/Google_Sheets/Data-managment/Set-cell-values.md @@ -6,6 +6,11 @@ sidebar_position: 1 Sets sheet cell values + + +
+ + *Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - ValueMapping = New Map; ValueMapping.Insert("A1", "ThisIsA1"); @@ -38,8 +43,9 @@ sidebar_position: 1 Response = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -47,10 +53,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "totalUpdatedRows": 4, "totalUpdatedColumns": 2, @@ -115,5 +119,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md index 6d9c1f3649..d7fd98ebbc 100644 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a new spreadsheet + + +
+ + *Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - ArrayOfSheetNames = New Array; ArrayOfSheetNames.Add("Sheet1"); @@ -29,8 +34,9 @@ sidebar_position: 1 Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "properties": { "title": "TestTable", @@ -202,5 +206,4 @@ sidebar_position: 1 ], "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" } - ``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md index 26d73c0d59..2d1e3ed856 100644 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md @@ -6,6 +6,11 @@ sidebar_position: 3 Changes the name of the existing spreadsheet + + +
+ + *Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -17,32 +22,30 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; - Name = "Test table (change.)"; + Name = "Test table (changed.)"; Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" - oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)" + oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (changed.)" ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ {} ] } - ``` diff --git a/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md b/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md index 0e94ca305d..ed471e4e85 100644 --- a/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md +++ b/docs/en/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets information about the spreadsheet by ID + + +
+ + *Function GetSpreadsheet(Val Token, Val Identifier) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,13 +39,11 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "properties": { - "title": "Test table (change.)", + "title": "Test table (changed.)", "locale": "ru_RU", "autoRecalc": "ON_CHANGE", "timeZone": "Etc/GMT", @@ -197,5 +201,4 @@ sidebar_position: 2 ], "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" } - ``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md index 5c18a6d8d3..9e9dee6e4e 100644 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Add-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Adds a new sheet to the spreadsheet + + +
+ + *Function AddSheet(Val Token, Val Spreadsheet, Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Name = "TestSheet"; @@ -26,8 +31,9 @@ sidebar_position: 1 Response = OPI_GoogleSheets.AddSheet(Token, Spreadsheet, Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ { @@ -57,5 +61,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md index 6cfdc52c88..b617f60ff2 100644 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Copy-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 3 Copies a sheet from one spreadsheet to another + + +
+ + *Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - From = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Target = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; @@ -28,8 +33,9 @@ sidebar_position: 3 Response = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "sheetId": 1790807910, "title": "Sheet2 (copy)", "index": 2, @@ -50,5 +54,4 @@ sidebar_position: 3 "columnCount": 26 } } - ``` diff --git a/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md b/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md index 085689c8d0..c9aaae3b77 100644 --- a/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md +++ b/docs/en/md/Google_Sheets/Working-with-sheets/Delete-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Deletes a sheet from the spreadsheet + + +
+ + *Function DeleteSheet(Val Token, Val Spreadsheet, Val Sheet) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Google + ```bsl title="Code example" - Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Sheet = "1790807910"; @@ -26,8 +31,9 @@ sidebar_position: 2 Response = OPI_GoogleSheets.DeleteSheet(Token, Spreadsheet, Sheet); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,14 +41,11 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ {} ] } - ``` diff --git a/docs/en/md/Notion/Blocks-managment/Create-block.md b/docs/en/md/Notion/Blocks-managment/Create-block.md index 9c9d366f75..a2ca0a4b3f 100644 --- a/docs/en/md/Notion/Blocks-managment/Create-block.md +++ b/docs/en/md/Notion/Blocks-managment/Create-block.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a new block based on an existing block + + +
+ + *Function CreateBlock(Val Token, Val Parent, Val Block, Val InsertAfter = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Parent = "5dd94c34fab04bff9..."; @@ -31,8 +36,9 @@ sidebar_position: 1 Response = OPI_Notion.CreateBlock(Token, Parent, "aa4137d4c8cc445d9f969c3968..."); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", "block": {}, "type": "block", @@ -96,5 +100,4 @@ sidebar_position: 1 ], "object": "list" } - ``` diff --git a/docs/en/md/Notion/Blocks-managment/Delete-block.md b/docs/en/md/Notion/Blocks-managment/Delete-block.md index 20e4679c8a..dc43e2fd76 100644 --- a/docs/en/md/Notion/Blocks-managment/Delete-block.md +++ b/docs/en/md/Notion/Blocks-managment/Delete-block.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes block by ID + + +
+ + *Function DeleteBlock(Val Token, Val BlockID) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Block = "ca18df269bd24407852b91c30..."; @@ -25,8 +30,9 @@ sidebar_position: 4 Response = OPI_Notion.DeleteBlock(Token, BlockID); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", "to_do": { "color": "default", @@ -82,5 +86,4 @@ sidebar_position: 4 "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", "object": "block" } - ``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-block.md b/docs/en/md/Notion/Blocks-managment/Return-block.md index 1be91a049b..0d6fe8f9a4 100644 --- a/docs/en/md/Notion/Blocks-managment/Return-block.md +++ b/docs/en/md/Notion/Blocks-managment/Return-block.md @@ -6,6 +6,11 @@ sidebar_position: 2 Returns the block structure by ID + + +
+ + *Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Block = "ca18df269bd24407852b91c30..."; @@ -26,8 +31,9 @@ sidebar_position: 2 Response = OPI_Notion.ReturnBlock(Token, BlockID); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", "to_do": { "color": "default", @@ -83,5 +87,4 @@ sidebar_position: 2 "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", "object": "block" } - ``` diff --git a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md index 7740bd8864..976cadbd39 100644 --- a/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md +++ b/docs/en/md/Notion/Blocks-managment/Return-child-blocks.md @@ -6,6 +6,11 @@ sidebar_position: 3 Returns list of child blocks of parent block + + +
+ + *Function ReturnChildBlocks(Val Token, Val BlockID) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Block = "46c1500ed40c4e89ba6a22900..."; @@ -25,8 +30,9 @@ sidebar_position: 3 Response = OPI_Notion.ReturnChildBlocks(Token, BlockID); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", "block": {}, "type": "block", @@ -133,5 +137,4 @@ sidebar_position: 3 ], "object": "list" } - ``` diff --git a/docs/en/md/Notion/Database-management/Create-database.md b/docs/en/md/Notion/Database-management/Create-database.md index 64eae62bd9..dec6dd736f 100644 --- a/docs/en/md/Notion/Database-management/Create-database.md +++ b/docs/en/md/Notion/Database-management/Create-database.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a database + + +
+ + *Function CreateDatabase(Val Token, Val Parent, Val Title, Val Properties = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Parent = "5dd94c34fab04bff9..."; @@ -47,8 +52,9 @@ sidebar_position: 1 Response = OPI_Notion.CreateDatabase(Token, Parent, Title, Properties); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -56,10 +62,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -195,5 +199,4 @@ sidebar_position: 1 }, "object": "database" } - ``` diff --git a/docs/en/md/Notion/Database-management/Edit-database-properties.md b/docs/en/md/Notion/Database-management/Edit-database-properties.md index 3db58d62fe..76b89c5d0c 100644 --- a/docs/en/md/Notion/Database-management/Edit-database-properties.md +++ b/docs/en/md/Notion/Database-management/Edit-database-properties.md @@ -6,6 +6,11 @@ sidebar_position: 3 Edits properties of an existing database + + +
+ + *Function EditDatabaseProperties(Val Token, Val Base, Val Properties = "", Val Title = "", Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Base = "5dd94c34fab04bff9..."; @@ -34,8 +39,9 @@ sidebar_position: 3 Response = OPI_Notion.EditDatabaseProperties(Token, Base, Properties, Title, Description); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -43,10 +49,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -194,5 +198,4 @@ sidebar_position: 3 }, "object": "database" } - ``` diff --git a/docs/en/md/Notion/Database-management/Get-database.md b/docs/en/md/Notion/Database-management/Get-database.md index e6ddd5f80e..3b8744f872 100644 --- a/docs/en/md/Notion/Database-management/Get-database.md +++ b/docs/en/md/Notion/Database-management/Get-database.md @@ -6,6 +6,11 @@ sidebar_position: 2 Get database information + + +
+ + *Function GetDatabase(Val Token, Val Base) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Base = "048ba0ce4f474e33900540d24..."; @@ -25,8 +30,9 @@ sidebar_position: 2 Response = OPI_Notion.GetDatabase(Token, Base); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -185,5 +189,4 @@ sidebar_position: 2 }, "object": "database" } - ``` diff --git a/docs/en/md/Notion/Page-management/Create-page-in-database.md b/docs/en/md/Notion/Page-management/Create-page-in-database.md index c388f164e5..bf35336b66 100644 --- a/docs/en/md/Notion/Page-management/Create-page-in-database.md +++ b/docs/en/md/Notion/Page-management/Create-page-in-database.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a page in the parent database + + +
+ + *Function CreatePageInDatabase(Val Token, Val Parent, Val Data) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Parent = "5dd94c34fab04bff9..."; @@ -40,8 +45,9 @@ sidebar_position: 2 Response = OPI_Notion.CreatePageInDatabase(Token, Base, Data); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -49,10 +55,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -198,5 +202,4 @@ sidebar_position: 2 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/en/md/Notion/Page-management/Create-page.md b/docs/en/md/Notion/Page-management/Create-page.md index e84a677491..3d1dcc2a00 100644 --- a/docs/en/md/Notion/Page-management/Create-page.md +++ b/docs/en/md/Notion/Page-management/Create-page.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a child page above another parent page + + +
+ + *Function CreatePage(Val Token, Val Parent, Val Title) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Parent = "5dd94c34fab04bff9..."; @@ -27,8 +32,9 @@ sidebar_position: 1 Response = OPI_Notion.CreatePage(Token, Parent, Title); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", "public_url": null, "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", @@ -88,5 +92,4 @@ sidebar_position: 1 "id": "4392f919-813c-4c8d-8401-7d973bddaabf", "object": "page" } - ``` diff --git a/docs/en/md/Notion/Page-management/Edit-page-properties.md b/docs/en/md/Notion/Page-management/Edit-page-properties.md index 8e65426dbe..f98a6128a7 100644 --- a/docs/en/md/Notion/Page-management/Edit-page-properties.md +++ b/docs/en/md/Notion/Page-management/Edit-page-properties.md @@ -6,6 +6,11 @@ sidebar_position: 4 Changes the properties of an existing page + + +
+ + *Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Page = "5dd94c34fab04bff9..."; @@ -41,8 +46,9 @@ sidebar_position: 4 Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -50,10 +56,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -209,5 +213,4 @@ sidebar_position: 4 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/en/md/Notion/Page-management/Get-page.md b/docs/en/md/Notion/Page-management/Get-page.md index 5c8c233264..8e034d3281 100644 --- a/docs/en/md/Notion/Page-management/Get-page.md +++ b/docs/en/md/Notion/Page-management/Get-page.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets information about the page by ID + + +
+ + *Function GetPage(Val Token, Val Page) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Page = "a574281614174169bf55dbae4..."; @@ -25,8 +30,9 @@ sidebar_position: 3 Response = OPI_Notion.GetPage(Token, Page); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "request_id": "61eaaa91-41fc-4523-a445-602805afb281", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -193,5 +197,4 @@ sidebar_position: 3 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/en/md/Notion/Users/Get-user-data.md b/docs/en/md/Notion/Users/Get-user-data.md index 499cd159e6..553b2e1079 100644 --- a/docs/en/md/Notion/Users/Get-user-data.md +++ b/docs/en/md/Notion/Users/Get-user-data.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets user data by ID + + +
+ + *Function GetUserData(Val Token, Val UserID) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; UserID = "ed71865a989146bc86cdwdf24..."; @@ -25,8 +30,9 @@ sidebar_position: 2 Response = OPI_Notion.GetUserData(Token, UserID); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", "person": { "email": "ex@gmail.com" @@ -48,5 +52,4 @@ sidebar_position: 2 "id": "ed71865a-9891-1111-86cd-1111111", "object": "user" } - ``` diff --git a/docs/en/md/Notion/Users/User-list.md b/docs/en/md/Notion/Users/User-list.md index 1657e3f2b9..bd7f883bf1 100644 --- a/docs/en/md/Notion/Users/User-list.md +++ b/docs/en/md/Notion/Users/User-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Returns a list of workspace users + + +
+ + *Function UserList(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,15 +20,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Notion + ```bsl title="Code example" - Token = "secret_9RsfMrRMqZwqp0Zl0B..."; Response = OPI_Notion.UserList(Token); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", "user": {}, "type": "user", @@ -68,5 +72,4 @@ sidebar_position: 1 ], "object": "list" } - ``` diff --git a/docs/en/md/Slack/Block-formation/Generate-image-block.md b/docs/en/md/Slack/Block-formation/Generate-image-block.md index 8f5b408b5c..34ba3a488c 100644 --- a/docs/en/md/Slack/Block-formation/Generate-image-block.md +++ b/docs/en/md/Slack/Block-formation/Generate-image-block.md @@ -6,6 +6,11 @@ sidebar_position: 1 Generates a block with an image to add to the message block array + + +
+ + *Function GenerateImageBlock(Val URL, Val AlternateText = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Image block + ```bsl title="Code example" - Text = "Alpaca picture"; URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; @@ -25,8 +30,9 @@ sidebar_position: 1 Response = OPI_Slack.GenerateImageBlock(URL, Text); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,13 +40,10 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "alt_text": "Yo", "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", "type": "image" } - ``` diff --git a/docs/en/md/Slack/Channel-management/Archive-channel.md b/docs/en/md/Slack/Channel-management/Archive-channel.md index b0a7836cb5..30da4502d0 100644 --- a/docs/en/md/Slack/Channel-management/Archive-channel.md +++ b/docs/en/md/Slack/Channel-management/Archive-channel.md @@ -6,6 +6,11 @@ sidebar_position: 4 Archives an active channel + + +
+ + *Function ArchiveChannel(Val Token, Val Channel) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; @@ -25,8 +30,9 @@ sidebar_position: 4 Response = OPI_Slack.ArchiveChannel(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,11 +40,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true } - ``` diff --git a/docs/en/md/Slack/Channel-management/Create-channel.md b/docs/en/md/Slack/Channel-management/Create-channel.md index 8319689f11..64262a79ea 100644 --- a/docs/en/md/Slack/Channel-management/Create-channel.md +++ b/docs/en/md/Slack/Channel-management/Create-channel.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates a new channel + + +
+ + *Function CreateChannel(Val Token, Val Name, Val Private = False) Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Name = "testcov" + String(New UUID); Response = OPI_Slack.CreateChannel(Token, Name, False); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -81,5 +85,4 @@ sidebar_position: 3 "priority": 0 } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-history.md b/docs/en/md/Slack/Channel-management/Get-channel-history.md index f0a01d7450..c0172fcd7a 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-history.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-history.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets information about channel events + + +
+ + *Function GetChannelHistory(Val Token, Val Channel) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.GetChannelHistory(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "ok": true, "messages": [ { @@ -76,5 +80,4 @@ sidebar_position: 6 "channel_actions_ts": null, "channel_actions_count": 0 } - ``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-list.md b/docs/en/md/Slack/Channel-management/Get-channel-list.md index dcd2868a23..1a2e9c2002 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-list.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets a list of available channels + + +
+ + *Function GetChannelList(Val Token, Val ExcludeArchived = False, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - ExcludeArchived = True; Response = OPI_Slack.GetChannelList(Token, ExcludeArchived); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "channels": [ { @@ -85,5 +89,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel-user-list.md b/docs/en/md/Slack/Channel-management/Get-channel-user-list.md index 1948a6d893..3d8508e8ae 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel-user-list.md +++ b/docs/en/md/Slack/Channel-management/Get-channel-user-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets a list of users in the specified channel + + +
+ + *Function GetChannelUserList(Val Token, Val Channel, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.GetChannelUserList(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "members": [ "U06UG1CAYH2" @@ -46,5 +50,4 @@ sidebar_position: 2 "next_cursor": "" } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Get-channel.md b/docs/en/md/Slack/Channel-management/Get-channel.md index f18afcd02a..0482b95ea7 100644 --- a/docs/en/md/Slack/Channel-management/Get-channel.md +++ b/docs/en/md/Slack/Channel-management/Get-channel.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gets information about the channel + + +
+ + *Function GetChannel(Val Token, Val Channel) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.GetChannel(Token, Channel); //Map Response = OPI_Tools.JSONString(Response);//JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -79,5 +83,4 @@ sidebar_position: 5 "previous_names": [] } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md index 10d1fe1b83..b5c8feabfd 100644 --- a/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md +++ b/docs/en/md/Slack/Channel-management/Invite-users-to-channel.md @@ -6,6 +6,11 @@ sidebar_position: 7 Adds specified users to the channel + + +
+ + *Function InviteUsersToChannel(Val Token, Val Channel, Val ArrayOfUsers) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; ArrayOfUsers = New Array; @@ -27,8 +32,9 @@ sidebar_position: 7 Response = OPI_Slack.InviteUsersToChannel(Token, Channel, ArrayOfUsers); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -82,5 +86,4 @@ sidebar_position: 7 "previous_names": [] } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Join-channel.md b/docs/en/md/Slack/Channel-management/Join-channel.md index 8fb5c040d0..05ae89645d 100644 --- a/docs/en/md/Slack/Channel-management/Join-channel.md +++ b/docs/en/md/Slack/Channel-management/Join-channel.md @@ -6,6 +6,11 @@ sidebar_position: 9 Adds the current bot to the channel + + +
+ + *Function JoinChannel(Val Token, Val Channel) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.JoinChannel(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 9 "priority": 0 } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md index 344112f1f9..e3269765c1 100644 --- a/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md +++ b/docs/en/md/Slack/Channel-management/Kick-user-from-channel.md @@ -6,6 +6,11 @@ sidebar_position: 8 Removes specified user from channel + + +
+ + *Function KickUserFromChannel(Val Token, Val Channel, Val User) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - User = "U06UG1CAYH2"; Channel = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 8 Response = OPI_Slack.KickUserFromChannel(Token, Channel, User); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,11 +41,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "ok": true } - ``` diff --git a/docs/en/md/Slack/Channel-management/Leave-channel.md b/docs/en/md/Slack/Channel-management/Leave-channel.md index b8fc3affae..fd691235b6 100644 --- a/docs/en/md/Slack/Channel-management/Leave-channel.md +++ b/docs/en/md/Slack/Channel-management/Leave-channel.md @@ -6,6 +6,11 @@ sidebar_position: 10 Removes the current bot from the channel + + +
+ + *Function LeaveChannel(Val Token, Val Channel) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.LeaveChannel(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "ok": true } - ``` diff --git a/docs/en/md/Slack/Channel-management/Rename-channel.md b/docs/en/md/Slack/Channel-management/Rename-channel.md index bbabddc6e3..0e09f2ac43 100644 --- a/docs/en/md/Slack/Channel-management/Rename-channel.md +++ b/docs/en/md/Slack/Channel-management/Rename-channel.md @@ -6,6 +6,11 @@ sidebar_position: 13 Changes the name of the channel + + +
+ + *Function RenameChannel(Val Token, Val Channel, Val Name) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 13 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Name = "testcov" + String(New UUID); Channel = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 13 Response = OPI_Slack.RenameChannel(Token, Channel, Name); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 13 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -83,5 +87,4 @@ sidebar_position: 13 ] } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-goal.md b/docs/en/md/Slack/Channel-management/Set-channel-goal.md index 673299db97..979c3b6f4c 100644 --- a/docs/en/md/Slack/Channel-management/Set-channel-goal.md +++ b/docs/en/md/Slack/Channel-management/Set-channel-goal.md @@ -6,6 +6,11 @@ sidebar_position: 12 Sets the channel purpose (description) + + +
+ + *Function SetChannelGoal(Val Token, Val Channel, Val Purpose) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 12 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Purpose = "TestGoal"; Channel = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 12 Response = OPI_Slack.SetChannelGoal(Token, Channel, Purpose); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 12 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 12 "previous_names": [] } } - ``` diff --git a/docs/en/md/Slack/Channel-management/Set-channel-topic.md b/docs/en/md/Slack/Channel-management/Set-channel-topic.md index 2c43201f5b..db895773f4 100644 --- a/docs/en/md/Slack/Channel-management/Set-channel-topic.md +++ b/docs/en/md/Slack/Channel-management/Set-channel-topic.md @@ -6,6 +6,11 @@ sidebar_position: 11 Sets the channel topic + + +
+ + *Function SetChannelTopic(Val Token, Val Channel, Val Topic) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 11 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Topic = "TestTopic"; @@ -26,8 +31,9 @@ sidebar_position: 11 Response = OPI_Slack.SetChannelTopic(Token, Channel, Topic); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 11 ``` - ```json title="Result" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 11 "previous_names": [] } } - ``` diff --git a/docs/en/md/Slack/Dialog-management/Close-dialog.md b/docs/en/md/Slack/Dialog-management/Close-dialog.md index d23d9f3b3c..33459abd5b 100644 --- a/docs/en/md/Slack/Dialog-management/Close-dialog.md +++ b/docs/en/md/Slack/Dialog-management/Close-dialog.md @@ -6,6 +6,11 @@ sidebar_position: 2 Closes an existing dialog + + +
+ + *Function CloseDialog(Val Token, Val Dialog) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Dialog = "D06UAKK1C6R"; Response = OPI_Slack.CloseDialog(Token, Dialog); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,13 +39,10 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "already_closed": false, "no_op": false } - ``` diff --git a/docs/en/md/Slack/Dialog-management/Open-dialog.md b/docs/en/md/Slack/Dialog-management/Open-dialog.md index 7015e21c05..3f66909dd1 100644 --- a/docs/en/md/Slack/Dialog-management/Open-dialog.md +++ b/docs/en/md/Slack/Dialog-management/Open-dialog.md @@ -6,6 +6,11 @@ sidebar_position: 1 Opens a new dialog with one or more users + + +
+ + *Function OpenDialog(Val Token, Val ArrayOfUsers) Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - ArrayOfUsers = New Array; ArrayOfUsers.Add("U123456"); @@ -26,8 +31,9 @@ sidebar_position: 1 Response = OPI_Slack.OpenDialog(Token, ArrayOfUsers); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "no_op": false, "already_open": false, @@ -46,5 +50,4 @@ sidebar_position: 1 "id": "D06UAKK1C6R" } } - ``` diff --git a/docs/en/md/Slack/External-files-management/Add-external-file.md b/docs/en/md/Slack/External-files-management/Add-external-file.md index ecb725b304..f9ec38ae5f 100644 --- a/docs/en/md/Slack/External-files-management/Add-external-file.md +++ b/docs/en/md/Slack/External-files-management/Add-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Adds a new external file + + +
+ + *Function AddExternalFile(Val Token, Val URL, Val Title) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - URL = https://opi.neocities.org/test_data/document.docx; Title = "NewFile"; @@ -26,8 +31,9 @@ sidebar_position: 3 Response = OPI_Slack.AddExternalFile(Token, URL, Title); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -76,5 +80,4 @@ sidebar_position: 3 "file_access": "visible" } } - ``` diff --git a/docs/en/md/Slack/External-files-management/Delete-external-file.md b/docs/en/md/Slack/External-files-management/Delete-external-file.md index 8a057df605..d811ea6c12 100644 --- a/docs/en/md/Slack/External-files-management/Delete-external-file.md +++ b/docs/en/md/Slack/External-files-management/Delete-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 5 Deletes an external file from Slack + + +
+ + *Function DeleteExternalFile(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - FileID = "F070P52CU94"; Response = OPI_Slack.DeleteExternalFile(Token, FileID); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true } - ``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file-list.md b/docs/en/md/Slack/External-files-management/Get-external-file-list.md index aba78e3df7..9e522949ff 100644 --- a/docs/en/md/Slack/External-files-management/Get-external-file-list.md +++ b/docs/en/md/Slack/External-files-management/Get-external-file-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets a list of external files of a user or channel + + +
+ + *Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.GetExternalFileList(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,15 +40,12 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "files": [], "response_metadata": { "next_cursor": "" } } - ``` diff --git a/docs/en/md/Slack/External-files-management/Get-external-file.md b/docs/en/md/Slack/External-files-management/Get-external-file.md index 4ee69ee933..7ba3312e31 100644 --- a/docs/en/md/Slack/External-files-management/Get-external-file.md +++ b/docs/en/md/Slack/External-files-management/Get-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets information about the external file + + +
+ + *Function GetExternalFile(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - FileID = "F070P52CU94"; Response = OPI_Slack.GetExternalFile(Token, FileID); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -74,5 +78,4 @@ sidebar_position: 2 "file_access": "visible" } } - ``` diff --git a/docs/en/md/Slack/External-files-management/Send-external-file.md b/docs/en/md/Slack/External-files-management/Send-external-file.md index 4b4d21da77..fbe807c994 100644 --- a/docs/en/md/Slack/External-files-management/Send-external-file.md +++ b/docs/en/md/Slack/External-files-management/Send-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Sends an external file to a list of channels + + +
+ + *Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; FileID = "F070P52CU94"; @@ -26,8 +31,9 @@ sidebar_position: 4 Response = OPI_Slack.SendExternalFile(Token, FileID, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -93,5 +97,4 @@ sidebar_position: 4 "file_access": "visible" } } - ``` diff --git a/docs/en/md/Slack/File-managment/Delete-file.md b/docs/en/md/Slack/File-managment/Delete-file.md index 53d33c6f09..5eabb6796b 100644 --- a/docs/en/md/Slack/File-managment/Delete-file.md +++ b/docs/en/md/Slack/File-managment/Delete-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes a file on Slack + + +
+ + *Function DeleteFile(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - FileID = "F070VL6FQFM"; Response = OPI_Slack.DeleteFile(Token, FileID); //Map Response = OPI_Tools.JSONString(Response);//JSON string - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true } - ``` diff --git a/docs/en/md/Slack/File-managment/Get-file-data.md b/docs/en/md/Slack/File-managment/Get-file-data.md index fa72f3b36a..796e6015a0 100644 --- a/docs/en/md/Slack/File-managment/Get-file-data.md +++ b/docs/en/md/Slack/File-managment/Get-file-data.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets information about the file + + +
+ + *Function GetFileData(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - FileID = "F070VL6FQFM"; Response = OPI_Slack.GetFileData(Token, FileID); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "file": { "id": "F070VL6FQFM", @@ -78,5 +82,4 @@ sidebar_position: 3 "next_cursor": "" } } - ``` diff --git a/docs/en/md/Slack/File-managment/Get-files-list.md b/docs/en/md/Slack/File-managment/Get-files-list.md index 2829708387..f700a93f75 100644 --- a/docs/en/md/Slack/File-managment/Get-files-list.md +++ b/docs/en/md/Slack/File-managment/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets a list of files of the bot or channel + + +
+ + *Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - PageNumber = 1; Channel = "C123456"; @@ -26,8 +31,9 @@ sidebar_position: 1 Response = OPI_Slack.GetFilesList(Token, Channel, PageNumber); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "files": [ { @@ -78,5 +82,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/Slack/File-managment/Make-file-private.md b/docs/en/md/Slack/File-managment/Make-file-private.md index 00397930d5..8df91e67d1 100644 --- a/docs/en/md/Slack/File-managment/Make-file-private.md +++ b/docs/en/md/Slack/File-managment/Make-file-private.md @@ -6,6 +6,11 @@ sidebar_position: 6 Removes the public URL from the file. Requires user token + + +
+ + *Function MakeFilePrivate(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,11 +21,9 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Slack -```bsl title="Code example" - -``` + ```sh title="CLI command example" @@ -29,8 +32,3 @@ sidebar_position: 6 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Slack/File-managment/Make-file-public.md b/docs/en/md/Slack/File-managment/Make-file-public.md index 8a7cf32c21..7243f8f1de 100644 --- a/docs/en/md/Slack/File-managment/Make-file-public.md +++ b/docs/en/md/Slack/File-managment/Make-file-public.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates a public URL for the file. Requires user token + + +
+ + *Function MakeFilePublic(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,11 +21,9 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Slack -```bsl title="Code example" - -``` + ```sh title="CLI command example" @@ -29,8 +32,3 @@ sidebar_position: 5 ``` -```json title="Result" - - - -``` diff --git a/docs/en/md/Slack/File-managment/Upload-file.md b/docs/en/md/Slack/File-managment/Upload-file.md index 798158cb17..fcb0f8ae65 100644 --- a/docs/en/md/Slack/File-managment/Upload-file.md +++ b/docs/en/md/Slack/File-managment/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 2 Uploads a file to Slack servers + + +
+ + *Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - FileName = "megadoc.docx"; File = New BinaryData("D:\" + FileName); @@ -30,8 +35,9 @@ sidebar_position: 2 Response = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); //Map Response = OPI_Tools.JSONString(Response);//JSON string - ``` + + ```sh title="CLI command example" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "files": [ { @@ -82,5 +86,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md index 9f72decd3f..2c3267c6a1 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/en/md/Slack/Management-and-settings/Get-bot-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets basic information about the bot + + +
+ + *Function GetBotInformation(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,15 +20,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Response = OPI_Slack.GetBotInformation(Token); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "url": "https://openintegrationsgroup.slack.com/", "team": "OpenIntegrations", @@ -44,5 +48,4 @@ sidebar_position: 1 "bot_id": "B06TZ0MJV5M", "is_enterprise_install": false } - ``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-user-list.md b/docs/en/md/Slack/Management-and-settings/Get-user-list.md index 30c35a16cd..18614a6a25 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-user-list.md +++ b/docs/en/md/Slack/Management-and-settings/Get-user-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets a list of users in the workspace + + +
+ + *Function GetUserList(Val Token, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,15 +21,16 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Response = OPI_Slack.GetUserList(Token, Cursor); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "members": [ { @@ -190,5 +194,4 @@ sidebar_position: 3 "next_cursor": "" } } - ``` diff --git a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md index 5d58d2f773..77266c5d99 100644 --- a/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md +++ b/docs/en/md/Slack/Management-and-settings/Get-workspace-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets a list of workspaces where the bot is connected + + +
+ + *Function GetWorkspaceList(Val Token, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,15 +21,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Response = OPI_Slack.GetWorkspaceList(Token); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "teams": [ { @@ -44,5 +48,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/en/md/Slack/Message-management/Delete-message.md b/docs/en/md/Slack/Message-management/Delete-message.md index 35f1e9b731..a44ea2d94e 100644 --- a/docs/en/md/Slack/Message-management/Delete-message.md +++ b/docs/en/md/Slack/Message-management/Delete-message.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes a channel message by timestamp + + +
+ + *Function DeleteMessage(Val Token, Val Channel, Val Timestamp, Val IsDelayed = False) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C06UFNUTKUL"; Timestamp = "1714146538.221929"; @@ -27,8 +32,9 @@ sidebar_position: 4 Response = OPI_Slack.DeleteMessage(Token, Channel, Timestamp); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -36,13 +42,10 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929" } - ``` diff --git a/docs/en/md/Slack/Message-management/Edit-message.md b/docs/en/md/Slack/Message-management/Edit-message.md index ce87ea973f..6638ec8757 100644 --- a/docs/en/md/Slack/Message-management/Edit-message.md +++ b/docs/en/md/Slack/Message-management/Edit-message.md @@ -6,6 +6,11 @@ sidebar_position: 3 Edits the content of an existing message + + +
+ + *Function EditMessage(Val Token, Val Channel, Val Timestamp, Val Text = "", Val BlockArray = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Timestamp = "1714146538.221929"; @@ -29,8 +34,9 @@ sidebar_position: 3 Response = OPI_Slack.EditMessage(Token, Channel, Timestamp, Text); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929", @@ -85,5 +89,4 @@ sidebar_position: 3 ] } } - ``` diff --git a/docs/en/md/Slack/Message-management/Get-delayed-message-list.md b/docs/en/md/Slack/Message-management/Get-delayed-message-list.md index a4062f7f1e..0f23a84e4d 100644 --- a/docs/en/md/Slack/Message-management/Get-delayed-message-list.md +++ b/docs/en/md/Slack/Message-management/Get-delayed-message-list.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gets a list of delayed channel messages + + +
+ + *Function GetDelayedMessageList(Val Token, Val Channel, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Response = OPI_Slack.GetDelayedMessageList(Token, Channel); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -34,15 +40,12 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true, "scheduled_messages": [], "response_metadata": { "next_cursor": "" } } - ``` diff --git a/docs/en/md/Slack/Message-management/Get-message-link.md b/docs/en/md/Slack/Message-management/Get-message-link.md index 7af470f8c6..27dec546ac 100644 --- a/docs/en/md/Slack/Message-management/Get-message-link.md +++ b/docs/en/md/Slack/Message-management/Get-message-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets a permanent URL to the channel message + + +
+ + *Function GetMessageLink(Val Token, Val Channel, Val Timestamp) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Timestamp = "1714146538.221929"; @@ -26,8 +31,9 @@ sidebar_position: 6 Response = OPI_Slack.GetMessageLink(Token, Channel, Timestamp); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -35,13 +41,10 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "ok": true, "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", "channel": "C06UFNUTKUL" } - ``` diff --git a/docs/en/md/Slack/Message-management/Get-message-reply-list.md b/docs/en/md/Slack/Message-management/Get-message-reply-list.md index eb1ac84473..1ac34f395f 100644 --- a/docs/en/md/Slack/Message-management/Get-message-reply-list.md +++ b/docs/en/md/Slack/Message-management/Get-message-reply-list.md @@ -6,6 +6,11 @@ sidebar_position: 7 Gets an array of messages that are replies to the specified + + +
+ + *Function GetMessageReplyList(Val Token, Val Channel, Val Timestamp, Val Cursor = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Timestamp = "1714146538.221929"; @@ -27,8 +32,9 @@ sidebar_position: 7 Response = OPI_Slack.GetMessageReplyList(Token, Channel, Timestamp); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "ok": true, "messages": [ { @@ -88,5 +92,4 @@ sidebar_position: 7 ], "has_more": false } - ``` diff --git a/docs/en/md/Slack/Message-management/Send-ephemeral-message.md b/docs/en/md/Slack/Message-management/Send-ephemeral-message.md index e2ad0312ec..2496dd5ecd 100644 --- a/docs/en/md/Slack/Message-management/Send-ephemeral-message.md +++ b/docs/en/md/Slack/Message-management/Send-ephemeral-message.md @@ -6,6 +6,11 @@ sidebar_position: 2 Sends a message that arrives in the channel but is visible only to a specific user + + +
+ + *Function SendEphemeralMessage(Val Token, Val Channel, Val Text = "", Val User = "", Val Blocks = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ Sends a message that arrives in the channel but is visible only to a specific us Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Block = OPI_Slack.GenerateImageBlock("https://opi.neocities.org/test_data/picture.jpg", "Image"); @@ -28,8 +33,9 @@ Sends a message that arrives in the channel but is visible only to a specific us Response = OPI_Slack.SendEphemeralMessage(Token, Channel,, User, Block); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,12 +43,9 @@ Sends a message that arrives in the channel but is visible only to a specific us ``` - ```json title="Result" - -{ + { "ok": true, "message_ts": "1714146540.000300" } - ``` diff --git a/docs/en/md/Slack/Message-management/Send-message.md b/docs/en/md/Slack/Message-management/Send-message.md index 482e20d8a6..a468a9b87d 100644 --- a/docs/en/md/Slack/Message-management/Send-message.md +++ b/docs/en/md/Slack/Message-management/Send-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Sends a message at a selected hour + + +
+ + *Function SendMessage(Val Token, Val Channel, Val Text = "", Val SendingDate = "", Val Blocks = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Slack + ```bsl title="Code example" - Channel = "C070VPMKN8J"; Text = "TestMessage"; @@ -28,8 +33,9 @@ sidebar_position: 1 Response = OPI_Slack.SendMessage(Token, Channel, Text); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929", @@ -84,5 +88,4 @@ sidebar_position: 1 ] } } - ``` diff --git a/docs/en/md/Telegram/Administration/Ban.md b/docs/en/md/Telegram/Administration/Ban.md index 99b708c8f3..702918e7ce 100644 --- a/docs/en/md/Telegram/Administration/Ban.md +++ b/docs/en/md/Telegram/Administration/Ban.md @@ -6,6 +6,11 @@ sidebar_position: 1 Bans a user in the selected chat + + +
+ + *Function Ban(Val Token, Val ChatID, Val UserID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; UserID = "461699897"; ChannelID = "@testsichee"; Result = OPI_Telegram.Ban(Token, ChannelID, UserID); - ``` + + ```sh title="CLI command example" @@ -33,13 +39,10 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": false, "error_code": 400, "description": "Bad Request: can't remove chat owner" } - ``` diff --git a/docs/en/md/Telegram/Administration/Create-invitation-link.md b/docs/en/md/Telegram/Administration/Create-invitation-link.md index ebcdb7aec5..608b1d277b 100644 --- a/docs/en/md/Telegram/Administration/Create-invitation-link.md +++ b/docs/en/md/Telegram/Administration/Create-invitation-link.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates a link for joining a closed chat + + +
+ + *Function CreateInvitationLink(Val Token, Val ChatID, Val Title = "", Val ExpirationDate = "", Val UserLimit = 0) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChannelID = "@testsichee"; Day = 86400; @@ -31,8 +36,9 @@ sidebar_position: 3 UnixExpiration = OPI_Tools.UNIXTime(Expiration); Result = OPI_Telegram.CreateInvitationLink(Token, ChannelID, Title, Expiration, 200); - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "invite_link": "https://t.me/+W-9MzjOejStiYzYy", @@ -61,5 +65,4 @@ sidebar_position: 3 "is_revoked": false } } - ``` diff --git a/docs/en/md/Telegram/Administration/Delete-message.md b/docs/en/md/Telegram/Administration/Delete-message.md index bb1f4d070c..219518f002 100644 --- a/docs/en/md/Telegram/Administration/Delete-message.md +++ b/docs/en/md/Telegram/Administration/Delete-message.md @@ -6,6 +6,11 @@ sidebar_position: 7 Delete message from chat or channel + + +
+ + *Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "@testsichee"; MessageID = "5385"; Result = OPI_Telegram.DeleteMessage(Token, ChatID, MessageID); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Administration/Get-participant-count.md b/docs/en/md/Telegram/Administration/Get-participant-count.md index 5b7f0d8e81..e4d4c4e953 100644 --- a/docs/en/md/Telegram/Administration/Get-participant-count.md +++ b/docs/en/md/Telegram/Administration/Get-participant-count.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets the total number of chat participants + + +
+ + *Function GetParticipantCount(Val Token, Val ChatID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChannelID = "@testsichee"; Result = OPI_Telegram.GetParticipantCount(Token, ChannelID); - ``` + + ```sh title="CLI command example" @@ -31,12 +37,9 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "ok": true, "result": 2 } - ``` diff --git a/docs/en/md/Telegram/Administration/Pin-message.md b/docs/en/md/Telegram/Administration/Pin-message.md index a54c380b5d..e02302351d 100644 --- a/docs/en/md/Telegram/Administration/Pin-message.md +++ b/docs/en/md/Telegram/Administration/Pin-message.md @@ -6,6 +6,11 @@ sidebar_position: 4 Pins a message in the chat header + + +
+ + *Function PinMessage(Val Token, Val ChatID, Val MessageID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChannelID = "@testsichee"; MessageID = "4951"; Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Administration/Unban.md b/docs/en/md/Telegram/Administration/Unban.md index 2738bf2c21..8e0064f4e1 100644 --- a/docs/en/md/Telegram/Administration/Unban.md +++ b/docs/en/md/Telegram/Administration/Unban.md @@ -6,6 +6,11 @@ sidebar_position: 2 Unbans a previously banned user + + +
+ + *Function Unban(Val Token, Val ChatID, Val UserID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; UserID = "461699897"; ChannelID = "@testsichee"; Result = OPI_Telegram.Unban(Token, ChannelID, UserID); - ``` + + ```sh title="CLI command example" @@ -33,13 +39,10 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": false, "error_code": 400, "description": "Bad Request: can't remove chat owner" } - ``` diff --git a/docs/en/md/Telegram/Administration/Unpin-message.md b/docs/en/md/Telegram/Administration/Unpin-message.md index 417a396881..f077c29e83 100644 --- a/docs/en/md/Telegram/Administration/Unpin-message.md +++ b/docs/en/md/Telegram/Administration/Unpin-message.md @@ -6,6 +6,11 @@ sidebar_position: 5 Unpins a message in the chat header + + +
+ + *Function UnpinMessage(Val Token, Val ChatID, Val MessageID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChannelID = "@testsichee"; MessageID = "4951"; Result = OPI_Telegram.UnpinMessage(Token, ChannelID, MessageID); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md index 46dcbdef30..18a4599747 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes the bot event handler URL for webhook operation + + +
+ + *Function DeleteWebhook(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,12 +20,13 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Result = OPI_Telegram.DeleteWebhook(Token); - ``` + + ```sh title="CLI command example" @@ -28,13 +34,10 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "result": true, "description": "Webhook was deleted" } - ``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md index 2906fd2272..8bdd448a7b 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 5 Download file from Telegram servers + + +
+ + *Function DownloadFile(Val Token, Val FileID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 5 Returns: BinaryData - file's binary data + ```bsl title="Code example" - FileID = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; Token = "6129457865:AAFyzNYOAFbu..."; Result = OPI_Telegram.DownloadFile(Token, FileID); - ``` + + ```sh title="CLI command example" @@ -31,9 +37,6 @@ sidebar_position: 5 ``` - ```json title="Result" - - ``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md index e0ac8708f7..3b663185f5 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md @@ -3,7 +3,12 @@ sidebar_position: 1 --- # Get bot information -Executes the getMe request, returning basic bot information: name, id, ability to add the bot to groups, etc.. + Executes the /getMe request, returning basic bot information: name, id, ability to add the bot to groups, etc.. + + + + +
*Function GetBotInformation(Val Token) Export* @@ -15,12 +20,13 @@ Executes the getMe request, returning basic bot information: name, id, ability t Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Result = OPI_Telegram.GetBotInformation(Token); - ``` + + ```sh title="CLI command example" @@ -28,10 +34,8 @@ Executes the getMe request, returning basic bot information: name, id, ability t ``` - ```json title="Result" - -{ + { "ok": true, "result": { "id": 6129457865, @@ -44,5 +48,4 @@ Executes the getMe request, returning basic bot information: name, id, ability t "can_connect_to_business": false } } - ``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md index 7641d2e0aa..fa2c3cb35e 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Get-updates.md @@ -3,7 +3,12 @@ sidebar_position: 2 --- # Get updates -Executes a request getUpdates, returning information about bot events. Used in polling mode + Executes a request /getUpdates, returning information about bot events. Used in polling mode + + + + +
*Function GetUpdates(Val Token, Val Timeout = 0, Val Offset = "") Export* @@ -17,12 +22,13 @@ Executes a request getUpdates, returning information about bot events. Used in p Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Result = OPI_Telegram.GetUpdates(Token); - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ Executes a request getUpdates, returning information about bot events. Used in p ``` - ```json title="Result" - -{ + { "ok": true, "result": [ { @@ -360,5 +364,4 @@ Executes a request getUpdates, returning information about bot events. Used in p } ] } - ``` diff --git a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md index 12215ed31f..9b63dc2e7d 100644 --- a/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ b/docs/en/md/Telegram/Data-retrieval-and-settings/Set-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 3 Set webhook URL for bot event handling in webhook mode + + +
+ + *Function SetWebhook(Val Token, Val URL) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; URL = "https://api.athenaeum.digital/opi/hs/twitter"; Result = OPI_Telegram.SetWebhook(Token, URL); - ``` + + ```sh title="CLI command example" @@ -31,13 +37,10 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "result": true, "description": "Webhook was set" } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md b/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md index 32c867e4b6..c9edc2a351 100644 --- a/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md +++ b/docs/en/md/Telegram/Data-sending/Form-keyboard-from-button-array.md @@ -6,6 +6,11 @@ sidebar_position: 12 Generates a simple JSON keyboard from an array of buttons for a message or bottom panel + + +
+ + *Function FormKeyboardFromButtonArray(Val ButtonArray, Val UnderMessage = False, Val OneByOne = True) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 12 Returns: String - Keyboard JSON + ```bsl title="Code example" - ButtonArray = New Array; ButtonArray.Add("Great"); @@ -27,8 +32,9 @@ sidebar_position: 12 Keyboard = OPI_Telegram.FormKeyboardFromButtonArray(ButtonArray, True, True); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 12 ``` - ```json title="Result" - -{ + { "inline_keyboard":[ [ { @@ -62,5 +66,4 @@ sidebar_position: 12 ], "rows":1 } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Forward-message.md b/docs/en/md/Telegram/Data-sending/Forward-message.md index fe03b693b1..66152ebe0f 100644 --- a/docs/en/md/Telegram/Data-sending/Forward-message.md +++ b/docs/en/md/Telegram/Data-sending/Forward-message.md @@ -6,6 +6,11 @@ sidebar_position: 11 Forwards a message between chats or within a chat + + +
+ + *Function ForwardMessage(Val Token, Val OriginalID, Val FromID, Val ToID) Export* | Parameter | CLI option | Type | Destination | @@ -18,16 +23,17 @@ sidebar_position: 11 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; MessageID = "4951"; Result = OPI_Telegram.ForwardMessage(Token, MessageID, ChannelID, ChatID); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 11 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4649, @@ -78,5 +82,4 @@ sidebar_position: 11 "text": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-audio.md b/docs/en/md/Telegram/Data-sending/Send-audio.md index d131bb2abd..f868e5ff51 100644 --- a/docs/en/md/Telegram/Data-sending/Send-audio.md +++ b/docs/en/md/Telegram/Data-sending/Send-audio.md @@ -6,6 +6,11 @@ sidebar_position: 4 Sends an audio file to a chat or channel + + +
+ + *Function SendAudio(Val Token, Val ChatID, Val Text, Val Audio, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 4 Result = OPI_Telegram.SendAudio(Token, ChatID, Text, Audio); Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioPath); Result = OPI_Telegram.SendAudio(Token, ChannelID, Text, AudioDD); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4641, @@ -79,5 +83,4 @@ sidebar_position: 4 "caption": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-contact.md b/docs/en/md/Telegram/Data-sending/Send-contact.md index afb4510164..be0d4ff846 100644 --- a/docs/en/md/Telegram/Data-sending/Send-contact.md +++ b/docs/en/md/Telegram/Data-sending/Send-contact.md @@ -6,6 +6,11 @@ sidebar_position: 9 Sends a contact with name and phone number + + +
+ + *Function SendContact(Val Token, Val ChatID, Val Name, Val LastName, Val Phone, Val Keyboard = "") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -31,8 +36,9 @@ sidebar_position: 9 Result = OPI_Telegram.SendContact(Token, ChatID, Name, LastName, Phone); Result = OPI_Telegram.SendContact(Token, ChannelID, Name, LastName, Phone); - ``` + + ```sh title="CLI command example" @@ -40,10 +46,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4647, @@ -68,5 +72,4 @@ sidebar_position: 9 } } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-document.md b/docs/en/md/Telegram/Data-sending/Send-document.md index b8bb08404f..baf12f726a 100644 --- a/docs/en/md/Telegram/Data-sending/Send-document.md +++ b/docs/en/md/Telegram/Data-sending/Send-document.md @@ -6,6 +6,11 @@ sidebar_position: 5 Sends a document to a chat or channel + + +
+ + *Function SendDocument(Val Token, Val ChatID, Val Text, Val Document, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 5 Result = OPI_Telegram.SendDocument(Token, ChatID, Text, Document); Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentPath); Result = OPI_Telegram.SendDocument(Token, ChannelID, Text, DocumentDD); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4642, @@ -76,5 +80,4 @@ sidebar_position: 5 "caption": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-gif.md b/docs/en/md/Telegram/Data-sending/Send-gif.md index 30dfd35e0d..5d1916fa89 100644 --- a/docs/en/md/Telegram/Data-sending/Send-gif.md +++ b/docs/en/md/Telegram/Data-sending/Send-gif.md @@ -6,6 +6,11 @@ sidebar_position: 6 Sends a GIF to a chat or channel + + +
+ + *Function SendGif(Val Token, Val ChatID, Val Text, Val GIF, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 6 Result = OPI_Telegram.SendGif(Token, ChatID, Text, GIF); Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifPath); Result = OPI_Telegram.SendGif(Token, ChannelID, Text, GifDD); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4643, @@ -114,5 +118,4 @@ sidebar_position: 6 "caption": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-image.md b/docs/en/md/Telegram/Data-sending/Send-image.md index 95fcaca8e2..05d3a45341 100644 --- a/docs/en/md/Telegram/Data-sending/Send-image.md +++ b/docs/en/md/Telegram/Data-sending/Send-image.md @@ -6,6 +6,11 @@ sidebar_position: 2 Sends an image to a chat or channel + + +
+ + *Function SendImage(Val Token, Val ChatID, Val Text, Val Image, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 2 Result = OPI_Telegram.SendImage(Token, ChatID, Text, Image); Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImagePath); Result = OPI_Telegram.SendImage(Token, ChannelID, Text, ImageDD); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4639, @@ -106,5 +110,4 @@ sidebar_position: 2 "caption": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-location.md b/docs/en/md/Telegram/Data-sending/Send-location.md index 558d67fd46..11152b596c 100644 --- a/docs/en/md/Telegram/Data-sending/Send-location.md +++ b/docs/en/md/Telegram/Data-sending/Send-location.md @@ -6,6 +6,11 @@ sidebar_position: 8 Sends location by geographic latitude and longitude to a chat or channel + + +
+ + *Function SendLocation(Val Token, Val ChatID, Val Latitude, Val Longitude, Val Keyboard = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -29,8 +34,9 @@ sidebar_position: 8 Result = OPI_Telegram.SendLocation(Token, ChatID, Width, Longitude); Result = OPI_Telegram.SendLocation(Token, ChannelID, Width, Longitude); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4646, @@ -65,5 +69,4 @@ sidebar_position: 8 } } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-media-group.md b/docs/en/md/Telegram/Data-sending/Send-media-group.md index c7093f97b2..0880378324 100644 --- a/docs/en/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/en/md/Telegram/Data-sending/Send-media-group.md @@ -6,6 +6,11 @@ sidebar_position: 7 Sends a set of files to a chat or channel. Media types: audio, document, photo, video + + +
+ + *Function SendMediaGroup(Val Token, Val ChatID, Val Text, Val FileMapping, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; Description = "Pictures group"; @@ -32,8 +37,9 @@ sidebar_position: 7 Response = OPI_Telegram.SendMediaGroup(Token, 1234567890, Description, FileMapping); //Map Response = OPI_Tools.JSONString(Response_); //JSON string - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "ok": true, "result": [ { @@ -147,5 +151,4 @@ sidebar_position: 7 } ] } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-poll.md b/docs/en/md/Telegram/Data-sending/Send-poll.md index f591574d46..a2297a59e8 100644 --- a/docs/en/md/Telegram/Data-sending/Send-poll.md +++ b/docs/en/md/Telegram/Data-sending/Send-poll.md @@ -6,6 +6,11 @@ sidebar_position: 10 Sends a poll with answer options + + +
+ + *Function SendPoll(Val Token, Val ChatID, Val Question, Val AnswersArray, Val Anonymous = True) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -34,8 +39,9 @@ sidebar_position: 10 Result = OPI_Telegram.SendPoll(Token, ChatID, Question, AnswersArray, False); Result = OPI_Telegram.SendPoll(Token, ChannelID, Question, AnswersArray, True); - ``` + + ```sh title="CLI command example" @@ -43,10 +49,8 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4648, @@ -93,5 +97,4 @@ sidebar_position: 10 } } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-text-message.md b/docs/en/md/Telegram/Data-sending/Send-text-message.md index cf813d08fd..c619787bb5 100644 --- a/docs/en/md/Telegram/Data-sending/Send-text-message.md +++ b/docs/en/md/Telegram/Data-sending/Send-text-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Sends a text message to a chat or channel + + +
+ + *Function SendTextMessage(Val Token, Val ChatID, Val Text, Val Keyboard = "", Val Markup = "Markdown", Val RepliedID = 0) Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -29,8 +34,9 @@ sidebar_position: 1 Result = OPI_Telegram.SendTextMessage(Token, ChatID, Text); Result = OPI_Telegram.SendTextMessage(Token, ChannelID, Text); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4638, @@ -62,5 +66,4 @@ sidebar_position: 1 "text": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Data-sending/Send-video.md b/docs/en/md/Telegram/Data-sending/Send-video.md index dfd3791393..d2b6d6af42 100644 --- a/docs/en/md/Telegram/Data-sending/Send-video.md +++ b/docs/en/md/Telegram/Data-sending/Send-video.md @@ -6,6 +6,11 @@ sidebar_position: 3 Sends a video to a chat or channel + + +
+ + *Function SendVideo(Val Token, Val ChatID, Val Text, Val Video, Val Keyboard = "", Val Markup = "Markdown") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; ChatID = "461699897"; ChannelID = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 3 Result = OPI_Telegram.SendVideo(Token, ChatID, Text, Video); Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoPath); Result = OPI_Telegram.SendVideo(Token, ChannelID, Text, VideoDD); - ``` + + ```sh title="CLI command example" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_id": 4640, @@ -93,5 +97,4 @@ sidebar_position: 3 "caption": "String value" } } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md b/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md index 88cee7dff8..e5602a6bae 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md +++ b/docs/en/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md @@ -6,6 +6,11 @@ sidebar_position: 10 Clears the list of pinned messages in the forum thread + + +
+ + *Function ClearThreadPinnedMessagesList(Val Token, Val ChatID, Val ThreadID = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Topic = "2673"; Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat); Result = OPI_Telegram.ClearThreadPinnedMessagesList(Token, Chat, Topic); - ``` + + ```sh title="CLI command example" @@ -34,12 +40,9 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md index e2d8cd9e79..89fbef5588 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Close-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 4 Closes the thread for new messages + + +
+ + *Function CloseForumThread(Val Token, Val ChatID, Val ThreadID = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Topic = "2673"; Result = OPI_Telegram.CloseForumThread(Token, Chat); // Closes main topic Result = OPI_Telegram.CloseForumThread(Token, Chat, Topic); - ``` + + ```sh title="CLI command example" @@ -34,12 +40,9 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md index a033854dea..33b4dc4901 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Create-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a new thread in the group with theme functionality enabled + + +
+ + *Function CreateForumThread(Val Token, Val ChatID, Val Title, Val IconID = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,16 +23,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Icon = "5357419403325481346"; Name = "TestTopic " + String(New UUID); Result = OPI_Telegram.CreateForumThread(Token, Chat, Name, Icon); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "ok": true, "result": { "message_thread_id": 2457, @@ -47,5 +51,4 @@ sidebar_position: 2 "icon_custom_emoji_id": "5357419403325481346" } } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md index a7125d6700..aea9e0a5f9 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Delete-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 6 Deletes a forum thread + + +
+ + *Function DeleteForumTopic(Val Token, Val ChatID, Val ThreadID) Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Topic = "2673"; Result = OPI_Telegram.DeleteForumTopic(Token, Chat, Topic); - ``` + + ```sh title="CLI command example" @@ -33,12 +39,9 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md index f2306929a0..cda122d3d9 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Edit-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates a new thread in the group with theme functionality enabled + + +
+ + *Function EditForumTopic(Val Token, Val ChatID, Val ThreadID, Val Title = Undefined, Val IconID = Undefined) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Topic = "2673"; @@ -28,8 +33,9 @@ sidebar_position: 3 NewIcon = "5310132165583840589"; Result = OPI_Telegram.EditForumTopic(Token, Chat, Topic, NewName, NewIcon); - ``` + + ```sh title="CLI command example" @@ -37,12 +43,9 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md b/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md index c7dd4b3f32..250ef5c4c1 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md +++ b/docs/en/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md @@ -6,6 +6,11 @@ sidebar_position: 9 Edits the name of the main forum thread + + +
+ + *Function EditMainForumTopicName(Val Token, Val ChatID, Val Title) Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Title = "New main thread name " + String(New UUID); Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Result = OPI_Telegram.EditMainForumTopicName(Token, Chat, Title); - ``` + + ```sh title="CLI command example" @@ -32,12 +38,9 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md b/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md index 16438b2a7a..32de86586f 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md +++ b/docs/en/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the mapping of Emoji IDs for setting as forum theme icons + + +
+ + *Function GetAvatarIconList(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Key > ID, Value > Emoji + ```bsl title="Code example" - Response = GetAvatarIconList("6129457325:BWDF..."); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "5434144690511290129": "📰", "5312536423851630001": "💡", "5312016608254762256": "⚡️", @@ -147,5 +151,4 @@ sidebar_position: 1 "5237999392438371490": "🦮", "5235912661102773458": "🐈" } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md index 8be097fc78..2d388216d0 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 7 Hides the main forum thread + + +
+ + *Function HideMainForumTopic(Val Token, Val ChatID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Result = OPI_Telegram.HideMainForumTopic(Token, Chat); - ``` + + ```sh title="CLI command example" @@ -31,12 +37,9 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md index 377a76eb15..0378adbc6a 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ b/docs/en/md/Telegram/Forum-topic-management/Open-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 5 Reopens a previously closed forum thread + + +
+ + *Function OpenForumThread(Val Token, Val ChatID, Val ThreadID = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Topic = "2673"; Result = OPI_Telegram.OpenForumThread(Token, Chat); // Opens main topic Result = OPI_Telegram.OpenForumThread(Token, Chat, Topic); - ``` + + ```sh title="CLI command example" @@ -34,12 +40,9 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md b/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md index da75f2f984..7672a56de8 100644 --- a/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md +++ b/docs/en/md/Telegram/Forum-topic-management/Show-main-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 8 Shows a previously hidden main forum thread + + +
+ + *Function ShowMainForumTopic(Val Token, Val ChatID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - Serialized JSON response from Telegram + ```bsl title="Code example" - Token = "6129457865:AAFyzNYOAFbu..."; Chat = "-1001971186208"; Result = OPI_Telegram.ShowMainForumTopic(Token, Chat); - ``` + + ```sh title="CLI command example" @@ -31,12 +37,9 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md index a0772495ec..6ef07c51dc 100644 --- a/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md +++ b/docs/en/md/Twitter/Data-and-settings/Get-authorization-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Forms a link for authorization via the browser + + +
+ + *Function GetAuthorizationLink(Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,13 +20,14 @@ sidebar_position: 1 Returns: String - URL for browser transition + ```bsl title="Code example" - Response = OPI_Twitter.GetAuthorizationLink(Parameters); - ``` + + ```sh title="CLI command example" @@ -29,9 +35,6 @@ sidebar_position: 1 ``` - ```json title="Result" - -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" - + "https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" ``` diff --git a/docs/en/md/Twitter/Data-and-settings/Get-token.md b/docs/en/md/Twitter/Data-and-settings/Get-token.md index a9223cb90c..e9be7ab290 100644 --- a/docs/en/md/Twitter/Data-and-settings/Get-token.md +++ b/docs/en/md/Twitter/Data-and-settings/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the token by the code received when authorizing using the link from GetAuthorizationLink + + +
+ + *Function GetToken(Val Code, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - Response = OPI_Twitter.GetToken(Code, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,15 +37,12 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", "expires_in": 7200, "token_type": "bearer" } - ``` diff --git a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md b/docs/en/md/Twitter/Data-and-settings/Refresh-token.md index d2c224f4ad..604e54e9a7 100644 --- a/docs/en/md/Twitter/Data-and-settings/Refresh-token.md +++ b/docs/en/md/Twitter/Data-and-settings/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Updates the v2 token using the refresh_token + + +
+ + *Function RefreshToken(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,8 +20,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - Response = OPI_Twitter.RefreshToken(Parameters); Constants.TwitterToken.Set(Response["access_token"]); @@ -24,8 +29,9 @@ sidebar_position: 3 Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -33,15 +39,12 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", "expires_in": 7200, "token_type": "bearer" } - ``` diff --git a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md b/docs/en/md/Twitter/Tweets/Create-gif-tweet.md index d020a611e6..23d4c29f4b 100644 --- a/docs/en/md/Twitter/Tweets/Create-gif-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-gif-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates a tweet with a gif attachment + + +
+ + *Function CreateGifTweet(Val Text, Val GifsArray, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - ImageArray = New Array; ImageArray.Add("C:\1.gif"); @@ -27,8 +32,9 @@ sidebar_position: 3 Response = OPI_Twitter.CreateGifTweet("Gifs", ImageArray, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "data": { "text": "Nature https://t.co/VWkWU11111", "id": "1746086669499924991", @@ -48,5 +52,4 @@ sidebar_position: 3 ] } } - ``` diff --git a/docs/en/md/Twitter/Tweets/Create-image-tweet.md b/docs/en/md/Twitter/Tweets/Create-image-tweet.md index 4c0e567ef3..0590be37bd 100644 --- a/docs/en/md/Twitter/Tweets/Create-image-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-image-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a tweet with an image attachment + + +
+ + *Function CreateImageTweet(Val Text, Val ImageArray, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - ImageArray = New Array; ImageArray.Add("C:\logo.png"); @@ -27,8 +32,9 @@ sidebar_position: 2 Response = OPI_Twitter.CreateImageTweet("Alpaca", ImageArray, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "data": { "text": "Alpaca https://t.co/OodoWT1AAA", "id": "1745753004542726629", @@ -48,5 +52,4 @@ sidebar_position: 2 ] } } - ``` diff --git a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md b/docs/en/md/Twitter/Tweets/Create-poll-tweet.md index e50bb3afdf..5ee9fb5889 100644 --- a/docs/en/md/Twitter/Tweets/Create-poll-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-poll-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates a tweet with a poll + + +
+ + *Function CreatePollTweet(Val Text, Val OptionArray, Val Duration, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - OptionArray = New Array; OptionArray.Add("Good"); @@ -29,8 +34,9 @@ sidebar_position: 5 Response = OPI_Twitter.CreatePollTweet("How are you?", OptionArray, 60, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "data": { "text": "How are you?", "id": "1746082302268969388", @@ -50,5 +54,4 @@ sidebar_position: 5 ] } } - ``` diff --git a/docs/en/md/Twitter/Tweets/Create-text-tweet.md b/docs/en/md/Twitter/Tweets/Create-text-tweet.md index 4ce38e69ea..021e3886eb 100644 --- a/docs/en/md/Twitter/Tweets/Create-text-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-text-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a tweet without attachments + + +
+ + *Function CreateTextTweet(Val Text, Val Parameters = "") ExportReturn CreateCustomTweet(Text,,,, Parameters);EndFunction* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - Response = OPI_Twitter.CreateTextTweet("Regular text tweet", Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "data": { "text": "Regular text tweet", "id": "1745752006310895822", @@ -43,5 +47,4 @@ sidebar_position: 1 ] } } - ``` diff --git a/docs/en/md/Twitter/Tweets/Create-video-tweet.md b/docs/en/md/Twitter/Tweets/Create-video-tweet.md index 4dabec8cc6..cb3421b476 100644 --- a/docs/en/md/Twitter/Tweets/Create-video-tweet.md +++ b/docs/en/md/Twitter/Tweets/Create-video-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 4 Creates a tweet with a video attachment + + +
+ + *Function CreateVideoTweet(Val Text, Val VideosArray, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Twitter + ```bsl title="Code example" - ImageArray = New Array; ImageArray.Add("C:\1.mp4"); @@ -27,8 +32,9 @@ sidebar_position: 4 Response = OPI_Twitter.CreateVideoTweet("Nature", ImageArray, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "data": { "text": "Alpaca https://t.co/OodoWT1AAA", "id": "1745753004542726629", @@ -48,5 +52,4 @@ sidebar_position: 4 ] } } - ``` diff --git a/docs/en/md/VK/Ad-account-management/Create-ad.md b/docs/en/md/VK/Ad-account-management/Create-ad.md index 4b6c022931..b76cfd245b 100644 --- a/docs/en/md/VK/Ad-account-management/Create-ad.md +++ b/docs/en/md/VK/Ad-account-management/Create-ad.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates an advertising post based on a post + + +
+ + *Function CreateAd(Val CampaignNumber, Val DailyLimit, Val CategoryNumber, Val PostID, Val AccountID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -20,14 +25,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.CreateAd(1029683999, 166, 126, 221, 1607951446, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -35,15 +41,12 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "response": [ { "id": 171372386 } ] } - ``` diff --git a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md index d8626b77c0..7aaa8aacdb 100644 --- a/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md +++ b/docs/en/md/VK/Ad-account-management/Create-advertising-campaign.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a campaign in the selected advertising account + + +
+ + *Function CreateAdvertisingCampaign(Val AccountID, Val Name, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.CreateAdvertisingCampaign(1234567890, "New ads campaign", Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,15 +38,12 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "response": [ { "id": 1029701085 } ] } - ``` diff --git a/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md b/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md index 618acf8df5..1350574178 100644 --- a/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md +++ b/docs/en/md/VK/Ad-account-management/Get-advertising-category-list.md @@ -6,6 +6,11 @@ sidebar_position: 4 Gets a list of advertising category IDs for creating an advertising post + + +
+ + *Function GetAdvertisingCategoryList(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.GetAdvertisingCategoryList(Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": { "v2": [ { @@ -64,5 +68,4 @@ sidebar_position: 4 ] } } - ``` 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 998748f5dd..d849fc06e4 100644 --- a/docs/en/md/VK/Ad-account-management/Pause-advertising.md +++ b/docs/en/md/VK/Ad-account-management/Pause-advertising.md @@ -6,6 +6,11 @@ sidebar_position: 3 Pauses the display of the advertising post + + +
+ + *Function PauseAdvertising(Val AccountID, Val AdID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.PauseAdvertising(1234567890, 1029701085, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,15 +38,12 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": [ { "id": 1029701085 } ] } - ``` diff --git a/docs/en/md/VK/Community-managment/Create-album.md b/docs/en/md/VK/Community-managment/Create-album.md index e7fe12aa6c..23ed36a25e 100644 --- a/docs/en/md/VK/Community-managment/Create-album.md +++ b/docs/en/md/VK/Community-managment/Create-album.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates an album to store images + + +
+ + *Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Name = "AlbumFromAutoTest"; Description = "NewAlbumFromAutoTest"; Result = OPI_VK.CreateAlbum(Name, Description, Parameters); - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "response": { "id": 304498513, "owner_id": -218861756, @@ -53,5 +57,4 @@ sidebar_position: 5 "upload_by_admins_only": 1 } } - ``` diff --git a/docs/en/md/VK/Community-managment/Create-composite-post.md b/docs/en/md/VK/Community-managment/Create-composite-post.md index fe8b943d08..1f1a36c4df 100644 --- a/docs/en/md/VK/Community-managment/Create-composite-post.md +++ b/docs/en/md/VK/Community-managment/Create-composite-post.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a post based on an array of object identifiers (images, videos, etc..) + + +
+ + *Function CreateCompositePost(Val Text, Val Objects, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Text = "Post from autotest"; URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -45,8 +50,9 @@ sidebar_position: 2 AttachmentsArray.Add("video" + VideoOwner + "_" + VideoID); Result = OPI_VK.CreateCompositePost(Text, AttachmentsArray, False, URL, Parameters); - ``` + + ```sh title="CLI command example" @@ -54,13 +60,10 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "response": { "post_id": 2126 } } - ``` diff --git a/docs/en/md/VK/Community-managment/Create-poll.md b/docs/en/md/VK/Community-managment/Create-poll.md index 7dbfc4e590..57f2ab5a5e 100644 --- a/docs/en/md/VK/Community-managment/Create-poll.md +++ b/docs/en/md/VK/Community-managment/Create-poll.md @@ -6,6 +6,11 @@ sidebar_position: 4 Creates a poll with answer options + + +
+ + *Function CreatePoll(Val Question, Val AnswersArray, Val Image = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Question = "What's your favorite color?"; @@ -29,8 +34,9 @@ sidebar_position: 4 OptionArray.Add("Green"); Result = OPI_VK.CreatePoll(Question, OptionArray,, Parameters); - ``` + + ```sh title="CLI command example" @@ -38,13 +44,10 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": { "post_id": 2127 } } - ``` diff --git a/docs/en/md/VK/Community-managment/Create-post.md b/docs/en/md/VK/Community-managment/Create-post.md index acf13b5a62..26bf75b262 100644 --- a/docs/en/md/VK/Community-managment/Create-post.md +++ b/docs/en/md/VK/Community-managment/Create-post.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a post with images + + +
+ + *Function CreatePost(Val Text, Val ImageArray, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Text = "Post from autotest"; URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -37,8 +42,9 @@ sidebar_position: 1 Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters); Result = OPI_VK.CreatePost(Text, Image, False,, Parameters); - ``` + + ```sh title="CLI command example" @@ -46,13 +52,10 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "response": { "post_id": 2123 } } - ``` diff --git a/docs/en/md/VK/Community-managment/Create-story.md b/docs/en/md/VK/Community-managment/Create-story.md index fc140c537c..e7918bcdb9 100644 --- a/docs/en/md/VK/Community-managment/Create-story.md +++ b/docs/en/md/VK/Community-managment/Create-story.md @@ -6,6 +6,11 @@ sidebar_position: 7 Creates a story from an image + + +
+ + *Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -29,8 +34,9 @@ sidebar_position: 7 Result = OPI_VK.CreateStory(Image, URL, Parameters); Result = OPI_VK.CreateStory(TFN,, Parameters); - ``` + + ```sh title="CLI command example" @@ -38,10 +44,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "response": { "count": 1, "items": [ @@ -134,5 +138,4 @@ sidebar_position: 7 ] } } - ``` diff --git a/docs/en/md/VK/Community-managment/Delete-album.md b/docs/en/md/VK/Community-managment/Delete-album.md index de6b727890..2a3d06931b 100644 --- a/docs/en/md/VK/Community-managment/Delete-album.md +++ b/docs/en/md/VK/Community-managment/Delete-album.md @@ -6,6 +6,11 @@ sidebar_position: 6 Deletes a previously created album + + +
+ + *Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); AlbumID = "304549394"; Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Community-managment/Delete-image.md b/docs/en/md/VK/Community-managment/Delete-image.md index de37f2172e..2419abf230 100644 --- a/docs/en/md/VK/Community-managment/Delete-image.md +++ b/docs/en/md/VK/Community-managment/Delete-image.md @@ -6,6 +6,11 @@ sidebar_position: 9 Deletes an image from the album + + +
+ + *Function DeleteImage(Val ImageID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); ImageID = "457244340"; Result = OPI_VK.DeleteImage(ImageID, Parameters); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Community-managment/Delete-post.md b/docs/en/md/VK/Community-managment/Delete-post.md index 06b0fa1993..f25306cd1f 100644 --- a/docs/en/md/VK/Community-managment/Delete-post.md +++ b/docs/en/md/VK/Community-managment/Delete-post.md @@ -6,6 +6,11 @@ sidebar_position: 3 Deletes a post by ID + + +
+ + *Function DeletePost(Val PostID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); PostID = "2304"; Result = OPI_VK.DeletePost(PostID, Parameters); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Community-managment/Save-image-to-album.md b/docs/en/md/VK/Community-managment/Save-image-to-album.md index 3e1f350f85..5b56cd261c 100644 --- a/docs/en/md/VK/Community-managment/Save-image-to-album.md +++ b/docs/en/md/VK/Community-managment/Save-image-to-album.md @@ -6,6 +6,11 @@ sidebar_position: 8 Saves an image to the community album + + +
+ + *Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); ImageDescription = "AutoTestImage"; AlbumID = "304549394"; @@ -32,8 +37,9 @@ sidebar_position: 8 Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters); - ``` + + ```sh title="CLI command example" @@ -41,10 +47,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -{ + { "response": [ { "album_id": 304498513, @@ -120,5 +124,4 @@ sidebar_position: 8 } ] } - ``` diff --git a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md b/docs/en/md/VK/Community-managment/Upload-photo-to-server.md index c933fc227d..59607d9e40 100644 --- a/docs/en/md/VK/Community-managment/Upload-photo-to-server.md +++ b/docs/en/md/VK/Community-managment/Upload-photo-to-server.md @@ -6,6 +6,11 @@ sidebar_position: 11 Uploads photo to server for further use + + +
+ + *Function UploadPhotoToServer(Val Image, Val Parameters = "", Val View = "Post") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 11 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data TFN = GetTempFileName("png"); @@ -26,8 +31,9 @@ sidebar_position: 11 ImageUpload = OPI_VK.UploadPhotoToServer(Image, Parameters); ImageUpload = OPI_VK.UploadPhotoToServer(TFN, Parameters); - ``` + + ```sh title="CLI command example" @@ -35,9 +41,7 @@ sidebar_position: 11 ``` - ```json title="Result" - { "response":[ { @@ -51,5 +55,4 @@ sidebar_position: 11 } ] } - ``` diff --git a/docs/en/md/VK/Community-managment/Upload-video-to-server.md b/docs/en/md/VK/Community-managment/Upload-video-to-server.md index 2ec2cbb4f8..810647a252 100644 --- a/docs/en/md/VK/Community-managment/Upload-video-to-server.md +++ b/docs/en/md/VK/Community-managment/Upload-video-to-server.md @@ -6,6 +6,11 @@ sidebar_position: 10 Uploads video to the group for further use + + +
+ + *Function UploadVideoToServer(Val Video, Val Name, Val Description = "", Val Album = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,16 +24,17 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Video = "C:/nature.mp4"; Name = "NewVideo"; Description = "Video description"; Result = OPI_VK.UploadVideoToServer(Video, Name, Description,, Parameters); - ``` + + ```sh title="CLI command example" @@ -36,15 +42,12 @@ sidebar_position: 10 ``` - ```json title="Result" - -{ + { "video_hash": "a833866c6db82314f7", "size": 1137878, "direct_link": "https://vkvd124.mycdn.me/?expires=1718104740308&srcIp=20.172.5.93&pr=40&srcAg=UNKNOWN&ms=185.226.53.168&type=4&sig=bcm4dKyuOlo&ct=27&urls=45.136.20.202&clientType=14&appId=512000384397&zs=43&id=6569231256185", "owner_id": -218861756, "video_id": 456239138 } - ``` diff --git a/docs/en/md/VK/Discussion-management/Close-discussion.md b/docs/en/md/VK/Discussion-management/Close-discussion.md index 82e7769376..a6cb29d322 100644 --- a/docs/en/md/VK/Discussion-management/Close-discussion.md +++ b/docs/en/md/VK/Discussion-management/Close-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 2 Close or delete discussion + + +
+ + *Function CloseDiscussion(Val DiscussionID, Val DeleteCompletely = False, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,13 +22,14 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); DiscussionID = "51206275"; Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Discussion-management/Create-discussion.md b/docs/en/md/VK/Discussion-management/Create-discussion.md index 9ff9521f82..d3ce4720ba 100644 --- a/docs/en/md/VK/Discussion-management/Create-discussion.md +++ b/docs/en/md/VK/Discussion-management/Create-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 1 Creates a new discussion + + +
+ + *Function CreateDiscussion(Val Name, Val FirstMessageText, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Name = "Discussing: Which color is better?"; Message = "Red, yellow, blue, or some other?"; Result = OPI_VK.CreateDiscussion(Name, Message, Parameters); - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "response": 51182455 } - ``` diff --git a/docs/en/md/VK/Discussion-management/Open-discussion.md b/docs/en/md/VK/Discussion-management/Open-discussion.md index b7ba78ec34..e6e4984d85 100644 --- a/docs/en/md/VK/Discussion-management/Open-discussion.md +++ b/docs/en/md/VK/Discussion-management/Open-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 3 Opens a previously closed discussion + + +
+ + *Function OpenDiscussion(Val DiscussionID, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,13 +21,14 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); DiscussionID = "51206275"; Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters); - ``` + + ```sh title="CLI command example" @@ -30,11 +36,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Discussion-management/Write-in-discussion.md b/docs/en/md/VK/Discussion-management/Write-in-discussion.md index 5b1804c044..4f8d79f5ec 100644 --- a/docs/en/md/VK/Discussion-management/Write-in-discussion.md +++ b/docs/en/md/VK/Discussion-management/Write-in-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 4 Adds a message to the discussion on behalf of the group + + +
+ + *Function WriteInDiscussion(Val DiscussionID, Val Text, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,15 +22,16 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); DiscussionID = "51206275"; Message = "I like yellow more"; Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters); - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": 705 } - ``` diff --git a/docs/en/md/VK/Interactive-actions/Like-post.md b/docs/en/md/VK/Interactive-actions/Like-post.md index 98fb04a588..0bdc46ee00 100644 --- a/docs/en/md/VK/Interactive-actions/Like-post.md +++ b/docs/en/md/VK/Interactive-actions/Like-post.md @@ -6,6 +6,11 @@ sidebar_position: 1 Likes a post + + +
+ + *Function LikePost(Val PostID, Val WallID = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.LikePost(221,,Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,13 +38,10 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "response": { "likes": 1 } } - ``` diff --git a/docs/en/md/VK/Interactive-actions/Make-repost.md b/docs/en/md/VK/Interactive-actions/Make-repost.md index dcb7509ce0..445d3e7df4 100644 --- a/docs/en/md/VK/Interactive-actions/Make-repost.md +++ b/docs/en/md/VK/Interactive-actions/Make-repost.md @@ -6,6 +6,11 @@ sidebar_position: 2 Reposts the record + + +
+ + *Function MakeRepost(Val PostID, Val WallID = "", Val TargetWall = "", Val Advertising = False, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,14 +24,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.MakeRepost(2571, -218704372,,, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "response": { "mail_repost_count": 2, "likes_count": 7, @@ -52,5 +56,4 @@ sidebar_position: 2 "success": 1 } } - ``` diff --git a/docs/en/md/VK/Interactive-actions/Shorten-link.md b/docs/en/md/VK/Interactive-actions/Shorten-link.md index 5975a271b2..63440f116b 100644 --- a/docs/en/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/en/md/VK/Interactive-actions/Shorten-link.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates a shortened URL from a regular one + + +
+ + *Function ShortenLink(Val URL, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,13 +21,14 @@ sidebar_position: 5 Returns: String - Shortened URL + ```bsl title="Code example" - Response = OPI_VK.ShortenLink("https://github.com/Bayselonarrend/OpenIntegrations", Parameters); - ``` + + ```sh title="CLI command example" @@ -30,9 +36,6 @@ sidebar_position: 5 ``` - ```json title="Result" - -https://vk.cc/ctL1sM - + https://vk.cc/ctL1sM ``` diff --git a/docs/en/md/VK/Interactive-actions/Write-comment.md b/docs/en/md/VK/Interactive-actions/Write-comment.md index 4bbb96d6dc..f88bd04550 100644 --- a/docs/en/md/VK/Interactive-actions/Write-comment.md +++ b/docs/en/md/VK/Interactive-actions/Write-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Creates a comment under the selected record + + +
+ + *Function WriteComment(Val PostID, Val WallID, Val Text, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,14 +23,15 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.WriteComment(221, -218861756, "Hello", Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -33,14 +39,11 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": { "parents_stack": [], "comment_id": 229 } } - ``` diff --git a/docs/en/md/VK/Interactive-actions/Write-message.md b/docs/en/md/VK/Interactive-actions/Write-message.md index b2651c5455..4d882546aa 100644 --- a/docs/en/md/VK/Interactive-actions/Write-message.md +++ b/docs/en/md/VK/Interactive-actions/Write-message.md @@ -6,6 +6,11 @@ sidebar_position: 3 Write a message to a user in the community's dialog + + +
+ + *Function WriteMessage(Val Text, Val UserID, Val Communitytoken, Val Keyboard = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,16 +24,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657811122, KТ,, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,11 +42,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": 7 } - ``` diff --git a/docs/en/md/VK/Order-management/Get-order-list.md b/docs/en/md/VK/Order-management/Get-order-list.md index cc3cd93c6c..3312821d56 100644 --- a/docs/en/md/VK/Order-management/Get-order-list.md +++ b/docs/en/md/VK/Order-management/Get-order-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Returns the community's order list + + +
+ + *Function GetOrderList(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,12 +20,13 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Parameters = GetVKParameters(); Result = OPI_VK.GetOrderList(Parameters); - ``` + + ```sh title="CLI command example" @@ -28,10 +34,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -[ + [ { "id": 397209, "group_id": 218861756, @@ -218,5 +222,4 @@ sidebar_position: 1 } } ] - ``` diff --git a/docs/en/md/VK/Others/Form-keyboard.md b/docs/en/md/VK/Others/Form-keyboard.md index 40ad54ebd9..31a995dbb2 100644 --- a/docs/en/md/VK/Others/Form-keyboard.md +++ b/docs/en/md/VK/Others/Form-keyboard.md @@ -6,6 +6,11 @@ sidebar_position: 1 Forms a keyboard from an array of buttons + + +
+ + *Function FormKeyboard(Val ButtonArray) Export* | Parameter | CLI option | Type | Destination | @@ -15,8 +20,8 @@ sidebar_position: 1 Returns: String - Keyboard JSON + ```bsl title="Code example" - ButtonArray = New Array; ButtonArray.Add("Button 1"); @@ -28,8 +33,9 @@ sidebar_position: 1 Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "buttons": [ [ { @@ -59,5 +63,4 @@ sidebar_position: 1 ], "one_time": false } - ``` diff --git a/docs/en/md/VK/Product-management/Add-product.md b/docs/en/md/VK/Product-management/Add-product.md index 39afd53308..7c78569310 100644 --- a/docs/en/md/VK/Product-management/Add-product.md +++ b/docs/en/md/VK/Product-management/Add-product.md @@ -6,6 +6,11 @@ sidebar_position: 4 Adds a new product to the community's catalog + + +
+ + *Function AddProduct(Val ProductDescription, Val Selection = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - ImageArray = New Array; ImageArray.Add(Image); @@ -44,8 +49,9 @@ sidebar_position: 4 Response = OPI_VK.AddProduct(Product, SelectionID, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -53,13 +59,10 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": { "market_item_id": 8656047 } } - ``` diff --git a/docs/en/md/VK/Product-management/Delete-product.md b/docs/en/md/VK/Product-management/Delete-product.md index dc025a8a5e..e815d5eef2 100644 --- a/docs/en/md/VK/Product-management/Delete-product.md +++ b/docs/en/md/VK/Product-management/Delete-product.md @@ -6,6 +6,11 @@ sidebar_position: 6 Deletes a previously created product + + +
+ + *Function DeleteProduct(Val Product, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.DeleteProduct(ProductID, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-management/Edit-product.md b/docs/en/md/VK/Product-management/Edit-product.md index e485989631..e619b49b7c 100644 --- a/docs/en/md/VK/Product-management/Edit-product.md +++ b/docs/en/md/VK/Product-management/Edit-product.md @@ -6,6 +6,11 @@ sidebar_position: 5 Edits a previously created product + + +
+ + *Function EditProduct(Val Product, Val ProductDescription, Val Selection = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Product = New Map; Product.Insert("Name", "EditedTestProduct"); @@ -27,8 +32,9 @@ sidebar_position: 5 Response = OPI_VK.EditProduct(ProductID, Product,, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,11 +42,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-management/Get-product-category-list.md b/docs/en/md/VK/Product-management/Get-product-category-list.md index dfd2a97217..31903e1fca 100644 --- a/docs/en/md/VK/Product-management/Get-product-category-list.md +++ b/docs/en/md/VK/Product-management/Get-product-category-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets a list of product category IDs to specify when creating a product + + +
+ + *Function GetProductCategoryList(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,13 +20,14 @@ sidebar_position: 1 Returns: Map Of String - Key - ID, Value - Name + ```bsl title="Code example" - Response = OPI_VK.GetProductCategoryList(Parameters); //Map - ``` + + ```sh title="CLI command example" @@ -29,13 +35,10 @@ sidebar_position: 1 ``` - ```json title="Result" - -Key Value + Key Value 1210 "Business" 1200 "Photo and video service" 2162 "Repair and building" ... - ``` diff --git a/docs/en/md/VK/Product-management/Get-product-description.md b/docs/en/md/VK/Product-management/Get-product-description.md index 6e5d9aed99..2eb5b101b5 100644 --- a/docs/en/md/VK/Product-management/Get-product-description.md +++ b/docs/en/md/VK/Product-management/Get-product-description.md @@ -6,6 +6,11 @@ sidebar_position: 8 + + +
+ + *Function GetProductDescription() Export* | Parameter | CLI option | Type | Destination | @@ -15,11 +20,12 @@ sidebar_position: 8 Returns: Map Of KeyAndValue - Empty product description: + ```bsl title="Code example" - Result = OPI_VK.GetProductDescription(); - ``` + + ```sh title="CLI command example" @@ -27,10 +33,8 @@ sidebar_position: 8 ``` - ```json title="Result" - -Product = New Map(); + Product = New Map(); Product.Insert("Name", "New product"); // Product name Product.Insert("Description", "Product description"); // Product description Product.Insert("Category", "20173"); // See GetProductCategoryList() @@ -47,5 +51,4 @@ Product = New Map(); Product.Insert("Weight", Undefined); // In grams Product.Insert("SKU", Undefined); // SKU Product.Insert("AvailableBalance", 1); - ``` diff --git a/docs/en/md/VK/Product-management/Get-product-list.md b/docs/en/md/VK/Product-management/Get-product-list.md index f24ae10018..7b6e4b103a 100644 --- a/docs/en/md/VK/Product-management/Get-product-list.md +++ b/docs/en/md/VK/Product-management/Get-product-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the community's product list + + +
+ + *Function GetProductList(Val Selection = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Array of product maps + ```bsl title="Code example" - Response = OPI_VK.GetProductList(, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -[ + [ { "sku": "12 345", "is_main_variant": true, @@ -342,5 +346,4 @@ sidebar_position: 2 "availability": 0 } ] - ``` diff --git a/docs/en/md/VK/Product-management/Get-products-by-id.md b/docs/en/md/VK/Product-management/Get-products-by-id.md index 65cab496ec..f19beaef4d 100644 --- a/docs/en/md/VK/Product-management/Get-products-by-id.md +++ b/docs/en/md/VK/Product-management/Get-products-by-id.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets information about products by array of IDs + + +
+ + *Function GetProductsByID(Val Products, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - ProductsArray = New Array; ProductsArray.Add("8656033"); @@ -26,8 +31,9 @@ sidebar_position: 3 Response = OPI_VK.GetProductsByID(ProductsArray, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": { "items": [ { @@ -707,5 +711,4 @@ sidebar_position: 3 "count": 2 } } - ``` diff --git a/docs/en/md/VK/Product-management/Group-products.md b/docs/en/md/VK/Product-management/Group-products.md index 85ee7503c0..c523ddbfe3 100644 --- a/docs/en/md/VK/Product-management/Group-products.md +++ b/docs/en/md/VK/Product-management/Group-products.md @@ -6,6 +6,11 @@ sidebar_position: 7 Groups products based on similar sets of properties + + +
+ + *Function GroupProducts(Val ProductsArray, Val ExistingGroup = "", Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - ProductsArray = New Array; ProductsArray.Add(YellowItemID); @@ -27,8 +32,9 @@ sidebar_position: 7 Response = OPI_VK.GroupProducts(ProductsArray,, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -36,13 +42,10 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "response": { "item_group_id": 5957 } } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md index fa41b981b1..a42a29eda3 100644 --- a/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Add-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 5 Adds a variant for an existing property + + +
+ + *Function AddProductPropertyVariant(Val Value, Val Property, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.AddProductPropertyVariant("Red", 260, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,13 +38,10 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "response": { "variant_id": 980 } } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Create-product-property.md b/docs/en/md/VK/Product-properties-management/Create-product-property.md index 5aeed74cfb..cdf9e38509 100644 --- a/docs/en/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Create-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a new property for use in products + + +
+ + *Function CreateProductProperty(Val Name, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.CreateProductProperty("Color", Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,13 +37,10 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "response": { "property_id": 260 } } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md index 8d7570826c..bb355b334c 100644 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 7 Deletes the previously created product property variant + + +
+ + *Function DeleteProductPropertyVariant(Val Option, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.DeleteProductPropertyVariant(980 Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Delete-product-property.md b/docs/en/md/VK/Product-properties-management/Delete-product-property.md index 659ad74abf..9ba1736660 100644 --- a/docs/en/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Delete-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes the existing product property + + +
+ + *Function DeleteProductProperty(Val Property, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.DeleteProductProperty(260, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md index 5dfda38f16..5a9f34d880 100644 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 6 Edits the value of an existing product property variant + + +
+ + *Function EditProductPropertyVariant(Val Value, Val Property, Val Option, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,14 +23,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.EditProductPropertyVariant("Yellow", 260, 980 Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -33,11 +39,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Edit-product-property.md b/docs/en/md/VK/Product-properties-management/Edit-product-property.md index ac2a8ed00e..053643f9a1 100644 --- a/docs/en/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/en/md/VK/Product-properties-management/Edit-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 3 Edits the existing product property + + +
+ + *Function EditProductProperty(Val Name, Val Property, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.EditProductProperty("Color (change.)", Property, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,11 +38,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-properties-management/Get-property-list.md b/docs/en/md/VK/Product-properties-management/Get-property-list.md index 37ea082835..e96df128e6 100644 --- a/docs/en/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/en/md/VK/Product-properties-management/Get-property-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of properties of group products + + +
+ + *Function GetPropertyList(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.GetPropertyList(Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -[ + [ { "variants": [ { @@ -54,5 +58,4 @@ sidebar_position: 1 "id": 255 } ] - ``` 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 166c19e0c7..cf7966e49d 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 @@ -6,6 +6,11 @@ sidebar_position: 5 Adds a product to the selection + + +
+ + *Function AddProductToCollection(Val ProductsArray, Val Selection, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.AddProductToCollection(8656559, 40, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,11 +38,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-selection-management/Create-product-collection.md b/docs/en/md/VK/Product-selection-management/Create-product-collection.md index e8a4a7513b..0f305a0a55 100644 --- a/docs/en/md/VK/Product-selection-management/Create-product-collection.md +++ b/docs/en/md/VK/Product-selection-management/Create-product-collection.md @@ -6,6 +6,11 @@ sidebar_position: 3 Creates an empty product selection + + +
+ + *Function CreateProductCollection(Val Name, Val Image, Val Main = False, Val Hidden = False, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.CreateProductCollection("TestCollection" , Image @@ -30,8 +35,9 @@ sidebar_position: 3 Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -39,14 +45,11 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "response": { "albums_count": 23, "market_album_id": 39 } } - ``` diff --git a/docs/en/md/VK/Product-selection-management/Delete-selection.md b/docs/en/md/VK/Product-selection-management/Delete-selection.md index 2c65a0efc0..860223a849 100644 --- a/docs/en/md/VK/Product-selection-management/Delete-selection.md +++ b/docs/en/md/VK/Product-selection-management/Delete-selection.md @@ -6,6 +6,11 @@ sidebar_position: 7 Deletes the selection by ID + + +
+ + *Function DeleteSelection(Val Selection, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 7 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.DeleteSelection(40, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,11 +37,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-selection-management/Edit-product-collection.md b/docs/en/md/VK/Product-selection-management/Edit-product-collection.md index e2137173f2..4167aab4de 100644 --- a/docs/en/md/VK/Product-selection-management/Edit-product-collection.md +++ b/docs/en/md/VK/Product-selection-management/Edit-product-collection.md @@ -6,6 +6,11 @@ sidebar_position: 4 Edits the properties of a product selection + + +
+ + *Function EditProductCollection(Val Name, Val Selection, Val Image = "", Val Main = False, Val Hidden = False, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.EditProductCollection("EditedCollection" , 40 @@ -32,8 +37,9 @@ sidebar_position: 4 Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -41,11 +47,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selection-list.md b/docs/en/md/VK/Product-selection-management/Get-selection-list.md index f20921be71..ceb4c4ae6d 100644 --- a/docs/en/md/VK/Product-selection-management/Get-selection-list.md +++ b/docs/en/md/VK/Product-selection-management/Get-selection-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the list of product selections + + +
+ + *Function GetSelectionList(Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Array of selection maps + ```bsl title="Code example" - Response = OPI_VK.GetSelectionList(Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -[ + [ { "is_hidden": false, "is_main": true, @@ -110,5 +114,4 @@ sidebar_position: 1 "id": 38 } ] - ``` diff --git a/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md b/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md index 06c2845bf6..2d5799ad5f 100644 --- a/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md +++ b/docs/en/md/VK/Product-selection-management/Get-selections-by-id.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets the list of selections by array of IDs + + +
+ + *Function GetSelectionsByID(Val Selections, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.GetSelectionsByID(Selections, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -[ + [ { "is_hidden": false, "is_main": true, @@ -111,5 +115,4 @@ sidebar_position: 2 "id": 38 } ] - ``` diff --git a/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md b/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md index d172861a57..998ad35999 100644 --- a/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md +++ b/docs/en/md/VK/Product-selection-management/Remove-product-from-selection.md @@ -6,6 +6,11 @@ sidebar_position: 6 Removes a previously added product from the selection + + +
+ + *Function RemoveProductFromSelection(Val Product, Val Selection, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.RemoveProductFromSelection(8656559, 40, Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,11 +38,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "response": 1 } - ``` diff --git a/docs/en/md/VK/Statistics/Get-post-statistics.md b/docs/en/md/VK/Statistics/Get-post-statistics.md index 0f548765b3..33cdc0a6f3 100644 --- a/docs/en/md/VK/Statistics/Get-post-statistics.md +++ b/docs/en/md/VK/Statistics/Get-post-statistics.md @@ -6,6 +6,11 @@ sidebar_position: 2 Gets statistics in terms of posts + + +
+ + *Function GetPostStatistics(Val PostIDsArray, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -16,8 +21,8 @@ sidebar_position: 2 Returns: Array of Arbitrary - Array of post statistics data + ```bsl title="Code example" - ArrayOfPosts = New Array; ArrayOfPosts.Add(214); @@ -26,8 +31,9 @@ sidebar_position: 2 Response = OPI_VK.GetPostStatistics(ArrayOfPosts, VK_Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -[ + [ { "ad_report": 0, "ad_coverage": 0, @@ -84,5 +88,4 @@ sidebar_position: 2 "post_id": 215 } ] - ``` diff --git a/docs/en/md/VK/Statistics/Get-statistics.md b/docs/en/md/VK/Statistics/Get-statistics.md index 719695e045..162f2e3310 100644 --- a/docs/en/md/VK/Statistics/Get-statistics.md +++ b/docs/en/md/VK/Statistics/Get-statistics.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets the overall community statistics for a period + + +
+ + *Function GetStatistics(Val StartDate, Val EndDate, Val Parameters = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,14 +22,15 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - Serialized JSON response from VK + ```bsl title="Code example" - Response = OPI_VK.GetStatistics(CurrentSessionDate() - 60 * 60 * 24, CurrentSessionDate(), Parameters); Response = OPI_Tools.JSONString(Response); - ``` + + ```sh title="CLI command example" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "response": [ { "visitors": { @@ -543,5 +547,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md index df722d17dc..63272e1fd0 100644 --- a/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/en/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Getting a link for interactive token retrieval (access_token), which is necessary for further actions + + +
+ + *Function CreateTokenRetrievalLink(Val App_id) Export* | Parameter | CLI option | Type | Destination | @@ -15,12 +20,13 @@ Getting a link for interactive token retrieval (access_token), which is necessar Returns: String - URL to go to in the browser + ```bsl title="Code example" - Application = "51694790"; Result = OPI_VK.CreateTokenRetrievalLink(Application); - ``` + + ```sh title="CLI command example" @@ -28,9 +34,6 @@ Getting a link for interactive token retrieval (access_token), which is necessar ``` - ```json title="Result" - -"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" - + "https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" ``` diff --git a/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md b/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md index b1ccc9daa9..bcde6320f8 100644 --- a/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md +++ b/docs/en/md/Viber/Message-sending/Create-keyboard-from-array-button.md @@ -6,6 +6,11 @@ sidebar_position: 7 Returns a keyboard structure for messages + + +
+ + *Function CreateKeyboardFromArrayButton(Val ButtonArray, Val ButtonColor = "#2db9b9") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 7 Returns: Structure - Create a keyboard from an array of buttons: + ```bsl title="Code example" - ButtonArray = New Array; ButtonArray.Add("Button 1"); @@ -28,8 +33,9 @@ sidebar_position: 7 Keyboard = OPI_Viber.CreateKeyboardFromArrayButton(ButtonArray); //Structure JSON = OPI_Tools.JSONString(Keyboard); //String - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 7 ``` - ```json title="Result" - -{ + { "Buttons": [ { "ActionType": "reply", @@ -66,5 +70,4 @@ sidebar_position: 7 ], "Type": "keyboard" } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-contact.md b/docs/en/md/Viber/Message-sending/Send-contact.md index a60640b552..8db61ad1fc 100644 --- a/docs/en/md/Viber/Message-sending/Send-contact.md +++ b/docs/en/md/Viber/Message-sending/Send-contact.md @@ -6,6 +6,11 @@ sidebar_position: 4 Sends a contact with a phone number to a chat or channel + + +
+ + *Function SendContact(Val Token, Val ContactName, Val PhoneNumber, Val UserID, Val SendingToChannel) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; UserID = "d3jxe1111111111jYGgZg=="; @@ -28,8 +33,9 @@ sidebar_position: 4 Response = OPI_Viber.SendContact(BotToken, "John Doe", "+749521231", UserID, False); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,15 +43,12 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-15_", "message_token": 5925747984748149627, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-file.md b/docs/en/md/Viber/Message-sending/Send-file.md index ee5d44d5ca..689d10ecdd 100644 --- a/docs/en/md/Viber/Message-sending/Send-file.md +++ b/docs/en/md/Viber/Message-sending/Send-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Sends a file (document) to a chat or channel + + +
+ + *Function SendFile(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Extension, Val Size = "") Export* | Parameter | CLI option | Type | Destination | @@ -20,8 +25,8 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; UserID = "tMNGh111111111D+bT4g=="; @@ -29,8 +34,9 @@ sidebar_position: 3 Response = OPI_Viber.SendFile(ChannelToken, "https://api.athenaeum.digital/1.txt", UserID, True, "txt"); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -38,14 +44,11 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "chat_hostname": "SN-CHAT-09_", "message_token": 5925491906424759104, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-image.md b/docs/en/md/Viber/Message-sending/Send-image.md index 197e10fe1e..780e9389fa 100644 --- a/docs/en/md/Viber/Message-sending/Send-image.md +++ b/docs/en/md/Viber/Message-sending/Send-image.md @@ -6,6 +6,11 @@ sidebar_position: 2 Sends an image to a chat or channel + + +
+ + *Function SendImage(Val Token, Val URL, Val UserID, Val SendingToChannel, Val Description = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - ChannelToken = "523b58ba82afffaa-111111111111111-2222222222222222"; UserID = "tMNGh111111111D+bT4g=="; @@ -28,8 +33,9 @@ sidebar_position: 2 Response = OPI_Viber.SendImage(ChannelToken, "https://api.athenaeum.digital/logo.png", UserID, True, "Alpaca"); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,14 +43,11 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "chat_hostname": "SN-CHAT-12_", "message_token": 5925484936191962157, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-link.md b/docs/en/md/Viber/Message-sending/Send-link.md index f6570f345c..52a9621fa3 100644 --- a/docs/en/md/Viber/Message-sending/Send-link.md +++ b/docs/en/md/Viber/Message-sending/Send-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Sends a URL with a preview to a chat or channel + + +
+ + *Function SendLink(Val Token, Val URL, Val UserID, Val SendingToChannel) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; UserID = "d3jxe1111111111jYGgZg=="; @@ -27,8 +32,9 @@ sidebar_position: 6 Response = OPI_Viber.SendLink(BotToken, "https://github.com/Bayselonarrend", UserID, False); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -36,15 +42,12 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-15_", "message_token": 5925752472607291800, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-location.md b/docs/en/md/Viber/Message-sending/Send-location.md index 89eba1eef4..db8a47803b 100644 --- a/docs/en/md/Viber/Message-sending/Send-location.md +++ b/docs/en/md/Viber/Message-sending/Send-location.md @@ -6,6 +6,11 @@ sidebar_position: 5 Sends geographic coordinates to a chat or channel + + +
+ + *Function SendLocation(Val Token, Val Latitude, Val Longitude, Val UserID, Val SendingToChannel) Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; UserID = "d3jxe1111111111jYGgZg=="; @@ -28,8 +33,9 @@ sidebar_position: 5 Response = OPI_Viber.SendLocation(BotToken, "55.75", "37.6167", UserID, False); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -37,15 +43,12 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-10_", "message_token": 5925751017338988046, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Message-sending/Send-text-message.md b/docs/en/md/Viber/Message-sending/Send-text-message.md index 548296ad02..093557b226 100644 --- a/docs/en/md/Viber/Message-sending/Send-text-message.md +++ b/docs/en/md/Viber/Message-sending/Send-text-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Sends a text message to a chat or channel + + +
+ + *Function SendTextMessage(Val Token, Val Text, Val UserID, Val SendingToChannel, Val Keyboard = "") Export* | Parameter | CLI option | Type | Destination | @@ -19,8 +24,8 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - BotToken = "523b5b25ed27e6ec-111111111111111-2222222222222222"; UserID = "d3jxe1111111111jYGgZg=="; @@ -36,8 +41,9 @@ sidebar_position: 1 Response = OPI_Viber.SendTextMessage(BotToken, "Hello", UserID, False, Keyboard); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -45,14 +51,11 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "chat_hostname": "SN-CHAT-10_", "message_token": 5925400810709476620, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-channel-information.md b/docs/en/md/Viber/Settings-and-information/Get-channel-information.md index 95a02fb73e..015465947f 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-channel-information.md +++ b/docs/en/md/Viber/Settings-and-information/Get-channel-information.md @@ -6,6 +6,11 @@ sidebar_position: 2 Here you can get the channel's user IDs. Bot IDs need to be obtained from the Webhook arrivals The user ID from channel information is not suitable for sending messages through the bot - they are different + + +
+ + *Function GetChannelInformation(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,14 +20,15 @@ Here you can get the channel's user IDs. Bot IDs need to be obtained from the We Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - Response = OPI_Viber.GetChannelInformation(ChannelToken); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -30,10 +36,8 @@ Here you can get the channel's user IDs. Bot IDs need to be obtained from the We ``` - ```json title="Result" - -{ + { "members": [ { "role": "admin", @@ -57,5 +61,4 @@ Here you can get the channel's user IDs. Bot IDs need to be obtained from the We "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-online-users.md b/docs/en/md/Viber/Settings-and-information/Get-online-users.md index 35fa02a76f..8f8a803fff 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-online-users.md +++ b/docs/en/md/Viber/Settings-and-information/Get-online-users.md @@ -6,6 +6,11 @@ sidebar_position: 4 Gets the status of a user or multiple users by ID + + +
+ + *Function GetOnlineUsers(Val Token, Val UserIDs) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - Response = OPI_Viber.GetOnlineUsers(Token, UserID); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "users": [ { "last_online": 1704796869778, @@ -46,5 +50,4 @@ sidebar_position: 4 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Settings-and-information/Get-user-data.md b/docs/en/md/Viber/Settings-and-information/Get-user-data.md index 4f3e4651c0..5cd9d7081c 100644 --- a/docs/en/md/Viber/Settings-and-information/Get-user-data.md +++ b/docs/en/md/Viber/Settings-and-information/Get-user-data.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets user information by ID + + +
+ + *Function GetUserData(Val Token, Val UserID) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - Response = OPI_Viber.GetUserData(Token, UserID); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "user": { "device_type": "iPhone8,4", "mnc": 1, @@ -52,5 +56,4 @@ sidebar_position: 3 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Viber/Settings-and-information/Set-webhook.md b/docs/en/md/Viber/Settings-and-information/Set-webhook.md index 02405fb44c..4f74199ff5 100644 --- a/docs/en/md/Viber/Settings-and-information/Set-webhook.md +++ b/docs/en/md/Viber/Settings-and-information/Set-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 1 IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to have a free URL for this., which will return 200 and a genuine SSL certificate. If there is a certificate and the database is published on the server - you can use an HTTP service. Information about new messages will also be sent there Viber periodically knocks on the Webhook address, so if it is inactive, everything will stop working + + +
+ + *Function SetWebhook(Val Token, Val URL) Export* | Parameter | CLI option | Type | Destination | @@ -16,14 +21,15 @@ IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to Returns: Map Of KeyAndValue - serialized JSON response from Viber + ```bsl title="Code example" - Response = OPI_Viber.SetWebhook(Token, "https://api.athenaeum.digital/opi/hs/viber"); //Map Response = OPI_Tools.JSONString(Response); //JSON string - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to ``` - ```json title="Result" - -{ + { "event_types": [ "subscribed", "unsubscribed", @@ -51,5 +55,4 @@ IMPORTANT: Setting up Webhook is mandatory according to Viber rules. You need to "status_message": "ok", "status": 0 } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md index 5bcd43520b..ae7bf62e0a 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 2 Creates a directory on the disk + + +
+ + *Function CreateFolder(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/TestFolder" Response = OPI_YandexDisk.CreateFolder(Token, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "revision": 1707461457546792, "comment_ids": { "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", @@ -58,5 +62,4 @@ sidebar_position: 2 "sort": "" } } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md index edb2e9cfa3..681d88a5aa 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md @@ -6,6 +6,11 @@ sidebar_position: 5 Creates a copy of the object at the specified path and path to the original + + +
+ + *Function CreateObjectCopy(Val Token, Val Original, Val Path, Val Overwrite = False) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Original = "/Alpaca.png"; @@ -28,8 +33,9 @@ sidebar_position: 5 Response = OPI_YandexDisk.CreateObjectCopy(Token, Original, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707469147481281, @@ -112,5 +116,4 @@ sidebar_position: 5 }, "mime_type": "multipart" } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md index 27b8e82af2..16b7650927 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 4 Deletes an object at the specified path + + +
+ + *Function DeleteObject(Val Token, Val Path, Val ToCart = True) Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png" Response = OPI_YandexDisk.DeleteObject(Token, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -34,9 +40,6 @@ sidebar_position: 4 ``` - ```json title="Result" - - - + ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md index 6bebe77ca7..dcaf0d828b 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 7 Downloads a file at the specified path + + +
+ + *Function DownloadFile(Val Token, Val Path, Val SavePath = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,12 +22,13 @@ sidebar_position: 7 Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified + ```bsl title="Code example" - Path = "/alpaca.png"; Result = OPI_YandexDisk.DownloadFile(Token, Path); - ``` + + ```sh title="CLI command example" @@ -30,9 +36,6 @@ sidebar_position: 7 ``` - ```json title="Result" - - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md index 1d7ffc53d2..7b94634aba 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Gets information about the current disk + + +
+ + *Function GetDiskInformation(Val Token) Export* | Parameter | CLI option | Type | Destination | @@ -15,15 +20,16 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Response = OPI_YandexDisk.GetDiskInformation(Token); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "user": { "login": "bayselonarrend", "country": "by", @@ -70,5 +74,4 @@ sidebar_position: 1 "paid_max_file_size": 53687091200, "max_file_size": 1073741824 } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md index cfe92e282a..4fa03f0f09 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-download-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Gets a download link for the file + + +
+ + *Function GetDownloadLink(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png" Response = OPI_YandexDisk.GetDownloadLink(Token, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,13 +39,10 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "templated": false, "method": "GET", "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md index c393e37802..7bb663bbeb 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 8 Gets a list of files with or without filtering by type List of available types: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web + + +
+ + *Function GetFilesList(Val Token, Val Count = 0, Val OffsetFromStart = 0, Val FilterByType = "", Val SortByDate = False) Export* | Parameter | CLI option | Type | Destination | @@ -19,15 +24,16 @@ Gets a list of files with or without filtering by type List of available types: Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Response = OPI_YandexDisk.GetFilesList(Token, 2, 1, "image"); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -35,10 +41,8 @@ Gets a list of files with or without filtering by type List of available types: ``` - ```json title="Result" - -{ + { "limit": 2, "offset": 1, "items": [ @@ -192,5 +196,4 @@ Gets a list of files with or without filtering by type List of available types: } ] } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md index 1e8b980a48..51fa2bd9af 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Get-object.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets information about a disk object at the specified path + + +
+ + *Function GetObject(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png" Response = OPI_YandexDisk.GetObject(Token, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707464146094880, @@ -108,5 +112,4 @@ sidebar_position: 3 }, "mime_type": "image/png" } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md index 8598cb9ac2..09ba0b61bb 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Move-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Moves the object to the specified path and path to the original + + +
+ + *Function MoveObject(Val Token, Val Original, Val Path, Val Overwrite = False) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 9 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Original = "/Alpaca.png"; @@ -28,8 +33,9 @@ sidebar_position: 9 Response = OPI_YandexDisk.MoveObject(Token, Original, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -37,10 +43,8 @@ sidebar_position: 9 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707469557170087, @@ -112,5 +116,4 @@ sidebar_position: 9 }, "mime_type": "image/png" } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md index b91874b372..885924f270 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 11 Downloads a file to disk from the specified URL + + +
+ + *Function UploadFileByURL(Val Token, Val Path, Val Address) Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 11 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png"; @@ -27,8 +32,9 @@ sidebar_position: 11 Response = OPI_YandexDisk.UploadFileByURL(Token, Path, Address); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -36,13 +42,10 @@ sidebar_position: 11 ``` - ```json title="Result" - -{ + { "templated": false, "method": "GET", "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" } - ``` diff --git a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md index dbbdb61b07..0a20606d85 100644 --- a/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ b/docs/en/md/Yandex_Disk/File-and-folder-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 10 Uploads a file to disk at the specified path + + +
+ + *Function UploadFile(Val Token, Val Path, Val File, Val Overwrite = False) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 10 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/AlpacaInFile.png"; @@ -28,8 +33,9 @@ sidebar_position: 10 Response = OPI_YandexDisk.UploadFile(Token, Path, File); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -37,9 +43,6 @@ sidebar_position: 10 ``` - ```json title="Result" - - - + ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md b/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md index 72b0a5ff74..f434b8ca84 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md @@ -6,6 +6,11 @@ sidebar_position: 2 Unpublishes a previously published object + + +
+ + *Function CancelObjectPublication(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 2 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png" Response = OPI_YandexDisk.CancelObjectPublication(Token, Path); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707477571749555, @@ -108,5 +112,4 @@ sidebar_position: 2 }, "mime_type": "image/png" } - ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md index ff4ac97242..59fe7f0142 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md @@ -6,6 +6,11 @@ sidebar_position: 5 Gets a direct link to download the public object + + +
+ + *Function GetDownloadLinkForPublicObject(Val Token, Val URL, Val Path = "") Export* | Parameter | CLI option | Type | Destination | @@ -17,8 +22,8 @@ sidebar_position: 5 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -26,8 +31,9 @@ sidebar_position: 5 Response = OPI_YandexDisk.GetDownloadLinkForPublicObject(Token, URL); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -35,13 +41,10 @@ sidebar_position: 5 ``` - ```json title="Result" - -{ + { "templated": false, "method": "GET", "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" } - ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md index dcd2a73391..83ab4a212a 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-public-object.md @@ -6,6 +6,11 @@ sidebar_position: 4 Gets information about the published object by its URL + + +
+ + *Function GetPublicObject(Val Token, Val URL, Val Count = 0, Val OffsetFromStart = 0) Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 4 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -27,8 +32,9 @@ sidebar_position: 4 Response = OPI_YandexDisk.GetPublicObject(Token, URL); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Result" - -{ + { "modified": "2024-02-09T10:50:41+00:00", "sizes": [ { @@ -119,5 +123,4 @@ sidebar_position: 4 "antivirus_status": "clean", "mime_type": "image/png" } - ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md b/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md index d5b9a43224..2edd984b85 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Gets a list of published objects + + +
+ + *Function GetPublishedObjectsList(Val Token, Val Count = 0, Val OffsetFromStart = 0) Export* | Parameter | CLI option | Type | Destination | @@ -17,16 +22,17 @@ sidebar_position: 3 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Response = OPI_YandexDisk.GetPublishedObjectsList(Token, 2, 1); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Result" - -{ + { "limit": 2, "offset": 1, "items": [ @@ -187,5 +191,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md index 534cfb8fed..aebac346db 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -6,6 +6,11 @@ sidebar_position: 1 Publishes the disk object for public access + + +
+ + *Function PublishObject(Val Token, Val Path) Export* | Parameter | CLI option | Type | Destination | @@ -16,16 +21,17 @@ sidebar_position: 1 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; Path = "/Alpaca.png" Response = OPI_YandexDisk.PublishObject(Token, Path); //Map; Link to file - Response["public_url"] Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -33,10 +39,8 @@ sidebar_position: 1 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707475863191537, @@ -110,5 +114,4 @@ sidebar_position: 1 "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" } } - ``` diff --git a/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md b/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md index 6e775fa6a7..e15d0cd7e2 100644 --- a/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md +++ b/docs/en/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md @@ -6,6 +6,11 @@ sidebar_position: 6 Saves the public object to your disk + + +
+ + *Function SavePublicObjectToDisk(Val Token, Val URL, From = "", Target = "") Export* | Parameter | CLI option | Type | Destination | @@ -18,8 +23,8 @@ sidebar_position: 6 Returns: Map Of KeyAndValue - serialized JSON response from Yandex + ```bsl title="Code example" - Token = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -27,8 +32,9 @@ sidebar_position: 6 Response = OPI_YandexDisk.SavePublicObjectToDisk(Token, URL); //Map Response = OPI_Tools.JSONString(Response); //String - ``` + + ```sh title="CLI command example" @@ -36,10 +42,8 @@ sidebar_position: 6 ``` - ```json title="Result" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707476319349747, @@ -111,5 +115,4 @@ sidebar_position: 6 }, "mime_type": "image/png" } - ``` diff --git a/docs/ru/cli/Bitrix24/ВключитьЗвукЗадачи.txt b/docs/ru/cli/Bitrix24/ВключитьЗвукЗадачи.txt new file mode 100644 index 0000000000..72a3333100 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВключитьЗвукЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ВключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ВосстановитьКаталог.txt b/docs/ru/cli/Bitrix24/ВосстановитьКаталог.txt new file mode 100644 index 0000000000..3f48aa0d24 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВосстановитьКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 ВосстановитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ВосстановитьФайл.txt b/docs/ru/cli/Bitrix24/ВосстановитьФайл.txt new file mode 100644 index 0000000000..9f23615538 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВосстановитьФайл.txt @@ -0,0 +1 @@ +oint bitrix24 ВосстановитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ДобавитьКомментарийЗадачи.txt b/docs/ru/cli/Bitrix24/ДобавитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..1e9f548f1d --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьКомментарийЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ДобавитьКомментарийНовости.txt b/docs/ru/cli/Bitrix24/ДобавитьКомментарийНовости.txt new file mode 100644 index 0000000000..00363c1454 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьКомментарийНовости.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьКомментарийНовости --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ДобавитьСтадиюКанбана.txt b/docs/ru/cli/Bitrix24/ДобавитьСтадиюКанбана.txt new file mode 100644 index 0000000000..85ef509b33 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьСтадиюКанбана.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ДобавитьФайлВЗадачу.txt b/docs/ru/cli/Bitrix24/ДобавитьФайлВЗадачу.txt new file mode 100644 index 0000000000..5bf4769a6e --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьФайлВЗадачу.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьФайлВЗадачу --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ЗагрузитьФайлВКаталог.txt b/docs/ru/cli/Bitrix24/ЗагрузитьФайлВКаталог.txt new file mode 100644 index 0000000000..bd25f7d004 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ЗагрузитьФайлВКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 ЗагрузитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ИзменитьКомментарийЗадачи.txt b/docs/ru/cli/Bitrix24/ИзменитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..a79c24ef4c --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьКомментарийЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ОтключитьЗвукЗадачи.txt b/docs/ru/cli/Bitrix24/ОтключитьЗвукЗадачи.txt new file mode 100644 index 0000000000..692f49ec79 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтключитьЗвукЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ОтключитьЗвукЗадачи --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПереименоватьКаталог.txt b/docs/ru/cli/Bitrix24/ПереименоватьКаталог.txt new file mode 100644 index 0000000000..5a4744fc88 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПереименоватьКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 ПереименоватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПереименоватьФайл.txt b/docs/ru/cli/Bitrix24/ПереименоватьФайл.txt new file mode 100644 index 0000000000..d81b891adc --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПереименоватьФайл.txt @@ -0,0 +1 @@ +oint bitrix24 ПереименоватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПереместитьКаталог.txt b/docs/ru/cli/Bitrix24/ПереместитьКаталог.txt new file mode 100644 index 0000000000..9238032431 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПереместитьКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 ПереместитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПереместитьФайлВКаталог.txt b/docs/ru/cli/Bitrix24/ПереместитьФайлВКаталог.txt new file mode 100644 index 0000000000..99ae0b0bab --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПереместитьФайлВКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 ПереместитьФайлВКаталог --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt b/docs/ru/cli/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt new file mode 100644 index 0000000000..af9bb9b9bf --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt @@ -0,0 +1 @@ +oint bitrix24 ПеренестиЗадачуВСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt b/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt new file mode 100644 index 0000000000..e13666ba2a --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьВнешнююСсылкуКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt b/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt new file mode 100644 index 0000000000..ec0068cc6b --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьВнешнююСсылкуФайла --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt b/docs/ru/cli/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt new file mode 100644 index 0000000000..ac9ba15415 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьДочерниеЭлементыКаталога --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьИнформациюОКаталоге.txt b/docs/ru/cli/Bitrix24/ПолучитьИнформациюОКаталоге.txt new file mode 100644 index 0000000000..ff2b02af8f --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьИнформациюОКаталоге.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьИнформациюОКаталоге --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьИнформациюОФайле.txt b/docs/ru/cli/Bitrix24/ПолучитьИнформациюОФайле.txt new file mode 100644 index 0000000000..59fc0c3f9b --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьИнформациюОФайле.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьИнформациюОФайле --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьКомменатрийЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьКомменатрийЗадачи.txt new file mode 100644 index 0000000000..9fff1e0180 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьКомменатрийЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьКомменатрийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокРезультатов.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокРезультатов.txt new file mode 100644 index 0000000000..0e806f40c6 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокРезультатов.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокРезультатов --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтадииКанбана.txt b/docs/ru/cli/Bitrix24/ПолучитьСтадииКанбана.txt new file mode 100644 index 0000000000..cec16aad3e --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтадииКанбана.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтадииКанбана --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтруктуруКомментария.txt b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруКомментария.txt new file mode 100644 index 0000000000..c730abedab --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруКомментария.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтруктуруКомментария --empty %empty% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt new file mode 100644 index 0000000000..462066f366 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСтруктуруФильтраКаталога --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПоместитьКаталогВКорзину.txt b/docs/ru/cli/Bitrix24/ПоместитьКаталогВКорзину.txt new file mode 100644 index 0000000000..2ea013fe46 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПоместитьКаталогВКорзину.txt @@ -0,0 +1 @@ +oint bitrix24 ПоместитьКаталогВКорзину --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПоместитьФайлВКорзину.txt b/docs/ru/cli/Bitrix24/ПоместитьФайлВКорзину.txt new file mode 100644 index 0000000000..3c0dca52eb --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПоместитьФайлВКорзину.txt @@ -0,0 +1 @@ +oint bitrix24 ПоместитьФайлВКорзину --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/ПроверитьДоступКЗадаче.txt b/docs/ru/cli/Bitrix24/ПроверитьДоступКЗадаче.txt new file mode 100644 index 0000000000..fb53c46008 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПроверитьДоступКЗадаче.txt @@ -0,0 +1 @@ +oint bitrix24 ПроверитьДоступКЗадаче --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/СкопироватьКаталог.txt b/docs/ru/cli/Bitrix24/СкопироватьКаталог.txt new file mode 100644 index 0000000000..8aeaa3c7ec --- /dev/null +++ b/docs/ru/cli/Bitrix24/СкопироватьКаталог.txt @@ -0,0 +1 @@ +oint bitrix24 СкопироватьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/СкопироватьФайл.txt b/docs/ru/cli/Bitrix24/СкопироватьФайл.txt new file mode 100644 index 0000000000..7bdeae4c64 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СкопироватьФайл.txt @@ -0,0 +1 @@ +oint bitrix24 СкопироватьФайл --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/СоздатьЗависимостьЗадач.txt b/docs/ru/cli/Bitrix24/СоздатьЗависимостьЗадач.txt new file mode 100644 index 0000000000..1aff53006b --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьЗависимостьЗадач.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьЗависимостьЗадач --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/СоздатьПодкаталог.txt b/docs/ru/cli/Bitrix24/СоздатьПодкаталог.txt new file mode 100644 index 0000000000..ace0655ed8 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьПодкаталог.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьПодкаталог --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/СоздатьРезультатИзКомментария.txt b/docs/ru/cli/Bitrix24/СоздатьРезультатИзКомментария.txt new file mode 100644 index 0000000000..df04b66bac --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьРезультатИзКомментария.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/УдалитьЗависимостьЗадач.txt b/docs/ru/cli/Bitrix24/УдалитьЗависимостьЗадач.txt new file mode 100644 index 0000000000..76e526f045 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьЗависимостьЗадач.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьЗависимостьЗадач --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьКомментарийЗадачи.txt b/docs/ru/cli/Bitrix24/УдалитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..aee4a8c90c --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьКомментарийЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьКомментарийЗадачи --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/УдалитьРезультатИзКомментария.txt b/docs/ru/cli/Bitrix24/УдалитьРезультатИзКомментария.txt new file mode 100644 index 0000000000..c670d4a8c4 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьРезультатИзКомментария.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьРезультатИзКомментария --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/cli/Bitrix24/УдалитьСтадиюКанбана.txt b/docs/ru/cli/Bitrix24/УдалитьСтадиюКанбана.txt new file mode 100644 index 0000000000..cd363c9969 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьСтадиюКанбана.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьСтадиюКанбана --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..." diff --git a/docs/ru/data/Bitrix24/ВключитьЗвукЗадачи.json b/docs/ru/data/Bitrix24/ВключитьЗвукЗадачи.json new file mode 100644 index 0000000000..b333266933 --- /dev/null +++ b/docs/ru/data/Bitrix24/ВключитьЗвукЗадачи.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "502", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ВосстановитьКаталог.json b/docs/ru/data/Bitrix24/ВосстановитьКаталог.json new file mode 100644 index 0000000000..d433d425ba --- /dev/null +++ b/docs/ru/data/Bitrix24/ВосстановитьКаталог.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ВосстановитьФайл.json b/docs/ru/data/Bitrix24/ВосстановитьФайл.json new file mode 100644 index 0000000000..47b617a435 --- /dev/null +++ b/docs/ru/data/Bitrix24/ВосстановитьФайл.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDФайла": 2484, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ДобавитьКомментарийЗадачи.json b/docs/ru/data/Bitrix24/ДобавитьКомментарийЗадачи.json new file mode 100644 index 0000000000..7b6c6a49e0 --- /dev/null +++ b/docs/ru/data/Bitrix24/ДобавитьКомментарийЗадачи.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "504", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ДобавитьКомментарийНовости.json b/docs/ru/data/Bitrix24/ДобавитьКомментарийНовости.json new file mode 100644 index 0000000000..22595f78ee --- /dev/null +++ b/docs/ru/data/Bitrix24/ДобавитьКомментарийНовости.json @@ -0,0 +1,5 @@ +{ +"IDНовости": 260, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ДобавитьСтадиюКанбана.json b/docs/ru/data/Bitrix24/ДобавитьСтадиюКанбана.json new file mode 100644 index 0000000000..089116544f --- /dev/null +++ b/docs/ru/data/Bitrix24/ДобавитьСтадиюКанбана.json @@ -0,0 +1,4 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ДобавитьФайлВЗадачу.json b/docs/ru/data/Bitrix24/ДобавитьФайлВЗадачу.json new file mode 100644 index 0000000000..54a622cdff --- /dev/null +++ b/docs/ru/data/Bitrix24/ДобавитьФайлВЗадачу.json @@ -0,0 +1,6 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "502", +"IDФайла": 2480, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ЗагрузитьФайлВКаталог.json b/docs/ru/data/Bitrix24/ЗагрузитьФайлВКаталог.json new file mode 100644 index 0000000000..7289fc2095 --- /dev/null +++ b/docs/ru/data/Bitrix24/ЗагрузитьФайлВКаталог.json @@ -0,0 +1,7 @@ +{ +"Картинка2": "https://openintegrations.dev/test_data/picture.jpg", +"Картинка": "https://openintegrations.dev/test_data/picture2.jpg", +"IDПриемника": 2490, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ИзменитьКомментарийЗадачи.json b/docs/ru/data/Bitrix24/ИзменитьКомментарийЗадачи.json new file mode 100644 index 0000000000..6c04f8b233 --- /dev/null +++ b/docs/ru/data/Bitrix24/ИзменитьКомментарийЗадачи.json @@ -0,0 +1,6 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "504", +"IDКомментария": 1720, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ОтключитьЗвукЗадачи.json b/docs/ru/data/Bitrix24/ОтключитьЗвукЗадачи.json new file mode 100644 index 0000000000..b333266933 --- /dev/null +++ b/docs/ru/data/Bitrix24/ОтключитьЗвукЗадачи.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "502", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПереименоватьКаталог.json b/docs/ru/data/Bitrix24/ПереименоватьКаталог.json new file mode 100644 index 0000000000..77fc013031 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПереименоватьКаталог.json @@ -0,0 +1,6 @@ +{ +"IDКаталога2": 2488, +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПереименоватьФайл.json b/docs/ru/data/Bitrix24/ПереименоватьФайл.json new file mode 100644 index 0000000000..d075ec75fb --- /dev/null +++ b/docs/ru/data/Bitrix24/ПереименоватьФайл.json @@ -0,0 +1,6 @@ +{ +"IDФайла2": 2482, +"URL": "b24-ar17wx.bitrix24.by", +"IDФайла": 2484, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПереместитьКаталог.json b/docs/ru/data/Bitrix24/ПереместитьКаталог.json new file mode 100644 index 0000000000..97cef7aa53 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПереместитьКаталог.json @@ -0,0 +1,6 @@ +{ +"IDПриемника": 2488, +"IDКаталога": 2492, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПереместитьФайлВКаталог.json b/docs/ru/data/Bitrix24/ПереместитьФайлВКаталог.json new file mode 100644 index 0000000000..c936a371c9 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПереместитьФайлВКаталог.json @@ -0,0 +1,6 @@ +{ +"IDКаталога": 2494, +"IDФайла": 2484, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.json b/docs/ru/data/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.json new file mode 100644 index 0000000000..b3556f60ea --- /dev/null +++ b/docs/ru/data/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.json @@ -0,0 +1,6 @@ +{ +"IDЗадачи": "528", +"IDСтадии": 128, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуКаталога.json b/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуКаталога.json new file mode 100644 index 0000000000..d433d425ba --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуКаталога.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуФайла.json b/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуФайла.json new file mode 100644 index 0000000000..47b617a435 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьВнешнююСсылкуФайла.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDФайла": 2484, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьДочерниеЭлементыКаталога.json b/docs/ru/data/Bitrix24/ПолучитьДочерниеЭлементыКаталога.json new file mode 100644 index 0000000000..d433d425ba --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьДочерниеЭлементыКаталога.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьИнформациюОКаталоге.json b/docs/ru/data/Bitrix24/ПолучитьИнформациюОКаталоге.json new file mode 100644 index 0000000000..d433d425ba --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьИнформациюОКаталоге.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьИнформациюОФайле.json b/docs/ru/data/Bitrix24/ПолучитьИнформациюОФайле.json new file mode 100644 index 0000000000..47b617a435 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьИнформациюОФайле.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDФайла": 2484, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьКомменатрийЗадачи.json b/docs/ru/data/Bitrix24/ПолучитьКомменатрийЗадачи.json new file mode 100644 index 0000000000..853ee2bfab --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьКомменатрийЗадачи.json @@ -0,0 +1,6 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКомментария": 1720, +"IDЗадачи": "504", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьСписокКомментариевЗадачи.json b/docs/ru/data/Bitrix24/ПолучитьСписокКомментариевЗадачи.json new file mode 100644 index 0000000000..7b6c6a49e0 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьСписокКомментариевЗадачи.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "504", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьСписокРезультатов.json b/docs/ru/data/Bitrix24/ПолучитьСписокРезультатов.json new file mode 100644 index 0000000000..7b6c6a49e0 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьСписокРезультатов.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "504", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.json b/docs/ru/data/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.json new file mode 100644 index 0000000000..d37f3001c4 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.json @@ -0,0 +1,4 @@ +{ +"Домен": "b24-ar17wx.bitrix24.by", +"ClientID": "local.6667fc928a50a9.70414732" +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьСтадииКанбана.json b/docs/ru/data/Bitrix24/ПолучитьСтадииКанбана.json new file mode 100644 index 0000000000..089116544f --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьСтадииКанбана.json @@ -0,0 +1,4 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПолучитьСтруктуруФильтраКаталога.json b/docs/ru/data/Bitrix24/ПолучитьСтруктуруФильтраКаталога.json new file mode 100644 index 0000000000..089116544f --- /dev/null +++ b/docs/ru/data/Bitrix24/ПолучитьСтруктуруФильтраКаталога.json @@ -0,0 +1,4 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПоместитьКаталогВКорзину.json b/docs/ru/data/Bitrix24/ПоместитьКаталогВКорзину.json new file mode 100644 index 0000000000..d433d425ba --- /dev/null +++ b/docs/ru/data/Bitrix24/ПоместитьКаталогВКорзину.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКаталога": 2490, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПоместитьФайлВКорзину.json b/docs/ru/data/Bitrix24/ПоместитьФайлВКорзину.json new file mode 100644 index 0000000000..47b617a435 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПоместитьФайлВКорзину.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDФайла": 2484, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/ПроверитьДоступКЗадаче.json b/docs/ru/data/Bitrix24/ПроверитьДоступКЗадаче.json new file mode 100644 index 0000000000..b333266933 --- /dev/null +++ b/docs/ru/data/Bitrix24/ПроверитьДоступКЗадаче.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "502", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/СкопироватьКаталог.json b/docs/ru/data/Bitrix24/СкопироватьКаталог.json new file mode 100644 index 0000000000..158d7ef269 --- /dev/null +++ b/docs/ru/data/Bitrix24/СкопироватьКаталог.json @@ -0,0 +1,6 @@ +{ +"IDПриемника": 2494, +"IDКаталога": 2492, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/СкопироватьФайл.json b/docs/ru/data/Bitrix24/СкопироватьФайл.json new file mode 100644 index 0000000000..af1f3160b0 --- /dev/null +++ b/docs/ru/data/Bitrix24/СкопироватьФайл.json @@ -0,0 +1,6 @@ +{ +"IDКаталога": 2490, +"IDФайла": 2484, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/СоздатьЗависимостьЗадач.json b/docs/ru/data/Bitrix24/СоздатьЗависимостьЗадач.json new file mode 100644 index 0000000000..2cfe156681 --- /dev/null +++ b/docs/ru/data/Bitrix24/СоздатьЗависимостьЗадач.json @@ -0,0 +1,6 @@ +{ +"IDИсточника": "502", +"IDПриемника": "500", +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/СоздатьПодкаталог.json b/docs/ru/data/Bitrix24/СоздатьПодкаталог.json new file mode 100644 index 0000000000..fac66c1d2b --- /dev/null +++ b/docs/ru/data/Bitrix24/СоздатьПодкаталог.json @@ -0,0 +1,5 @@ +{ +"IDКаталога": 2490, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/СоздатьРезультатИзКомментария.json b/docs/ru/data/Bitrix24/СоздатьРезультатИзКомментария.json new file mode 100644 index 0000000000..52983b1f98 --- /dev/null +++ b/docs/ru/data/Bitrix24/СоздатьРезультатИзКомментария.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКомментария": 1720, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/УдалитьКомментарийЗадачи.json b/docs/ru/data/Bitrix24/УдалитьКомментарийЗадачи.json new file mode 100644 index 0000000000..6c04f8b233 --- /dev/null +++ b/docs/ru/data/Bitrix24/УдалитьКомментарийЗадачи.json @@ -0,0 +1,6 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDЗадачи": "504", +"IDКомментария": 1720, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/УдалитьРезультатИзКомментария.json b/docs/ru/data/Bitrix24/УдалитьРезультатИзКомментария.json new file mode 100644 index 0000000000..52983b1f98 --- /dev/null +++ b/docs/ru/data/Bitrix24/УдалитьРезультатИзКомментария.json @@ -0,0 +1,5 @@ +{ +"URL": "b24-ar17wx.bitrix24.by", +"IDКомментария": 1720, +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/Bitrix24/УдалитьСтадиюКанбана.json b/docs/ru/data/Bitrix24/УдалитьСтадиюКанбана.json new file mode 100644 index 0000000000..1df81d4d2b --- /dev/null +++ b/docs/ru/data/Bitrix24/УдалитьСтадиюКанбана.json @@ -0,0 +1,5 @@ +{ +"IDСтадии": 128, +"URL": "b24-ar17wx.bitrix24.by", +"Токен": "56898d66006e9f06006b12e400000001000..." +} \ No newline at end of file diff --git a/docs/ru/data/VK/ДобавитьВариантСвойстваТовара.json b/docs/ru/data/VK/ДобавитьВариантСвойстваТовара.json new file mode 100644 index 0000000000..b45fcc209a --- /dev/null +++ b/docs/ru/data/VK/ДобавитьВариантСвойстваТовара.json @@ -0,0 +1,3 @@ +{ +"Свойство": "589" +} \ No newline at end of file diff --git a/docs/ru/data/VK/ДобавитьТовар.json b/docs/ru/data/VK/ДобавитьТовар.json new file mode 100644 index 0000000000..5229afe7fa --- /dev/null +++ b/docs/ru/data/VK/ДобавитьТовар.json @@ -0,0 +1,5 @@ +{ +"Картинка1": "https://openintegrations.dev/test_data/picture.jpg", +"Картинка2": "https://openintegrations.dev/test_data/picture2.jpg", +"Подборка": 124 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ДобавитьТоварВПодборку.json b/docs/ru/data/VK/ДобавитьТоварВПодборку.json new file mode 100644 index 0000000000..f47055c85f --- /dev/null +++ b/docs/ru/data/VK/ДобавитьТоварВПодборку.json @@ -0,0 +1,4 @@ +{ +"Товар": 9259545, +"Подборка": 124 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ЗагрузитьВидеоНаСервер.json b/docs/ru/data/VK/ЗагрузитьВидеоНаСервер.json new file mode 100644 index 0000000000..f9fabb687c --- /dev/null +++ b/docs/ru/data/VK/ЗагрузитьВидеоНаСервер.json @@ -0,0 +1,3 @@ +{ +"Видео": "https://openintegrations.dev/test_data/video.mp4" +} \ No newline at end of file diff --git a/docs/ru/data/VK/ИзменитьВариантСвойстваТовара.json b/docs/ru/data/VK/ИзменитьВариантСвойстваТовара.json new file mode 100644 index 0000000000..5496b9aacb --- /dev/null +++ b/docs/ru/data/VK/ИзменитьВариантСвойстваТовара.json @@ -0,0 +1,4 @@ +{ +"Свойство": "589", +"Вариант": 1867 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ИзменитьПодборкуТоваров.json b/docs/ru/data/VK/ИзменитьПодборкуТоваров.json new file mode 100644 index 0000000000..9bafb3fb8f --- /dev/null +++ b/docs/ru/data/VK/ИзменитьПодборкуТоваров.json @@ -0,0 +1,3 @@ +{ +"Подборка": 124 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ИзменитьСвойствоТовара.json b/docs/ru/data/VK/ИзменитьСвойствоТовара.json new file mode 100644 index 0000000000..b45fcc209a --- /dev/null +++ b/docs/ru/data/VK/ИзменитьСвойствоТовара.json @@ -0,0 +1,3 @@ +{ +"Свойство": "589" +} \ No newline at end of file diff --git a/docs/ru/data/VK/ИзменитьТовар.json b/docs/ru/data/VK/ИзменитьТовар.json new file mode 100644 index 0000000000..4351ba4f63 --- /dev/null +++ b/docs/ru/data/VK/ИзменитьТовар.json @@ -0,0 +1,3 @@ +{ +"Товар": 9259545 +} \ No newline at end of file diff --git a/docs/ru/data/VK/НаписатьКомментарий.json b/docs/ru/data/VK/НаписатьКомментарий.json new file mode 100644 index 0000000000..0121dca19b --- /dev/null +++ b/docs/ru/data/VK/НаписатьКомментарий.json @@ -0,0 +1,3 @@ +{ +"IDПоста": 2991 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ПолучитьТоварыПоИД.json b/docs/ru/data/VK/ПолучитьТоварыПоИД.json new file mode 100644 index 0000000000..9f0e779dd8 --- /dev/null +++ b/docs/ru/data/VK/ПолучитьТоварыПоИД.json @@ -0,0 +1,4 @@ +{ +"Товар1": 9259546, +"Товар2": 9259547 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ПоставитьЛайк.json b/docs/ru/data/VK/ПоставитьЛайк.json new file mode 100644 index 0000000000..0121dca19b --- /dev/null +++ b/docs/ru/data/VK/ПоставитьЛайк.json @@ -0,0 +1,3 @@ +{ +"IDПоста": 2991 +} \ No newline at end of file diff --git a/docs/ru/data/VK/ПриостановитьРекламноеОбъявление.json b/docs/ru/data/VK/ПриостановитьРекламноеОбъявление.json new file mode 100644 index 0000000000..ffddd7fef9 --- /dev/null +++ b/docs/ru/data/VK/ПриостановитьРекламноеОбъявление.json @@ -0,0 +1,4 @@ +{ +"IDКабинета": "1607951446", +"IDОбъявления": 0 +} \ No newline at end of file diff --git a/docs/ru/data/VK/СгруппироватьТовары.json b/docs/ru/data/VK/СгруппироватьТовары.json new file mode 100644 index 0000000000..9f0e779dd8 --- /dev/null +++ b/docs/ru/data/VK/СгруппироватьТовары.json @@ -0,0 +1,4 @@ +{ +"Товар1": 9259546, +"Товар2": 9259547 +} \ No newline at end of file diff --git a/docs/ru/data/VK/СоздатьПодборкуТоваров.json b/docs/ru/data/VK/СоздатьПодборкуТоваров.json new file mode 100644 index 0000000000..01b414bbe3 --- /dev/null +++ b/docs/ru/data/VK/СоздатьПодборкуТоваров.json @@ -0,0 +1,3 @@ +{ +"Картинка": "https://openintegrations.dev/test_data/picture.jpg" +} \ No newline at end of file diff --git a/docs/ru/data/VK/СоздатьРекламноеОбъявление.json b/docs/ru/data/VK/СоздатьРекламноеОбъявление.json new file mode 100644 index 0000000000..657e342bc0 --- /dev/null +++ b/docs/ru/data/VK/СоздатьРекламноеОбъявление.json @@ -0,0 +1,5 @@ +{ +"НомерКампании": 1030365918, +"IDПоста": 2991, +"IDКабинета": "1607951446" +} \ No newline at end of file diff --git a/docs/ru/data/VK/СоздатьРекламнуюКампанию.json b/docs/ru/data/VK/СоздатьРекламнуюКампанию.json new file mode 100644 index 0000000000..26be11cb0d --- /dev/null +++ b/docs/ru/data/VK/СоздатьРекламнуюКампанию.json @@ -0,0 +1,3 @@ +{ +"IDКабинета": "1607951446" +} \ No newline at end of file diff --git a/docs/ru/data/VK/СоздатьТоварСоСвойством.json b/docs/ru/data/VK/СоздатьТоварСоСвойством.json new file mode 100644 index 0000000000..a64772f123 --- /dev/null +++ b/docs/ru/data/VK/СоздатьТоварСоСвойством.json @@ -0,0 +1,6 @@ +{ +"Картинка1": "https://openintegrations.dev/test_data/picture.jpg", +"Картинка2": "https://openintegrations.dev/test_data/picture2.jpg", +"ВариантСвойства1": 1867, +"ВариантСвойства2": 1868 +} \ No newline at end of file diff --git a/docs/ru/data/VK/УдалитьВариантСвойстваТовара.json b/docs/ru/data/VK/УдалитьВариантСвойстваТовара.json new file mode 100644 index 0000000000..4fbd96676c --- /dev/null +++ b/docs/ru/data/VK/УдалитьВариантСвойстваТовара.json @@ -0,0 +1,3 @@ +{ +"Вариант": 1867 +} \ No newline at end of file diff --git a/docs/ru/data/VK/УдалитьПодборку.json b/docs/ru/data/VK/УдалитьПодборку.json new file mode 100644 index 0000000000..9bafb3fb8f --- /dev/null +++ b/docs/ru/data/VK/УдалитьПодборку.json @@ -0,0 +1,3 @@ +{ +"Подборка": 124 +} \ No newline at end of file diff --git a/docs/ru/data/VK/УдалитьСвойствоТовара.json b/docs/ru/data/VK/УдалитьСвойствоТовара.json new file mode 100644 index 0000000000..b45fcc209a --- /dev/null +++ b/docs/ru/data/VK/УдалитьСвойствоТовара.json @@ -0,0 +1,3 @@ +{ +"Свойство": "589" +} \ No newline at end of file diff --git a/docs/ru/data/VK/УдалитьТовар.json b/docs/ru/data/VK/УдалитьТовар.json new file mode 100644 index 0000000000..4351ba4f63 --- /dev/null +++ b/docs/ru/data/VK/УдалитьТовар.json @@ -0,0 +1,3 @@ +{ +"Товар": 9259545 +} \ No newline at end of file diff --git a/docs/ru/data/VK/УдалитьТоварИзПодборки.json b/docs/ru/data/VK/УдалитьТоварИзПодборки.json new file mode 100644 index 0000000000..f47055c85f --- /dev/null +++ b/docs/ru/data/VK/УдалитьТоварИзПодборки.json @@ -0,0 +1,4 @@ +{ +"Товар": 9259545, +"Подборка": 124 +} \ No newline at end of file diff --git a/docs/ru/examples/Bitrix24/ВключитьЗвукЗадачи.txt b/docs/ru/examples/Bitrix24/ВключитьЗвукЗадачи.txt new file mode 100644 index 0000000000..4c1c629976 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВключитьЗвукЗадачи.txt @@ -0,0 +1,11 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ВосстановитьКаталог.txt b/docs/ru/examples/Bitrix24/ВосстановитьКаталог.txt new file mode 100644 index 0000000000..70372ab4bb --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВосстановитьКаталог.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога, Токен); diff --git a/docs/ru/examples/Bitrix24/ВосстановитьФайл.txt b/docs/ru/examples/Bitrix24/ВосстановитьФайл.txt new file mode 100644 index 0000000000..c9969f18a1 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВосстановитьФайл.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла, Токен); diff --git a/docs/ru/examples/Bitrix24/ДобавитьКомментарийЗадачи.txt b/docs/ru/examples/Bitrix24/ДобавитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..635d831734 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьКомментарийЗадачи.txt @@ -0,0 +1,15 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Текст = "Задача невыполнима, расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Текст = "Задача выполнима, не расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст, Токен); diff --git a/docs/ru/examples/Bitrix24/ДобавитьКомментарийНовости.txt b/docs/ru/examples/Bitrix24/ДобавитьКомментарийНовости.txt new file mode 100644 index 0000000000..de6c9ad137 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьКомментарийНовости.txt @@ -0,0 +1,12 @@ + Текст = "Комментарий к новости"; + IDНовости = "260"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); + + + Текст = "Другой комментарий к новости"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст, Токен); diff --git a/docs/ru/examples/Bitrix24/ДобавитьСтадиюКанбана.txt b/docs/ru/examples/Bitrix24/ДобавитьСтадиюКанбана.txt new file mode 100644 index 0000000000..16e442e7e7 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьСтадиюКанбана.txt @@ -0,0 +1,16 @@ + Наименование = "Новая стадия"; + Цвет = "0026FF"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); + + + IDПредыдущей = Результат["result"]; + + Наименование = "Новая стадия 2"; + Цвет = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, IDПредыдущей, , Истина, Токен); diff --git a/docs/ru/examples/Bitrix24/ДобавитьФайлВЗадачу.txt b/docs/ru/examples/Bitrix24/ДобавитьФайлВЗадачу.txt new file mode 100644 index 0000000000..b6900ab8c4 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьФайлВЗадачу.txt @@ -0,0 +1,12 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + IDФайла = "2480"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла, Токен); diff --git a/docs/ru/examples/Bitrix24/ЗагрузитьФайлВКаталог.txt b/docs/ru/examples/Bitrix24/ЗагрузитьФайлВКаталог.txt new file mode 100644 index 0000000000..72bd045328 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ЗагрузитьФайлВКаталог.txt @@ -0,0 +1,18 @@ + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = "2490"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование, Картинка, IDПриемника, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьКомментарийЗадачи.txt b/docs/ru/examples/Bitrix24/ИзменитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..0dd5d0793d --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьКомментарийЗадачи.txt @@ -0,0 +1,16 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + IDКомментария = "1718"; + + Текст = "Задача изменена, не расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Текст = "Задача изменена, расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст, Токен); diff --git a/docs/ru/examples/Bitrix24/ОтключитьЗвукЗадачи.txt b/docs/ru/examples/Bitrix24/ОтключитьЗвукЗадачи.txt new file mode 100644 index 0000000000..cfbb135e1e --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтключитьЗвукЗадачи.txt @@ -0,0 +1,11 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ПереименоватьКаталог.txt b/docs/ru/examples/Bitrix24/ПереименоватьКаталог.txt new file mode 100644 index 0000000000..d4709388e5 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПереименоватьКаталог.txt @@ -0,0 +1,14 @@ + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + IDКаталога2 = "2488"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); + + + IDКаталога = "2490"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога, Наименование, Токен); diff --git a/docs/ru/examples/Bitrix24/ПереименоватьФайл.txt b/docs/ru/examples/Bitrix24/ПереименоватьФайл.txt new file mode 100644 index 0000000000..6ba84417b8 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПереименоватьФайл.txt @@ -0,0 +1,14 @@ + Наименование = "Новое имя файла.jpg"; + Наименование2 = "Новое имя файла 2.jpg"; + + IDФайла2 = "2482"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); + + + IDФайла = "2484"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла, Наименование, Токен); diff --git a/docs/ru/examples/Bitrix24/ПереместитьКаталог.txt b/docs/ru/examples/Bitrix24/ПереместитьКаталог.txt new file mode 100644 index 0000000000..c30ca21385 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПереместитьКаталог.txt @@ -0,0 +1,16 @@ + IDПриемника = "2488"; + IDКаталога = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); + + + IDКаталога = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника, Токен); + + Проверка_БитриксФайл(Результат); diff --git a/docs/ru/examples/Bitrix24/ПереместитьФайлВКаталог.txt b/docs/ru/examples/Bitrix24/ПереместитьФайлВКаталог.txt new file mode 100644 index 0000000000..82b8816cb9 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПереместитьФайлВКаталог.txt @@ -0,0 +1,16 @@ + IDКаталога = "2492"; + IDФайла = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); + + + IDКаталога = "2494"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога, Токен); + + Проверка_БитриксФайл(Результат); diff --git a/docs/ru/examples/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt b/docs/ru/examples/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt new file mode 100644 index 0000000000..4c900f80f8 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПеренестиЗадачуВСтадиюКанбана.txt @@ -0,0 +1,14 @@ + IDЗадачи = "528"; + IDСтадии = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); + + + IDСтадии = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии, , , Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt b/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt new file mode 100644 index 0000000000..bdd8feb5b2 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуКаталога.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt b/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt new file mode 100644 index 0000000000..b908a0db4b --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьВнешнююСсылкуФайла.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt b/docs/ru/examples/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt new file mode 100644 index 0000000000..1b6e6440c2 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьДочерниеЭлементыКаталога.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога, , Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьИнформациюОКаталоге.txt b/docs/ru/examples/Bitrix24/ПолучитьИнформациюОКаталоге.txt new file mode 100644 index 0000000000..f63541f9f7 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьИнформациюОКаталоге.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьИнформациюОФайле.txt b/docs/ru/examples/Bitrix24/ПолучитьИнформациюОФайле.txt new file mode 100644 index 0000000000..e2dcc8f114 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьИнформациюОФайле.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьКомменатрийЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьКомменатрийЗадачи.txt new file mode 100644 index 0000000000..7dfbb02770 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьКомменатрийЗадачи.txt @@ -0,0 +1,12 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокКомментариевЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокКомментариевЗадачи.txt new file mode 100644 index 0000000000..db6ebb83cc --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокКомментариевЗадачи.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокРезультатов.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокРезультатов.txt new file mode 100644 index 0000000000..9d7fbe08e8 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокРезультатов.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.txt b/docs/ru/examples/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.txt new file mode 100644 index 0000000000..69221d1283 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСсылкуАвторизацииПриложения.txt @@ -0,0 +1,4 @@ + Домен = "b24-ar17wx.bitrix24.by"; + ClientID = "local.6667fc928a50a9.70414732"; + + Результат = OPI_Bitrix24.ПолучитьСсылкуАвторизацииПриложения(Домен, ClientID); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСтадииКанбана.txt b/docs/ru/examples/Bitrix24/ПолучитьСтадииКанбана.txt new file mode 100644 index 0000000000..a5d4e2cd78 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСтадииКанбана.txt @@ -0,0 +1,9 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt b/docs/ru/examples/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt new file mode 100644 index 0000000000..0f3da0d605 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСтруктуруФильтраКаталога.txt @@ -0,0 +1,9 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL, Истина, Токен); diff --git a/docs/ru/examples/Bitrix24/ПоместитьКаталогВКорзину.txt b/docs/ru/examples/Bitrix24/ПоместитьКаталогВКорзину.txt new file mode 100644 index 0000000000..479c7a822a --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПоместитьКаталогВКорзину.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога, Токен); diff --git a/docs/ru/examples/Bitrix24/ПоместитьФайлВКорзину.txt b/docs/ru/examples/Bitrix24/ПоместитьФайлВКорзину.txt new file mode 100644 index 0000000000..36363c129d --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПоместитьФайлВКорзину.txt @@ -0,0 +1,10 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла, Токен); diff --git a/docs/ru/examples/Bitrix24/ПроверитьДоступКЗадаче.txt b/docs/ru/examples/Bitrix24/ПроверитьДоступКЗадаче.txt new file mode 100644 index 0000000000..fbd6ffcbe5 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПроверитьДоступКЗадаче.txt @@ -0,0 +1,15 @@ + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("1"); + МассивПользователей.Добавить("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей, Токен); diff --git a/docs/ru/examples/Bitrix24/СкопироватьКаталог.txt b/docs/ru/examples/Bitrix24/СкопироватьКаталог.txt new file mode 100644 index 0000000000..0ae1db9eea --- /dev/null +++ b/docs/ru/examples/Bitrix24/СкопироватьКаталог.txt @@ -0,0 +1,17 @@ + IDПриемника = "2492"; + IDКаталога = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); + + + IDПриемника = "2494"; + IDКаталога = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника, Токен); + + Проверка_БитриксФайл(Результат); diff --git a/docs/ru/examples/Bitrix24/СкопироватьФайл.txt b/docs/ru/examples/Bitrix24/СкопироватьФайл.txt new file mode 100644 index 0000000000..42d11c3f2c --- /dev/null +++ b/docs/ru/examples/Bitrix24/СкопироватьФайл.txt @@ -0,0 +1,16 @@ + IDКаталога = "2488"; + IDФайла = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); + + + IDКаталога = "2490"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога, Токен); + + Проверка_БитриксФайл(Результат); diff --git a/docs/ru/examples/Bitrix24/СоздатьЗависимостьЗадач.txt b/docs/ru/examples/Bitrix24/СоздатьЗависимостьЗадач.txt new file mode 100644 index 0000000000..c449cfd22f --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьЗависимостьЗадач.txt @@ -0,0 +1,17 @@ + IDИсточника = "500"; + IDПриемника = "502"; + ТипСвязи = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); + + + IDИсточника = "502"; + IDПриемника = "500"; + ТипСвязи = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи, Токен); diff --git a/docs/ru/examples/Bitrix24/СоздатьПодкаталог.txt b/docs/ru/examples/Bitrix24/СоздатьПодкаталог.txt new file mode 100644 index 0000000000..90c19fb4c4 --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьПодкаталог.txt @@ -0,0 +1,14 @@ + IDКаталога = "2490"; + Наименование = "Новый подкаталог"; + Наименование2 = "Новый подкаталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование, Токен); diff --git a/docs/ru/examples/Bitrix24/СоздатьРезультатИзКомментария.txt b/docs/ru/examples/Bitrix24/СоздатьРезультатИзКомментария.txt new file mode 100644 index 0000000000..82f34a0253 --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьРезультатИзКомментария.txt @@ -0,0 +1,11 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьКомментарийЗадачи.txt b/docs/ru/examples/Bitrix24/УдалитьКомментарийЗадачи.txt new file mode 100644 index 0000000000..d5dbd74578 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьКомментарийЗадачи.txt @@ -0,0 +1,12 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьРезультатИзКомментария.txt b/docs/ru/examples/Bitrix24/УдалитьРезультатИзКомментария.txt new file mode 100644 index 0000000000..e80103f95a --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьРезультатИзКомментария.txt @@ -0,0 +1,11 @@ + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьСтадиюКанбана.txt b/docs/ru/examples/Bitrix24/УдалитьСтадиюКанбана.txt new file mode 100644 index 0000000000..7970ce71fe --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьСтадиюКанбана.txt @@ -0,0 +1,13 @@ + IDСтадии = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); + + + IDСтадии = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, , Токен); diff --git a/docs/ru/examples/VK/СоздатьТоварСоСвойством.txt b/docs/ru/examples/VK/СоздатьТоварСоСвойством.txt new file mode 100644 index 0000000000..3d109a199e --- /dev/null +++ b/docs/ru/examples/VK/СоздатьТоварСоСвойством.txt @@ -0,0 +1,50 @@ + Параметры = ПолучитьПараметрыВК(); + + Картинка1 = "https://openintegrations.dev/test_data/picture.jpg"; + Картинка2 = "https://openintegrations.dev/test_data/picture2.jpg"; + ВариантСвойства1 = "1867"; + ВариантСвойства2 = "1868"; + + МассивКартинок = Новый Массив; + МассивКартинок.Добавить(Картинка1); + МассивКартинок.Добавить(Картинка2); + + Товар = Новый Соответствие(); + Товар.Вставить("Имя" , "Тестовый товар (со свойством)"); + Товар.Вставить("Описание" , "Описание товара"); + Товар.Вставить("Категория" , "20173"); + Товар.Вставить("Цена" , 1); + Товар.Вставить("СтараяЦена" , 15); + Товар.Вставить("ОсновноеФото" , Картинка1); + Товар.Вставить("URL" , "https://github.com/Bayselonarrend/OpenIntegrations"); + Товар.Вставить("ДополнительныеФото" , МассивКартинок); + Товар.Вставить("ГлавныйВГруппе" , Истина); + Товар.Вставить("НомерГруппы" , Неопределено); + Товар.Вставить("Ширина" , 20); + Товар.Вставить("Высота" , 30); + Товар.Вставить("Глубина" , 40); + Товар.Вставить("Вес" , 100); + Товар.Вставить("SKU" , 12345); + Товар.Вставить("ДоступныйОстаток" , "10"); + Товар.Вставить("ЗначенияСвойств" , ВариантСвойства1); + + Результат = OPI_VK.ДобавитьТовар(Товар, , Параметры); + + Проверка_ВКТовар(Результат); + + ИДТовара = Результат["response"]["market_item_id"]; + OPI_ПолучениеДанныхТестов.ЗаписатьПараметр("VK_MarketItemID2", ИДТовара); + ПараметрыФункции.Вставить("VK_MarketItemID2", ИДТовара); + + Товар.Вставить("Имя" , "Тестовый товар (другой)"); + Товар.Вставить("ЗначенияСвойств", ВариантСвойства2); + + Результат = OPI_VK.ДобавитьТовар(Товар, , Параметры); + + Проверка_ВКТовар(Результат); + + ИДТовара = Результат["response"]["market_item_id"]; + OPI_ПолучениеДанныхТестов.ЗаписатьПараметр("VK_MarketItemID3", ИДТовара); + ПараметрыФункции.Вставить("VK_MarketItemID3", ИДТовара); + + OPI_Инструменты.Пауза(5); diff --git a/docs/ru/md/Airtable/Comment-management/Create-comment.md b/docs/ru/md/Airtable/Comment-management/Create-comment.md index 96335a4096..f60c923db3 100644 --- a/docs/ru/md/Airtable/Comment-management/Create-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Create-comment.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает комментарий к записи в таблице + + +
+ + *Функция СоздатьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Текст) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 2 Ответ = OPI_Airtable.СоздатьКомментарий(Токен, База, Таблица, Запись, Текст); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "id": "comL1oGEDJvIQlMs1", "author": { "id": "usrFlaAHlTfYWAbVW", @@ -53,5 +57,4 @@ sidebar_position: 2 "createdTime": "2024-05-10T19:39:51.561Z", "lastUpdatedTime": null } - ``` diff --git a/docs/ru/md/Airtable/Comment-management/Delete-comment.md b/docs/ru/md/Airtable/Comment-management/Delete-comment.md index 772af5f99a..34f741afbd 100644 --- a/docs/ru/md/Airtable/Comment-management/Delete-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Delete-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет комментарий к записи таблицы + + +
+ + *Функция УдалитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 4 Ответ = OPI_Airtable.УдалитьКомментарий(Токен, База, Таблица, Запись, Коммент); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -39,12 +45,9 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "id": "comL1oGEDJvIQlMs1", "deleted": true } - ``` diff --git a/docs/ru/md/Airtable/Comment-management/Edit-comment.md b/docs/ru/md/Airtable/Comment-management/Edit-comment.md index a13fbbd0c7..f0a6b0eb7c 100644 --- a/docs/ru/md/Airtable/Comment-management/Edit-comment.md +++ b/docs/ru/md/Airtable/Comment-management/Edit-comment.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет текст существующего комментария + + +
+ + *Функция ИзменитьКомментарий(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Комментарий, Знач Текст) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -32,8 +37,9 @@ sidebar_position: 3 Ответ = OPI_Airtable.ИзменитьКомментарий(Токен, База, Таблица, Запись, Коммент, Текст); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "id": "comL1oGEDJvIQlMs1", "author": { "id": "usrFlaAHlTfYWAbVW", @@ -55,5 +59,4 @@ sidebar_position: 3 "createdTime": "2024-05-10T19:39:52Z", "lastUpdatedTime": "2024-05-10T19:39:51.967Z" } - ``` diff --git a/docs/ru/md/Airtable/Comment-management/Get-comments.md b/docs/ru/md/Airtable/Comment-management/Get-comments.md index cdb7016a24..96e7f83d99 100644 --- a/docs/ru/md/Airtable/Comment-management/Get-comments.md +++ b/docs/ru/md/Airtable/Comment-management/Get-comments.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список комментариев к записи в таблице + + +
+ + *Функция ПолучитьКомментарии(Знач Токен, Знач База, Знач Таблица, Знач Запись, Знач Отступ = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -29,8 +34,9 @@ sidebar_position: 1 Ответ = OPI_Airtable.ПолучитьКомментарии(Токен, База, Таблица, Запись); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "comments": [ { "id": "comL1oGEDJvIQlMs1", @@ -57,5 +61,4 @@ sidebar_position: 1 ], "offset": null } - ``` diff --git a/docs/ru/md/Airtable/Record-management/Create-posts.md b/docs/ru/md/Airtable/Record-management/Create-posts.md index f063b2c4eb..6fb7c4b965 100644 --- a/docs/ru/md/Airtable/Record-management/Create-posts.md +++ b/docs/ru/md/Airtable/Record-management/Create-posts.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает одну или массив записей по описанию или массиву описаний значений полей + + +
+ + *Функция СоздатьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Данные) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -36,8 +41,9 @@ sidebar_position: 3 Ответ = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, Данные); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "records": [ { "id": "recjHNKNZBWLZkZ7A", @@ -68,5 +72,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/ru/md/Airtable/Record-management/Delete-posts.md b/docs/ru/md/Airtable/Record-management/Delete-posts.md index 22b5b8a719..135e7f175d 100644 --- a/docs/ru/md/Airtable/Record-management/Delete-posts.md +++ b/docs/ru/md/Airtable/Record-management/Delete-posts.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет одну или массив записей по идентификаторам + + +
+ + *Функция УдалитьЗаписи(Знач Токен, Знач База, Знач Таблица, Знач Записи) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -31,8 +36,9 @@ sidebar_position: 4 Ответ = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "records": [ { "deleted": true, @@ -55,5 +59,4 @@ sidebar_position: 4 } ] } - ``` diff --git a/docs/ru/md/Airtable/Record-management/Get-list-of-records.md b/docs/ru/md/Airtable/Record-management/Get-list-of-records.md index 0c22f0ee62..3ee0e6c251 100644 --- a/docs/ru/md/Airtable/Record-management/Get-list-of-records.md +++ b/docs/ru/md/Airtable/Record-management/Get-list-of-records.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список записей выбранной таблицы + + +
+ + *Функция ПолучитьСписокЗаписей(Знач Токен, Знач База, Знач Таблица, Знач Отступ = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -27,8 +32,9 @@ sidebar_position: 1 Ответ = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица, Отступ); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "records": [ { "id": "recGyJ0MlN1H3GMuN", @@ -67,5 +71,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Airtable/Record-management/Get-record.md b/docs/ru/md/Airtable/Record-management/Get-record.md index 2b1c548a42..633c8b90b6 100644 --- a/docs/ru/md/Airtable/Record-management/Get-record.md +++ b/docs/ru/md/Airtable/Record-management/Get-record.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает данные строки таблицы по идентификатору + + +
+ + *Функция ПолучитьЗапись(Знач Токен, Знач База, Знач Таблица, Знач Запись) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -28,8 +33,9 @@ sidebar_position: 2 Ответ = OPI_Airtable.ПолучитьЗапись(Токен, База, Таблица, Запись); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "id": "recV6DxeLQMBNJrUk", "createdTime": "2024-05-10T19:39:51Z", "fields": { @@ -48,5 +52,4 @@ sidebar_position: 2 "Строковое": "Привет\n" } } - ``` diff --git a/docs/ru/md/Airtable/Table-management/Create-table.md b/docs/ru/md/Airtable/Table-management/Create-table.md index 637cdf19a0..f463df4b51 100644 --- a/docs/ru/md/Airtable/Table-management/Create-table.md +++ b/docs/ru/md/Airtable/Table-management/Create-table.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает новую таблицу в базе + + +
+ + *Функция СоздатьТаблицу(Знач Токен, Знач База, Знач Наименование, Знач МассивПолей, Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; ИмяТаблицы = "Тестовая таблица 2"; @@ -39,8 +44,9 @@ sidebar_position: 1 Ответ = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -48,10 +54,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "id": "tblT64aWyrMUAbUmF", "name": "Тестовая таблица 2", "description": "Новая таблица", @@ -122,5 +126,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Airtable/Table-management/Modify-table.md b/docs/ru/md/Airtable/Table-management/Modify-table.md index 216b00e58f..40d38cb080 100644 --- a/docs/ru/md/Airtable/Table-management/Modify-table.md +++ b/docs/ru/md/Airtable/Table-management/Modify-table.md @@ -6,6 +6,11 @@ sidebar_position: 2 Изменяет наименование и|или описание базы + + +
+ + *Функция ИзменитьТаблицу(Знач Токен, Знач База, Знач Таблица, Знач Наименование = "", Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -30,8 +35,9 @@ sidebar_position: 2 Ответ = OPI_Airtable.ИзменитьТаблицу(Токен, База, Таблица, Наименование, Описание); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "id": "tblT64aWyrMUAbUmF", "name": "Тестовая таблица 2 (изм.)", "description": "Новая таблица (изм.)", @@ -113,5 +117,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Create-database.md b/docs/ru/md/Airtable/Working-with-databases/Create-database.md index 22bfb7ecad..182c7a2d33 100644 --- a/docs/ru/md/Airtable/Working-with-databases/Create-database.md +++ b/docs/ru/md/Airtable/Working-with-databases/Create-database.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает новую базу данных + + +
+ + *Функция СоздатьБазу(Знач Токен, Знач РабочееПространство, Знач Наименование, Знач КоллекцияТаблиц) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - РабочееПространство = "wspdf8yl1yZz3PmWZ"; Наименование = "Тестовая база"; @@ -36,8 +41,9 @@ sidebar_position: 3 Ответ = OPI_Airtable.СоздатьБазу(Токен, РабочееПространство, Наименование, КоллекцияТаблиц); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "id": "applEsyJmBRm12AuN", "tables": [ { @@ -80,5 +84,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md b/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md index 71f1ef1b96..4972f13b42 100644 --- a/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md +++ b/docs/ru/md/Airtable/Working-with-databases/Get-database-tables.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает схему таблиц базы + + +
+ + *Функция ПолучитьТаблицыБазы(Знач Токен, Знач База) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Ответ = OPI_Airtable.ПолучитьТаблицыБазы(Токен, База); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "tables": [ { "id": "tblqZzW78Rvsdt9gt", @@ -67,5 +71,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md index 8180a5df12..1eb59ca542 100644 --- a/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md +++ b/docs/ru/md/Airtable/Working-with-databases/Get-list-of-bases.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список доступных баз + + +
+ + *Функция ПолучитьСписокБаз(Знач Токен, Знач Отступ = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,15 +21,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - Ответ = OPI_Airtable.ПолучитьСписокБаз(Токен); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "bases": [ { "id": "appGarzKZ0lu3gzoa", @@ -84,5 +88,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Create-field.md b/docs/ru/md/Airtable/Working-with-fields/Create-field.md index 92798bfcc9..c395af7681 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Create-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Create-field.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создет новое поле в таблице + + +
+ + *Функция СоздатьПоле(Знач Токен, Знач База, Знач Таблица, Знач СтруктураПоля) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -29,8 +34,9 @@ sidebar_position: 1 Ответ = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, СтруктураПоля); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "type": "number", "options": { "precision": 0 @@ -49,5 +53,4 @@ sidebar_position: 1 "id": "fld3IbFtHZtBHQwsk", "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md index 3a0f25ee3c..e67143a39c 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-attachment-field.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает описание поля файлового типа + + +
+ + *Функция ПолучитьПолеВложения(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 5 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Вложение"; Ответ = OPI_Airtable.ПолучитьПолеВложения(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "name": "Вложение", "type": "multipleAttachments" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md index b4b0d3fbef..0b0657622d 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-checkbox-field.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает описание поля типа булево + + +
+ + *Функция ПолучитьПолеФлажка(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 6 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Флажок"; Ответ = OPI_Airtable.ПолучитьПолеФлажка(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "name": "Флажок", "type": "checkbox", "options": { @@ -43,5 +47,4 @@ sidebar_position: 6 "color": "yellowBright" } } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md index 351ee4e432..f0e64ba932 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-date-field.md @@ -6,6 +6,11 @@ sidebar_position: 7 Получает описание поля типа дата + + +
+ + *Функция ПолучитьПолеДаты(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 7 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Дата"; Ответ = OPI_Airtable.ПолучитьПолеДаты(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "name": "Дата", "type": "date", "options": { @@ -45,5 +49,4 @@ sidebar_position: 7 } } } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md index f7eae47a65..6dd670c4d3 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-email-field.md @@ -6,6 +6,11 @@ sidebar_position: 8 Получает описание поля с электронной почтой + + +
+ + *Функция ПолучитьПолеПочты(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 8 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Почта"; Ответ = OPI_Airtable.ПолучитьПолеПочты(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "name": "Почта", "type": "email" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md index 9990e40ddc..ce45465c4f 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-link-field.md @@ -6,6 +6,11 @@ sidebar_position: 10 Получает описание поля с URL + + +
+ + *Функция ПолучитьПолеСсылки(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 10 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Ссылка"; Ответ = OPI_Airtable.ПолучитьПолеСсылки(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "name": "Ссылка", "type": "url" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md index dc510d3ce9..d5cceda990 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-number-field.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает описание поля числового типа + + +
+ + *Функция ПолучитьПолеНомера(Знач Наименование, Знач Точность = 0) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 4 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Номер"; Точность = "0"; @@ -25,8 +30,9 @@ sidebar_position: 4 Ответ = OPI_Airtable.ПолучитьПолеНомера(Наименование, Точность); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,15 +40,12 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "name": "Номер", "type": "number", "options": { "precision": 0 } } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md index 77d066e2a4..2735c1f0c7 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-phone-field.md @@ -6,6 +6,11 @@ sidebar_position: 9 Получает описание поля с номером телефона + + +
+ + *Функция ПолучитьПолеТелефона(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 9 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Телефон"; Ответ = OPI_Airtable.ПолучитьПолеТелефона(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "name": "Телефон", "type": "phoneNumber" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md b/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md index 12b6808211..55c3195d9d 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Get-string-field.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает описание поля строкового типа + + +
+ + *Функция ПолучитьПолеСтроковое(Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,16 +20,17 @@ sidebar_position: 3 Возвращаемое значение: Структура - Описание поля + ```bsl title="Пример кода" - Наименование = "Строковое"; Ответ = OPI_Airtable.ПолучитьПолеСтроковое(Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "name": "Строковое", "type": "richText" } - ``` diff --git a/docs/ru/md/Airtable/Working-with-fields/Modify-field.md b/docs/ru/md/Airtable/Working-with-fields/Modify-field.md index 8775785a52..260b8c39d9 100644 --- a/docs/ru/md/Airtable/Working-with-fields/Modify-field.md +++ b/docs/ru/md/Airtable/Working-with-fields/Modify-field.md @@ -6,6 +6,11 @@ sidebar_position: 2 Изменяет имя и|или описание существующего поля таблицы + + +
+ + *Функция ИзменитьПоле(Знач Токен, Знач База, Знач Таблица, Знач Поле, Знач Наименование = "", Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Airtable + ```bsl title="Пример кода" - База = "apptm8Xqo7TwMaipQ"; Таблица = "tbl9G4jVoTJpxYwSY"; @@ -32,8 +37,9 @@ sidebar_position: 2 Ответ = OPI_Airtable.ИзменитьПоле(Токен, База, Таблица, Поле, Наименование, Описание); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "type": "number", "options": { "precision": 0 @@ -53,5 +57,4 @@ sidebar_position: 2 "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(изм.)", "description": "Новое описание" } - ``` 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 new file mode 100644 index 0000000000..e6357e8821 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 3 +--- + +# Добавить комментарий задачи + Создает комментарий к задаче + + + + +
+ + +*Функция ДобавитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Текст = "Задача невыполнима, расходимся"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийЗадачи(URL, IDЗадачи, Текст); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Текст = "Задача выполнима, не расходимся"; + + Результат = 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 new file mode 100644 index 0000000000..c9c9bcefa5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 7 +--- + +# Создать результат из комментария + Создает результат задачи из комментария + + + + +
+ + +*Функция СоздатьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.СоздатьРезультатИзКомментария(URL, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = 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 new file mode 100644 index 0000000000..24fc4e1db5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 8 +--- + +# Удалить результат из комментария + Удаляет ранее созданный результат из комментария + + + + +
+ + +*Функция УдалитьРезультатИзКомментария(Знач URL, Знач IDКомментария, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.УдалитьРезультатИзКомментария(URL, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = 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 new file mode 100644 index 0000000000..fcdaef0648 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 5 +--- + +# Удалить комментарий + Удаляет существующий комментарий задачи + + + + +
+ + +*Функция УдалитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID удаляемого комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + IDКомментария = "1718"; + + Результат = OPI_Bitrix24.УдалитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = 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 new file mode 100644 index 0000000000..cd693b231d --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md @@ -0,0 +1,33 @@ +--- +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 new file mode 100644 index 0000000000..87e7fcc744 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 6 +--- + +# Получить список результатов + Получает список результатов задачи + + + + +
+ + +*Функция ПолучитьСписокРезультатов(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьСписокРезультатов(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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 new file mode 100644 index 0000000000..d47a91970a --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 2 +--- + +# Получить комменатрий задачи + Получает информацию о комментарии задачи по ID + + + + +
+ + +*Функция ПолучитьКомменатрийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКомментария = "1718"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьКомменатрийЗадачи(URL, IDЗадачи, IDКомментария); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Результат = 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 new file mode 100644 index 0000000000..5fb1bcc484 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 1 +--- + +# Получить список комментариев задачи + Полчает список комментариев пользователей к задаче по ID + + + + +
+ + +*Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + + Результат = OPI_Bitrix24.ПолучитьСписокКомментариевЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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 new file mode 100644 index 0000000000..446fa9f0a3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 4 +--- + +# Изменить комментарий задачи + Изменяет текст комментария задачи + + + + +
+ + +*Функция ИзменитьКомментарийЗадачи(Знач URL, Знач IDЗадачи, Знач IDКомментария, Знач Текст, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDКомментария | --comment | Число, Строка | ID комментария | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "504"; + IDКомментария = "1718"; + + Текст = "Задача изменена, не расходимся"; + + Результат = OPI_Bitrix24.ИзменитьКомментарийЗадачи(URL, IDЗадачи, IDКомментария, Текст); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDКомментария = "1720"; + + Текст = "Задача изменена, расходимся"; + + Результат = 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/Comments-and-results-managment/_category_.json b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json new file mode 100644 index 0000000000..c3ff2dfc4e --- /dev/null +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с комментариями и результатами задач", +"position": "5" +} \ No newline at end of file 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 new file mode 100644 index 0000000000..39fdcd6cd6 --- /dev/null +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-comment.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 6 +--- + +# Добавить комментарий новости + Добавляет комментарий к новости + + + + +
+ + +*Функция ДобавитьКомментарийНовости(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDНовости | --postid | Строка, Число | ID новости | + | Текст | --text | Строка | Текст комментария | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + Текст = "Комментарий к новости"; + IDНовости = "260"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ДобавитьКомментарийНовости(URL, IDНовости, Текст); + + + Текст = "Другой комментарий к новости"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Feed-posts-managment/Add-post-recipients.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md index 70b5975fdd..93e29bd196 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Add-post-recipients.md @@ -6,6 +6,11 @@ sidebar_position: 7 Добавляет новые группы или пользователей в получатели + + +
+ + *Функция ДобавитьПолучателейКНовости(Знач URL, Знач IDНовости, Знач Видимость, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - Видимость = "UA"; IDНовости = "124"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -31,8 +36,9 @@ sidebar_position: 7 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1718473318.17435, @@ -56,5 +60,4 @@ sidebar_position: 7 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md index e0f6846ca5..59e214052f 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md @@ -6,6 +6,13 @@ sidebar_position: 1 Создает новую новость в ленте +:::tip +Метод API: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +::: + +
+ + *Функция СоздатьНовость(Знач URL, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Важное = Ложь, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -21,8 +28,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - Текст = "Текст новости"; Заголовок = "Заголовок новости"; Картинка1 = "https://openintegrations.dev/test_data/picture.jpg"; @@ -42,8 +49,9 @@ sidebar_position: 1 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, , Токен); - ``` + + ```sh title="Пример команды CLI" @@ -51,10 +59,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "result": 18, "time": { "start": 1718130364.82176, @@ -67,5 +73,4 @@ sidebar_position: 1 "operating": 0.637988090515137 } } - ``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md index 9b03c4409a..a31b8651bf 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Delete-post.md @@ -6,6 +6,11 @@ sidebar_position: 3 Удаляет новость из ленты по выбранному ID + + +
+ + *Функция УдалитьНовость(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - IDНовости = "122"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -30,8 +35,9 @@ sidebar_position: 3 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.УдалитьНовость(URL, IDНовости, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1718130367.40777, @@ -55,5 +59,4 @@ sidebar_position: 3 "operating": 0.310499906539917 } } - ``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md index 7a929fe9b5..405bb197c9 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-important-post-viewers.md @@ -6,6 +6,11 @@ sidebar_position: 4 Возвращает список пользователей, просмотревших выбранное важное сообщение + + +
+ + *Функция ПолучитьСписокПросмотревшихВажное(Знач URL, Знач IDНовости, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - IDНовости = "122"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -29,8 +34,9 @@ sidebar_position: 4 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьСписокПросмотревшихВажное(URL, IDНовости, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "result": [ "1" ], @@ -56,5 +60,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md index 499a644ef5..b5fbb7aa76 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Get-posts.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает нвости или одну новость с отобором по ID или доступности + + +
+ + *Функция ПолучитьНовости(Знач URL, Знач IDНовости = "", Знач Отбор = "UA", Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - IDНовости = "124"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; @@ -30,8 +35,9 @@ sidebar_position: 5 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьНовости(URL, IDНовости, , Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "result": [ { "ID": "40", @@ -410,5 +414,4 @@ sidebar_position: 5 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md index 31f45591ca..c6e10dfdcd 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -6,6 +6,11 @@ sidebar_position: 2 Изменяет новость в ленте + + +
+ + *Функция ИзменитьНовость(Знач URL, Знач IDНовости, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -21,8 +26,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - Текст = "Новый текст новости"; Заголовок = "Новый заголовок новости"; Картинка1 = "https://openintegrations.dev/test_data/picture.jpg"; @@ -41,8 +46,9 @@ sidebar_position: 2 IDНовости = "122"; Результат = OPI_Bitrix24.ИзменитьНовость(URL, IDНовости, Текст, , Файлы, Заголовок, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -50,10 +56,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "result": 86, "time": { "start": 1718473311.53949, @@ -66,5 +70,4 @@ sidebar_position: 2 "operating": 0.326629877090454 } } - ``` diff --git a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md new file mode 100644 index 0000000000..19514f9eb8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -0,0 +1,71 @@ +--- +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 + + +```bsl title="Пример кода" + Наименование = "Новая стадия"; + Цвет = "0026FF"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ДобавитьСтадиюКанбана(URL, Наименование, Цвет, 6); + + + IDПредыдущей = Результат["result"]; + + Наименование = "Новая стадия 2"; + Цвет = "0026FF"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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 new file mode 100644 index 0000000000..c16f3eed8e --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 2 +--- + +# Удалить стадию канбана + Удаляет стадию канбана или Моего плана, при условии, что в ней нет задач + + + + +
+ + +*Функция УдалитьСтадиюКанбана(Знач URL, Знач IDСтадии, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСтадии | --stage | Строка, Число | ID стадии для удаления | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDСтадии = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.УдалитьСтадиюКанбана(URL, IDСтадии, Истина); + + + IDСтадии = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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 new file mode 100644 index 0000000000..3dddfd4006 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -0,0 +1,554 @@ +--- +sidebar_position: 3 +--- + +# Получить стадии канбана + Получает информацию о стадиях Канбана или Моего плана + + + + +
+ + +*Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСущности | --entityid | Строка, Число | ID группы или пользователя владельца канбан. Свой по умолчанию | + | КакАдминистратор | --admin | Булево | Позволяет получать стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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 new file mode 100644 index 0000000000..ec92ce8e69 --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 4 +--- + +# Перенести задачу в стадию канбана + Переносит задачу в выбранную стадию канбана + + + + +
+ + +*Функция ПеренестиЗадачуВСтадиюКанбана(Знач URL, Знач IDЗадачи, Знач IDСтадии, Знач Перед = 0, Знач После = 0, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для переноса | + | IDСтадии | --stage | Строка, Число | ID стадии | + | Перед | --before | Строка, Число | ID задачи, перед которой надо поставить выбранную (если не заполнено После) | + | После | --after | Строка, Число | ID задачи, после которой надо поставить выбранную (если не заполнено Перед) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDЗадачи = "528"; + IDСтадии = "126"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПеренестиЗадачуВСтадиюКанбана(URL, IDЗадачи, IDСтадии); + + + IDСтадии = "128"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/_category_.json b/docs/ru/md/Bitrix24/Kanban/_category_.json new file mode 100644 index 0000000000..1ce3d1eb5c --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Канбан", +"position": "6" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md index 7063172b58..3804271e6c 100644 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-app-auth-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Формирует ссылку для авторизации через браузер + + +
+ + *Функция ПолучитьСсылкуАвторизацииПриложения(Знач Домен, Знач ClientID) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,11 +21,15 @@ sidebar_position: 1 Возвращаемое значение: Строка - URL для перехода в браузере + ```bsl title="Пример кода" + Домен = "b24-ar17wx.bitrix24.by"; + ClientID = "local.6667fc928a50a9.70414732"; + + Результат = OPI_Bitrix24.ПолучитьСсылкуАвторизацииПриложения(Домен, ClientID); +``` - -``` ```sh title="Пример команды CLI" @@ -28,9 +37,6 @@ sidebar_position: 1 ``` - ```json title="Результат" - -"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" - + "https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732" ``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md index 646ec73cb0..229ac11999 100644 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает токен по коду авторизации + + +
+ + *Функция ПолучитьТокен(Знач ClientID, Знач ClientSecret, Знач Code) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - ClientID = "local.6667fc928a50a9.70414732"; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; Результат = OPI_Bitrix24.ПолучитьТокен(ClientID, ClientSecret, Code); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "error": "expired_token", "error_description": "The authorization token provided has expired." } - ``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md index bf3e1a6006..841246dfbf 100644 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Обновляет токен по Refresh токену + + +
+ + *Функция ОбновитьТокен(Знач ClientID, Знач ClientSecret, Знач Refresh) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - ClientID = "local.6667fc928a50a9.70414732"; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; Refresh = "a95e9b66006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ОбновитьТокен(ClientID, ClientSecret, Refresh); - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "access_token": "63a46866006e9f06006b12e4000000010000071997e1f54c1043e9f7193734af3018df", "expires": 1718133859, "expires_in": 3600, @@ -49,5 +53,4 @@ sidebar_position: 3 "user_id": 1, "refresh_token": "53239066006e9f06006b12e4000000010000078523b1fc75d58d6f0fa98b4632bc70ce" } - ``` diff --git a/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md b/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md index f75302bb72..aa148491cc 100644 --- a/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md +++ b/docs/ru/md/Bitrix24/Settings-and-administartion/Server-time.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает текущее серверное время + + +
+ + *Функция СерверноеВремя(Знач URL, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Результат = OPI_Bitrix24.СерверноеВремя(URL); @@ -27,8 +32,9 @@ sidebar_position: 4 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.СерверноеВремя(URL, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "result": "2024-06-13T18:40:54+00:00", "time": { "start": 1718304054.57877, @@ -52,5 +56,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md index 84db7a9898..f1211f339c 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md @@ -6,6 +6,11 @@ sidebar_position: 7 Создает пустой каталог в хранилище + + +
+ + *Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - IDХранилища = 3; Наименование = "Новый каталог"; Наименование2 = "Новый каталог 2"; @@ -34,8 +39,9 @@ sidebar_position: 7 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -43,10 +49,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "result": { "ID": 574, "NAME": "Новый каталог", @@ -75,5 +79,4 @@ sidebar_position: 7 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md new file mode 100644 index 0000000000..431cf85b10 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 9 +--- + +# Создать подкаталог + Создает каталог внутри другого каталога + + + + +
+ + +*Функция СоздатьПодкаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога родителя | + | Наименование | --title | Строка | Наименование нового каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDКаталога = "2490"; + Наименование = "Новый подкаталог"; + Наименование2 = "Новый подкаталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СоздатьПодкаталог(URL, IDКаталога, Наименование2); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Delete-file.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md index c4f3f21929..75010484e7 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md @@ -1,11 +1,16 @@ --- -sidebar_position: 8 +sidebar_position: 12 --- # Удалить файл Удаляет файл по ID + + +
+ + *Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDФайла = "488"; @@ -30,8 +35,9 @@ sidebar_position: 8 IDФайла = "478"; Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1718783933.86753, @@ -55,5 +59,4 @@ sidebar_position: 8 "operating": 3.73615193367004 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md index eff232fbfb..dd79fd4dae 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md @@ -1,11 +1,16 @@ --- -sidebar_position: 9 +sidebar_position: 13 --- # Удалить каталог Удаляет каталог с подкаталогами + + +
+ + *Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDКаталога = "480"; @@ -30,8 +35,9 @@ sidebar_position: 9 IDКаталога = "482"; Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1719047257.50616, @@ -55,5 +59,4 @@ sidebar_position: 9 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md index 8247d483f3..6f23438f6a 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает информацию о хранилище с которым может работать приложение для хранения своих данных + + +
+ + *Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "b24-ar17wx.bitrix24.by"; Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -32,8 +38,3 @@ sidebar_position: 2 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md new file mode 100644 index 0000000000..f2e88ada4d --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 21 +--- + +# Получить внешнюю ссылку файла + Получает внешнюю ссылку для доступа к файлу + + + + +
+ + +*Функция ПолучитьВнешнююСсылкуФайла(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуФайла(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-file-information.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md new file mode 100644 index 0000000000..33c4ef1cc0 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 20 +--- + +# Получить информацию о файле + Получает информацию о файле по ID + + + + +
+ + +*Функция ПолучитьИнформациюОФайле(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОФайле(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-folder-external-link.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md new file mode 100644 index 0000000000..f4259ec612 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 14 +--- + +# Получить внешнюю ссылку каталога + Получает внешнюю ссылку для доступа к каталогу + + + + +
+ + +*Функция ПолучитьВнешнююСсылкуКаталога(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьВнешнююСсылкуКаталога(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-folder-filter-structure.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md new file mode 100644 index 0000000000..febdb17be5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 27 +--- + +# Получить структуру фильтра каталога + Возвращает структуру полей для фильтрации дочерних элементов каталога + + + + +
+ + +*Функция ПолучитьСтруктуруФильтраКаталога(Знач URL, Знач Пустая = Ложь, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПолучитьСтруктуруФильтраКаталога(URL); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-folder-information.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md new file mode 100644 index 0000000000..87539add76 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 8 +--- + +# Получить информацию о каталоге + Получает информацию о каталоге + + + + +
+ + +*Функция ПолучитьИнформациюОКаталоге(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьИнформациюОКаталоге(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-folder-items.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md new file mode 100644 index 0000000000..335e3b97a2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md @@ -0,0 +1,98 @@ +--- +sidebar_position: 15 +--- + +# Получить дочерние элементы каталога + Получает дочерние элементы каталога + + + + +
+ + +*Функция ПолучитьДочерниеЭлементыКаталога(Знач URL, Знач IDКаталога, Знач Фильтр = "", Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Фильтр | --filter | Структура из КлючИЗначение | Отбор элементов (См. ПолучитьСтруктуруФильтраКаталога) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПолучитьДочерниеЭлементыКаталога(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Get-storage-objects.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md index 2bccd16d16..ff26e2ccc9 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает список файлов и каталогов, находящихся в корне хранилища + + +
+ + *Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDХранилища = 3; Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); @@ -28,8 +33,9 @@ sidebar_position: 5 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "result": [ { "ID": "568", @@ -95,5 +99,4 @@ sidebar_position: 5 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md index 528aac869e..8961474f03 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию о хранилище по ID + + +
+ + *Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDХранилища = 3; @@ -29,8 +34,9 @@ sidebar_position: 3 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "result": { "ID": "3", "NAME": "Общий диск", @@ -62,5 +66,4 @@ sidebar_position: 3 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md index 2e848616e7..078656d3b9 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список доступных хранилищ файлов + + +
+ + *Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); @@ -26,8 +31,9 @@ sidebar_position: 1 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "result": [ { "ID": "3", @@ -116,5 +120,4 @@ sidebar_position: 1 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md new file mode 100644 index 0000000000..f4e90ae092 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 24 +--- + +# Скопировать файл + Копирует файл из одного расположения в другое + + + + +
+ + +*Функция СкопироватьФайл(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для копирования | + | IDКаталога | --folderid | Строка, Число | ID каталога размещения копии | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDКаталога = "2488"; + IDФайла = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СкопироватьФайл(URL, IDФайла, IDКаталога); + + + IDКаталога = "2490"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Make-folder-copy.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md new file mode 100644 index 0000000000..fb3f04ee90 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 10 +--- + +# Скопировать каталог + Копирует один каталог в другой + + + + +
+ + +*Функция СкопироватьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDПриемника = "2492"; + IDКаталога = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СкопироватьКаталог(URL, IDКаталога, IDПриемника); + + + IDПриемника = "2494"; + IDКаталога = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Mark-file-as-deleted.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md new file mode 100644 index 0000000000..d531430d35 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 22 +--- + +# Поместить файл в корзину + Перемещает файл в корзину удаляемых файлов + + + + +
+ + +*Функция ПоместитьФайлВКорзину(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ПоместитьФайлВКорзину(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Mark-folder-as-deleted.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md new file mode 100644 index 0000000000..572d5f9673 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 16 +--- + +# Поместить каталог в корзину + Перемещает каталог в корзину удаляемых файлов + + + + +
+ + +*Функция ПоместитьКаталогВКорзину(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ПоместитьКаталогВКорзину(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Move-file-to-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md new file mode 100644 index 0000000000..fd9a5a476f --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 25 +--- + +# Переместить файл + Перемещает файл из одного расположения в другое + + + + +
+ + +*Функция ПереместитьФайлВКаталог(Знач URL, Знач IDФайла, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | ID файла для перемещения | + | IDКаталога | --folderid | Строка, Число | ID каталога нового размещения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDКаталога = "2492"; + IDФайла = "2484"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереместитьФайлВКаталог(URL, IDФайла, IDКаталога); + + + IDКаталога = "2494"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Move-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md new file mode 100644 index 0000000000..2ed93f54c5 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md @@ -0,0 +1,84 @@ +--- +sidebar_position: 11 +--- + +# Переместить каталог + Перемещает один каталог внутрь другого + + + + +
+ + +*Функция ПереместитьКаталог(Знач URL, Знач IDКаталога, Знач IDПриемника, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | IDПриемника | --tagetid | Строка, Число | ID каталога назначения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + IDПриемника = "2488"; + IDКаталога = "2494"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереместитьКаталог(URL, IDКаталога, IDПриемника); + + + IDКаталога = "2492"; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Rename-file.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md new file mode 100644 index 0000000000..ec7addbfdc --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 26 +--- + +# Переименовать файл + Изменяет имя существующего файла + + + + +
+ + +*Функция ПереименоватьФайл(Знач URL, Знач IDФайла, Знач Наименование, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + Наименование = "Новое имя файла.jpg"; + Наименование2 = "Новое имя файла 2.jpg"; + + IDФайла2 = "2482"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереименоватьФайл(URL, IDФайла2, Наименование2); + + + IDФайла = "2484"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Rename-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md new file mode 100644 index 0000000000..5cc311a121 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 18 +--- + +# Переименовать каталог + Изменяет имя каталога + + + + +
+ + +*Функция ПереименоватьКаталог(Знач URL, Знач IDКаталога, Знач Наименование, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Наименование | --title | Строка | Новое наименование каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + IDКаталога2 = "2488"; + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ПереименоватьКаталог(URL, IDКаталога2, Наименование2); + + + IDКаталога = "2490"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Rename-storage.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md index bc59736e49..1471aeeb58 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md @@ -6,6 +6,11 @@ sidebar_position: 4 Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) + + +
+ + *Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,16 +23,17 @@ sidebar_position: 4 Возвращаемое значение: HTTPОтвет - Переименовать хранилище + ```bsl title="Пример кода" - Наименование = "Новое имя хранилища"; URL = "b24-ar17wx.bitrix24.by"; Токен = "b9df7366006e9f06006b12e400000001000..."; IDХранилища = "18"; Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "result": { "ID": "18", "NAME": "Новое имя хранилища", @@ -59,5 +63,4 @@ sidebar_position: 4 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md new file mode 100644 index 0000000000..85df174a13 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 23 +--- + +# Восстановить файл + Восстанавливает файл из корзины + + + + +
+ + +*Функция ВосстановитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "2484"; + + Результат = OPI_Bitrix24.ВосстановитьФайл(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Restore-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md new file mode 100644 index 0000000000..0a95e9551c --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md @@ -0,0 +1,77 @@ +--- +sidebar_position: 17 +--- + +# Восстановить каталог + Восстанавливает каталог из корзины + + + + +
+ + +*Функция ВосстановитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "2490"; + + Результат = OPI_Bitrix24.ВосстановитьКаталог(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Upload-file-to-folder.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md new file mode 100644 index 0000000000..7a4845d20e --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 19 +--- + +# Загрузить файл в каталог + Загружает переданный файл в каталог + + + + +
+ + +*Функция ЗагрузитьФайлВКаталог(Знач URL, Знач Наименование, Знач Файл, Знач IDКаталога, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDКаталога | --folderid | Строка | Идентификатор каталога для загрузки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```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Приемника = "2490"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, Наименование2, Картинка2, IDПриемника); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Storages-and-files-managment/Upload-file-to-storage.md b/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md index 9bed02a606..0543b39985 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md @@ -6,6 +6,11 @@ sidebar_position: 6 Загружает файл в выбранное хранилище + + +
+ + *Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - Наименование2 = "Картинка2.jpg"; Наименование = "Картинка1.jpg"; @@ -40,8 +45,9 @@ sidebar_position: 6 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); - ``` + + ```sh title="Пример команды CLI" @@ -49,10 +55,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "result": { "ID": 356, "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", @@ -84,5 +88,4 @@ sidebar_position: 6 "operating": 0.227726936340332 } } - ``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json b/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json index bdf3425c32..e16be17d7e 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с диском и файлами", -"position": "5" +"position": "7" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md b/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md index 16b46e57fb..9deed59698 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Add-task-to-favorites.md @@ -6,6 +6,11 @@ sidebar_position: 17 Добавляет задачу в список избранного + + +
+ + *Функция ДобавитьЗадачуВИзбранное(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 17 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 17 IDЗадачи = "170"; Результат = OPI_Bitrix24.ДобавитьЗадачуВИзбранное(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 17 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1718569733.98858, @@ -55,5 +59,4 @@ sidebar_position: 17 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md index 6004abecf9..d599a23933 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md @@ -6,6 +6,11 @@ sidebar_position: 7 Принимает задачу по ID + + +
+ + *Функция ПринятьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 7 IDЗадачи = "170"; Результат = OPI_Bitrix24.ПринятьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -213,5 +217,4 @@ sidebar_position: 7 "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 new file mode 100644 index 0000000000..f41a88c948 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 6 +--- + +# Добавить файл в задачу + Прикрепляет файл к выбранной задаче + + + + +
+ + +*Функция ДобавитьФайлВЗадачу(Знач URL, Знач IDЗадачи, Знач IDФайла, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDФайла | --fileid | Число, Строка | ID Файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + IDФайла = "2480"; + + Результат = OPI_Bitrix24.ДобавитьФайлВЗадачу(URL, IDЗадачи, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = 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 new file mode 100644 index 0000000000..0023ec0323 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -0,0 +1,126 @@ +--- +sidebar_position: 20 +--- + +# Проверить доступ к задаче + Проверяет доступность задачи для пользователей + + + + +
+ + +*Функция ПроверитьДоступКЗадаче(Знач URL, Знач IDЗадачи, Знач Пользователи = "", Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Пользователи | --users | Массив из Строка | ID пользователей для проверки доступа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + МассивПользователей = Новый Массив; + МассивПользователей.Добавить("1"); + МассивПользователей.Добавить("10"); + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ПроверитьДоступКЗадаче(URL, IDЗадачи, МассивПользователей); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = 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/Complete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md index c757f36072..df2399d72c 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md @@ -6,6 +6,11 @@ sidebar_position: 9 Завершает задачу по ID + + +
+ + *Функция ЗавершитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 9 IDЗадачи = "170"; Результат = OPI_Bitrix24.ЗавершитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 9 "operating": 0.312941789627075 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md index 3f3fb41f54..bca74c066d 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md @@ -1,24 +1,29 @@ --- -sidebar_position: 4 +sidebar_position: 3 --- # Создать задачу Создает новую задачу по структуре полей (см. ПолучитьСтруктуруЗадачи) + + +
+ + *Функция СоздатьЗадачу(Знач URL, Знач СтруктураПолей, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | |-|-|-|-| | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи | + | СтруктураПолей | --fields | Структура Из КлючИЗначение | Структура полей задачи (см. ПолучитьСтруктуруЗадачи) | | Токен | --token | Строка | Токен авторизации, если используется не вебхук | Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); @@ -43,8 +48,9 @@ sidebar_position: 4 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.СоздатьЗадачу(URL, СтруктураЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -52,10 +58,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -198,5 +202,4 @@ sidebar_position: 4 "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 new file mode 100644 index 0000000000..9a6c3fae81 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -0,0 +1,70 @@ +--- +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 + + +```bsl title="Пример кода" + IDИсточника = "500"; + IDПриемника = "502"; + ТипСвязи = 0; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СоздатьЗависимостьЗадач(URL, IDИсточника, IDПриемника, ТипСвязи); + + + IDИсточника = "502"; + IDПриемника = "500"; + ТипСвязи = 2; + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + + Результат = 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/Defer-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md index af946d0e7c..4b3749ade0 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md @@ -6,6 +6,11 @@ sidebar_position: 11 Откладывает задачу по ID + + +
+ + *Функция ОтложитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 11 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 11 IDЗадачи = "170"; Результат = OPI_Bitrix24.ОтложитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 11 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 11 "operating": 0.131969928741455 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md index e957e94c4d..cb319511ad 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md @@ -6,6 +6,11 @@ sidebar_position: 16 Делегирует задачу на другого пользователя + + +
+ + *Функция ДелегироватьЗадачу(Знач URL, Знач IDЗадачи, Знач IDПользователя, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 16 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; IDПользователя = "10"; @@ -32,8 +37,9 @@ sidebar_position: 16 IDЗадачи = "170"; Результат = OPI_Bitrix24.ДелегироватьЗадачу(URL, IDЗадачи, IDПользователя, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 16 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "154", @@ -197,5 +201,4 @@ sidebar_position: 16 "operating": 0.450687170028686 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md index 9509c54024..baf110ec18 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 6 +sidebar_position: 5 --- # Удалить задачу Удаляет задачу по ID + + +
+ + *Функция УдалитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 6 IDЗадачи = "170"; Результат = OPI_Bitrix24.УдалитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "result": { "task": true }, @@ -57,5 +61,4 @@ sidebar_position: 6 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md new file mode 100644 index 0000000000..fddfccb8f3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -0,0 +1,37 @@ +--- +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 + + + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьЗависимостьЗадач --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token% + +``` + + diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md index 969037984a..6c975fb29d 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md @@ -6,6 +6,11 @@ sidebar_position: 8 Отклоняет задачу по ID + + +
+ + *Функция ОтклонитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 8 IDЗадачи = "170"; Результат = OPI_Bitrix24.ОтклонитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,12 +45,9 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "error": 1048582, "error_description": "Действие над задачей не разрешено" } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md index 645dde9b81..3b41ce7150 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md @@ -1,11 +1,16 @@ --- -sidebar_position: 1 +sidebar_position: 25 --- # Получить структуру задачи Получает структуру с описанем полей для создания задачи + + +
+ + *Функция ПолучитьСтруктуруЗадачи(Знач URL, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL); @@ -27,8 +32,9 @@ sidebar_position: 1 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьСтруктуруЗадачи(URL, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "result": { "fields": { "ID": { @@ -420,5 +424,4 @@ sidebar_position: 1 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md index fb94ff696f..7cc0710ed8 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md @@ -6,6 +6,11 @@ sidebar_position: 19 Получает историю изменений задачи + + +
+ + *Функция ПолучитьИсториюЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 19 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 19 IDЗадачи = "170"; Результат = OPI_Bitrix24.ПолучитьИсториюЗадачи(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 19 ``` - ```json title="Результат" - -{ + { "result": { "list": [ { @@ -298,5 +302,4 @@ sidebar_position: 19 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md index 315d8be365..393806875d 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 2 +sidebar_position: 1 --- # Получить задачу Получает задачу по ID + + +
+ + *Функция ПолучитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 2 IDЗадачи = "170"; Результат = OPI_Bitrix24.ПолучитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 2 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md index ae5660c288..f80cf60b5e 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-filter-structure.md @@ -1,11 +1,16 @@ --- -sidebar_position: 21 +sidebar_position: 26 --- # Получить структуру фильтра задач Возвращает структуру полей для фильтрации задач в методе ПолучитьСписокЗадач + + +
+ + *Функция ПолучитьСтруктуруФильтраЗадач(Знач Пустая = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,11 +20,9 @@ sidebar_position: 21 Возвращаемое значение: Структура Из КлючИЗначение - Структура полей -```bsl title="Пример кода" - -``` + ```sh title="Пример команды CLI" @@ -28,8 +31,3 @@ sidebar_position: 21 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md index 2c4fc70176..9bf2bae8df 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md @@ -1,11 +1,16 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- # Получить список задач Получает список задач (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЗадач) + + +
+ + *Функция ПолучитьСписокЗадач(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - // Полную структуру фильтра можно найти в функции ПолучитьСтруктуруФильтраЗадач Фильтр = Новый Структура; Фильтр.Вставить("CREATED_BY" , 1); @@ -35,8 +40,9 @@ sidebar_position: 3 Токен = "b9df7366006e9f06006b12e400000001000..."; Результат = OPI_Bitrix24.ПолучитьСписокЗадач(URL, , Отступ, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -44,10 +50,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "result": { "tasks": [ { @@ -4015,5 +4019,4 @@ sidebar_position: 3 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md new file mode 100644 index 0000000000..12cc6f7cbd --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 21 +--- + +# Отключить звук задачи + Устанавливает режим Без звука для задачи + + + + +
+ + +*Функция ОтключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ОтключитьЗвукЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = 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/Pause-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md index 9747b8ba6c..15cfaceed9 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md @@ -6,6 +6,11 @@ sidebar_position: 12 Приостанавливает задачу по ID + + +
+ + *Функция ПриостановитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 12 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 12 IDЗадачи = "170"; Результат = OPI_Bitrix24.ПриостановитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 12 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 12 "operating": 0.149271011352539 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md b/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md index e6a09b4513..9a65a03452 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Remove-task-from-favorites.md @@ -6,6 +6,11 @@ sidebar_position: 18 Удаляет задачу из списка избранного + + +
+ + *Функция УбратьЗадачуИзИзбранного(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 18 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 18 IDЗадачи = "170"; Результат = OPI_Bitrix24.УбратьЗадачуИзИзбранного(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 18 ``` - ```json title="Результат" - -{ + { "result": true, "time": { "start": 1718569735.08926, @@ -55,5 +59,4 @@ sidebar_position: 18 "operating": 0 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md index 44a05d9ca6..81687828b4 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md @@ -6,6 +6,11 @@ sidebar_position: 10 Возвращает в работу задачу по ID + + +
+ + *Функция ВозобновитьЗадачу(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 10 IDЗадачи = "170"; Результат = OPI_Bitrix24.ВозобновитьЗадачу(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 10 "operating": 0.26146388053894 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md index ad1fb2f9f5..06fc146a03 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md @@ -6,6 +6,11 @@ sidebar_position: 13 Начинает выполнение задачи по ID + + +
+ + *Функция НачатьВыполнениеЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 13 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 13 IDЗадачи = "170"; Результат = OPI_Bitrix24.НачатьВыполнениеЗадачи(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 13 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 13 "operating": 0.14000415802002 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md index 7ce942bc57..7fbd619597 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md @@ -6,6 +6,11 @@ sidebar_position: 14 Начинает наблюдение за задачей по ID + + +
+ + *Функция НачатьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 14 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 14 IDЗадачи = "170"; Результат = OPI_Bitrix24.НачатьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 14 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -195,5 +199,4 @@ sidebar_position: 14 "operating": 0.279598951339722 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md index 36d38e5198..83024cda29 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md @@ -6,6 +6,11 @@ sidebar_position: 15 Прекращает наблюдение за задчей по ID + + +
+ + *Функция ПрекратитьНаблюдатьЗаЗадачей(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 15 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; IDЗадачи = "168"; @@ -30,8 +35,9 @@ sidebar_position: 15 IDЗадачи = "170"; Результат = OPI_Bitrix24.ПрекратитьНаблюдатьЗаЗадачей(URL, IDЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 15 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -185,5 +189,4 @@ sidebar_position: 15 "operating": 0.175670862197876 } } - ``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md new file mode 100644 index 0000000000..7adbe9e43b --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 22 +--- + +# Включить звук задачи + Отключает режим Без звука для задачи + + + + +
+ + +*Функция ВключитьЗвукЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт* + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число,Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDЗадачи = "500"; + + Результат = OPI_Bitrix24.ВключитьЗвукЗадачи(URL, IDЗадачи); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "56898d66006e9f06006b12e400000001000..."; + IDЗадачи = "502"; + + Результат = 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/Tasks-managment/Update-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md index 97478518d0..ad93110034 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md @@ -1,11 +1,16 @@ --- -sidebar_position: 5 +sidebar_position: 4 --- # Изменить задачу Изменяет существующую задачу + + +
+ + *Функция ИзменитьЗадачу(Знач URL, Знач IDЗадачи, Знач СтруктураПолей, Знач Токен = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + ```bsl title="Пример кода" - // Полную структуру полей можно получить функцией ПолучитьСтруктуруЗадачи() СтруктураЗадачи = Новый Структура; @@ -38,8 +43,9 @@ sidebar_position: 5 IDЗадачи = "170"; Результат = OPI_Bitrix24.ИзменитьЗадачу(URL, IDЗадачи, СтруктураЗадачи, Токен); - ``` + + ```sh title="Пример команды CLI" @@ -47,10 +53,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "result": { "task": { "id": "110", @@ -193,5 +197,4 @@ sidebar_position: 5 "operating": 0.202054023742676 } } - ``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md index 72f7d3d7e7..84417fefa2 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-account-information.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает информацию об аккаунте + + +
+ + *Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,13 +21,14 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", "name": { "given_name": "Антон", @@ -58,5 +62,4 @@ sidebar_position: 4 "home_namespace_id": "3179550035" } } - ``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md index f592392209..32141e112d 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-authorization-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Генерирует ссылку авторизации для перехода в браузере + + +
+ + *Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,12 +20,13 @@ sidebar_position: 1 Возвращаемое значение: Строка - URL для перехода в браузере + ```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения); - ``` + + ```sh title="Пример команды CLI" @@ -28,9 +34,6 @@ sidebar_position: 1 ``` - ```json title="Результат" - -"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" - + "https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" ``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md index e80e573e95..a67255fc8b 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-space-usage-data.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает информацию о количестве использованного дискового пространства + + +
+ + *Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,13 +20,14 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -29,15 +35,12 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "used": 1477493597, "allocation": { ".tag": "individual", "allocated": 2147483648 } } - ``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md index dcf94ac01d..be93c1063e 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации + + +
+ + *Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; СекретПриложения = "tk2oewn..."; Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "error": "invalid_grant", "error_description": "code doesn't exist or has expired" } - ``` diff --git a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md index 80ece7f676..bb437c76b2 100644 --- a/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md +++ b/docs/ru/md/Dropbox/Account-and-authorization/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает новый токен на основе рефреш токена + + +
+ + *Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - КлючПриложения = "oynqxds..."; СекретПриложения = "tk2oewn..."; РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен); - ``` + + ```sh title="Пример команды CLI" @@ -33,13 +39,10 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", "token_type": "bearer", "expires_in": 14400 } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md index a925b17b32..44c93974cb 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Copy-object.md @@ -6,6 +6,11 @@ sidebar_position: 8 Копирует файл или каталог по выбранному пути + + +
+ + *Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Оригинал = "/New/pic.png"; Копия = "/New/pic_copy.png"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия); - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "metadata": { ".tag": "file", "name": "pic_copy.png", @@ -51,5 +55,4 @@ sidebar_position: 8 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md index 9d37a0d078..2fe7363d83 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 10 Создает пустой каталог по выбранному пути + + +
+ + *Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/Новый каталог"; Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "metadata": { "name": "Новый каталог", "path_lower": "/новый каталог", @@ -42,5 +46,4 @@ sidebar_position: 10 "id": "id:kJU6-a-pT48AAAAAAAABZA" } } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md index a13b13bfc3..b901974201 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 7 Удаляет объект с облачного диска + + +
+ + *Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Путь = "/New/pic.png"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "metadata": { ".tag": "file", "name": "pic.png", @@ -50,5 +54,4 @@ sidebar_position: 7 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md index 6e3467957d..0db21a9608 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 11 Скачивает файл по указанному пути или ID + + +
+ + *Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 11 Возвращаемое значение: ДвоичныеДанные - двоичные данные файла + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/pic.png"; Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 11 ``` - ```json title="Результат" - -НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… - + НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md index d258fc6865..2126f27a9b 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Download-folder.md @@ -6,6 +6,11 @@ sidebar_position: 12 Скачивает zip архив с содержимым указанного каталога + + +
+ + *Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 12 Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New"; Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 12 ``` - ```json title="Результат" - -НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… - + НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md index 0aea964673..9057aa1f91 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список первых файлов каталога или продолжает получение следующих при указании курсора + + +
+ + *Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,14 +23,15 @@ sidebar_position: 2 Возвращаемое значение: HTTPОтвет - Получить список файлов папки + ```bsl title="Пример кода" - Путь = "/New"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина); - ``` + + ```sh title="Пример команды CLI" @@ -33,9 +39,7 @@ sidebar_position: 2 ``` - ```json title="Результат" - { "entries": [ { @@ -68,5 +72,4 @@ sidebar_position: 2 "cursor": "AAEXfuMhG6Xl2ENYH4uAoLS_nOUV4SC7ChaMxK4ZIphj9x5INumYZrHv6jqph4fgkOy6PpFTTaaJ4BTjzVGZnTk7tB5wCCp1Eogn8gCW-Agz-ej4X6ir5p-KX63vBgDV0OZ-boy78oUXMJeOtU9sjEij34BoqBCtWYOFje4PXhEV3KwVySRWzPlXSEq9arMo1AaP8PFuDxx6JTxSGRdcQwnc", "has_more": false } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md index 8aa69d794f..9831098dd5 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает информацию о файле или каталоге + + +
+ + *Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Путь = "/New/pic.png"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина); - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { ".tag": "file", "name": "pic.png", "path_lower": "/new/pic.png", @@ -48,5 +52,4 @@ sidebar_position: 1 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md index a86d82ed21..75d7cbf538 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-object-version-list.md @@ -6,6 +6,11 @@ sidebar_position: 13 Получает список версий (ревизий) объекта + + +
+ + *Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 13 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/pic.png"; Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1); - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 13 ``` - ```json title="Результат" - -{ + { "is_deleted": false, "entries": [ { @@ -52,5 +56,4 @@ sidebar_position: 13 } ] } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md index a7409a74af..8bf0372429 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-preview.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает PDF или HTML превью объекта (только для токументов) + + +
+ + *Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 3 Возвращаемое значение: ДвоичныеДанные - превью документа + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/mydoc.docx"; Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 3 ``` - ```json title="Результат" - -НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… - + НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md b/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md index 4d5cbdc122..54e00400e9 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает статус загрузки файла по URL + + +
+ + *Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; ИДРаботы = "G8YbueOu2nsAAAAAAAAAAQ"; Статус = "in_progress"; @@ -31,8 +36,9 @@ sidebar_position: 6 КонецЦикла; - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { ".tag": "complete", "name": "url_doc.docx", "path_lower": "/new/url_doc.docx", @@ -56,5 +60,4 @@ sidebar_position: 6 "is_downloadable": true, "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md index 0886f78387..c956b996d7 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Move-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Перемещает объект по выбранному пути + + +
+ + *Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - ОригиналныйПуть = "/New/pic.png"; ЦелевойПуть = "/pic.png"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть); - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "metadata": { ".tag": "file", "name": "pic.png", @@ -51,5 +55,4 @@ sidebar_position: 9 "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md b/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md index f29453d4d5..cd656da1cc 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Restore-object-to-version.md @@ -6,6 +6,11 @@ sidebar_position: 14 Восстанавливает состояние объекта к необходимой версии (ревизии) + + +
+ + *Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 14 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Версия = "61a0b76320a6fbd841553"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/pic.png"; Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия); - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 14 ``` - ```json title="Результат" - -{ + { "name": "pic.png", "path_lower": "/new/pic.png", "path_display": "/New/pic.png", @@ -48,5 +52,4 @@ sidebar_position: 14 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md index dc16954a1f..e51b783d97 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 5 Загружает файл на облачный диск, получая его по указанному URL + + +
+ + *Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Путь = "/New/url_doc.docx"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; URL = "https://openintegrations.dev/test_data/document.docx"; Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { ".tag": "async_job_id", "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" } - ``` diff --git a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md index 9c33392003..ac92700f4d 100644 --- a/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md +++ b/docs/ru/md/Dropbox/File-and-directory-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Загружает файл на облачный диск + + +
+ + *Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Путь = "/New/pic.png"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Картинка = "https://openintegrations.dev/test_data/picture.jpg"; @@ -28,8 +33,9 @@ sidebar_position: 4 КопироватьФайл(Картинка, КартинкаПуть); Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина); - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "name": "pic.png", "path_lower": "/new/pic.png", "path_display": "/New/pic.png", @@ -52,5 +56,4 @@ sidebar_position: 4 "is_downloadable": true, "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" } - ``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md index b9ffbce09c..aac63bad65 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Определяет доступ к файлу для стороннего пользователя + + +
+ + *Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,15 +23,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Почта = "h5bk6ft62s@privaterelay.appleid.com"; Файл = "kJU6-a-pT48AAAAAAAAABw"; Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -[ + [ { "member": { ".tag": "email", @@ -55,5 +59,4 @@ sidebar_position: 3 ] } ] - ``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md index 5433292d07..88ce55d4e1 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Add-users-to-folder.md @@ -6,6 +6,11 @@ sidebar_position: 4 Предоставляет стороннии пользователям доступ к каталогу + + +
+ + *Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,15 +23,16 @@ sidebar_position: 4 Возвращаемое значение: Неопределено - пустой ответ + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Почта = "h5bk6ft62s@privaterelay.appleid.com"; Папка = "5022319569"; // shared_folder_id Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь); - ``` + + ```sh title="Пример команды CLI" @@ -34,9 +40,6 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{} - + {} ``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md index ec93684c1a..92602be82e 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-file-publication.md @@ -6,6 +6,11 @@ sidebar_position: 6 Запрещает доступ к файлу для внешних пользователей + + +
+ + *Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Файл = "kJU6-a-pT48AAAAAAAAABw"; Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{} - + {} ``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md index c38dce5992..fec227d50b 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md @@ -6,6 +6,11 @@ sidebar_position: 2 Отменяет режим общего доступа для каталога + + +
+ + *Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Папка = "5022319569"; @@ -30,8 +35,9 @@ sidebar_position: 2 ТекущийСтатус = Результат[".tag"]; OPI_Инструменты.Пауза(3); КонецЦикла; - ``` + + ```sh title="Пример команды CLI" @@ -39,11 +45,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { ".tag": "complete" } - ``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md b/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md index ea2ee020f9..92470359b4 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает статус асинхронной работы по изменению доступов + + +
+ + *Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,11 +21,9 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox -```bsl title="Пример кода" - -``` + ```sh title="Пример команды CLI" @@ -29,8 +32,3 @@ sidebar_position: 5 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md index b61ed72293..53bfcbcc67 100644 --- a/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md +++ b/docs/ru/md/Dropbox/Shared-access-settings/Publish-folder.md @@ -6,6 +6,11 @@ sidebar_position: 1 Переводит каталог в режим публичного доступа + + +
+ + *Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New"; Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { ".tag": "complete", "access_type": { ".tag": "owner" @@ -63,5 +67,4 @@ sidebar_position: 1 }, "folder_id": "id:kJU6-a-pT48AAAAAAAABXw" } - ``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Add-tag.md b/docs/ru/md/Dropbox/Tags-managment/Add-tag.md index 53bb640b99..31666958df 100644 --- a/docs/ru/md/Dropbox/Tags-managment/Add-tag.md +++ b/docs/ru/md/Dropbox/Tags-managment/Add-tag.md @@ -6,6 +6,11 @@ sidebar_position: 2 Добавляет новый текстовый тег к файлу или каталогу + + +
+ + *Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Тег = "Важное"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/mydoc.docx"; Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег); - ``` + + ```sh title="Пример команды CLI" @@ -33,9 +39,6 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{} - + {} ``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md b/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md index e0c7f4dc84..a8acc41b8d 100644 --- a/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md +++ b/docs/ru/md/Dropbox/Tags-managment/Delete-tag.md @@ -6,6 +6,11 @@ sidebar_position: 3 Удаляет текстовый тег файла или каталога + + +
+ + *Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Тег = "Важное"; Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Путь = "/New/mydoc.docx"; Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег); - ``` + + ```sh title="Пример команды CLI" @@ -33,9 +39,6 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{} - + {} ``` diff --git a/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md b/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md index 1a2aafbb03..d84a095a62 100644 --- a/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md +++ b/docs/ru/md/Dropbox/Tags-managment/Get-tag-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список тегов выбранных файлов + + +
+ + *Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox + ```bsl title="Пример кода" - Токен = "sl.B22821SXrkmxs9KAaC6M_ax_M33mEcEvKz9sqgcMO8Xwn0bvpx4_57UQqLR_gEuPS_Yk5yd3Tv..."; МассивПутей = Новый Массив; @@ -25,8 +30,9 @@ sidebar_position: 1 МассивПутей.Добавить("/New/mydoc.docx"); Результат = OPI_Dropbox.ПолучитьСписокТегов(Токен, МассивПутей); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "paths_to_tags": [ { "path": "/New/Dogs.mp3", @@ -54,5 +58,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md index 17bca2ba56..3b5ea13427 100644 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Добавляет существующий календарь в список пользователя + + +
+ + *Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ДобавитьКалендарьВСписок(Токен, "55868c32be16935f0..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -53,5 +57,4 @@ sidebar_position: 2 "etag": "\"1708423365033000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md index ce0b9024f2..5a2684c9dd 100644 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет календарь из списка пользователя + + +
+ + *Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.УдалитьКалендарьИзСписка(Токен, "55868c32be16935f0..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 4 ``` - ```json title="Результат" - -"" - + "" ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md index e5a08ff1e7..7440b15f10 100644 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 5 Изменяет свойства календаря из списка пользователей + + +
+ + *Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Черный = "#000000"; @@ -29,8 +34,9 @@ sidebar_position: 5 Ответ = OPI_GoogleCalendar.ИзменитьКалендарьСписка(Токен, "55868c32be16935f0...", Черный, Желтый, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -59,5 +63,4 @@ sidebar_position: 5 "etag": "\"1708424005038000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md index e3c57d95ad..c5c223ee38 100644 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает массив календарей аккаунта + + +
+ + *Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий данных календарей + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПолучитьСписокКалендарей(Токен); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -[ + [ { "conferenceProperties": { "allowedConferenceSolutionTypes": [ @@ -169,5 +173,4 @@ sidebar_position: 1 "kind": "calendar#calendarListEntry" } ] - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md index f59a4ca0e9..a4324d591a 100644 --- a/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает календарь из списка пользователя по ID + + +
+ + *Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПолучитьКалендарьСписка(Токен, "55868c32be16935f0..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -52,5 +56,4 @@ sidebar_position: 3 "etag": "\"1708423563386000\"", "kind": "calendar#calendarListEntry" } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md index fc9782a101..4ddeacd558 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 4 Очищает список событий основного календаря + + +
+ + *Функция ОчиститьОсновнойКалендарь(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,13 +20,14 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ОчиститьОсновнойКалендарь(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -29,9 +35,6 @@ sidebar_position: 4 ``` - ```json title="Результат" - -"" - + "" ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md index 3dc47c0c57..9b80bd4696 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает пустой календарь + + +
+ + *Функция СоздатьКалендарь(Знач Токен, Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.СоздатьКалендарь(Токен, "Тестовый календарь"); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -46,5 +50,4 @@ sidebar_position: 1 "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md index 51cd160598..1bdf77e964 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md @@ -6,6 +6,11 @@ sidebar_position: 5 Удаляет календарь по ID + + +
+ + *Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.УдалитьКалендарь(Токен, "55868c32be16935f0..."); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 5 ``` - ```json title="Результат" - -"" - + "" ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md index f00f82f249..88b2259e1b 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет свойства существуещего календаря + + +
+ + *Функция ИзменитьМетаданныеКалендаря(Знач Токен, Знач Календарь, Знач Наименование = "", Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,16 +23,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Наименование = "Тестовый календарь (изм.)"; Описание = "Тестовое описание"; Ответ = OPI_GoogleCalendar.ИзменитьМетаданныеКалендаря(Токен, "55868c32be16935f0...", Наименование, Описание); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -51,5 +55,4 @@ sidebar_position: 3 "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md index 97ef7e43e0..26a6ca5714 100644 --- a/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md +++ b/docs/ru/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает информацию о календаре по ID + + +
+ + *Функция ПолучитьМетаданныеКалендаря(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПолучитьМетаданныеКалендаря(Токен, "55868c32be16935f0..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "conferenceProperties": { "allowedConferenceSolutionTypes": [ "hangoutsMeet" @@ -47,5 +51,4 @@ sidebar_position: 2 "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", "kind": "calendar#calendar" } - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Create-event.md b/docs/ru/md/Google_Calendar/Event-management/Create-event.md index 294e1aa883..ae9cd317fc 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Create-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Create-event.md @@ -6,6 +6,11 @@ sidebar_position: 4 Создает новое событие + + +
+ + *Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - ответ сервера Google + ```bsl title="Пример кода" - Вложения = Новый Соответствие; Вложения.Вставить("Картинка1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); @@ -36,8 +41,9 @@ sidebar_position: 4 Ответ = OPI_GoogleCalendar.СоздатьСобытие(Токен, Календарь, СоответствиеСобытия); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "eventType": "default", "attachments": [ { @@ -94,5 +98,4 @@ sidebar_position: 4 "etag": "\"3417013976948000\"", "kind": "calendar#event" } - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md b/docs/ru/md/Google_Calendar/Event-management/Delete-event.md index f7729532df..0e51a9245b 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Delete-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Delete-event.md @@ -6,6 +6,11 @@ sidebar_position: 7 Удаляет событие по ID + + +
+ + *Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.УдалитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -32,9 +38,6 @@ sidebar_position: 7 ``` - ```json title="Результат" - -"" - + "" ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md b/docs/ru/md/Google_Calendar/Event-management/Edit-event.md index 8c3a8477ce..dc70755801 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Edit-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Edit-event.md @@ -6,6 +6,11 @@ sidebar_position: 6 Изменяет существующее событие + + +
+ + *Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - СоответствиеСобытия = Новый Соответствие; СоответствиеСобытия.Вставить("Описание", "Описание тестового события (изм.)"); @@ -27,8 +32,9 @@ sidebar_position: 6 Ответ = OPI_GoogleCalendar.ИзменитьСобытие(Токен, "55868c32be16935f0...", СоответствиеСобытия, "j4nonfcc0m2..."); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "eventType": "default", "attachments": [ { @@ -85,5 +89,4 @@ sidebar_position: 6 "etag": "\"3417542724802000\"", "kind": "calendar#event" } - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md index 70557beae2..cb35438a3c 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-description.md @@ -6,6 +6,11 @@ sidebar_position: 1 + + +
+ + *Функция ПолучитьОписаниеСобытия() Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -14,11 +19,9 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - Пустой макет события -```bsl title="Пример кода" - -``` + ```sh title="Пример команды CLI" @@ -26,10 +29,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -СоответствиеСобытия = Новый Соответствие; + СоответствиеСобытия = Новый Соответствие; СоответствиеСобытия.Вставить("Описание" , ""); // Описание события СоответствиеСобытия.Вставить("Заголовок" , "Новое событие"); // Заголовок события СоответствиеСобытия.Вставить("МестоПроведения" , ""); // Строка описание места проведения @@ -37,5 +38,4 @@ sidebar_position: 1 СоответствиеСобытия.Вставить("ДатаОкончания" , СоответствиеСобытия["ДатаНачала"] + 3600); // Дата окончания события СоответствиеСобытия.Вставить("МассивURLФайловВложений" , Новый Соответствие); // Ключ - название, Значение - URL к файлу СоответствиеСобытия.Вставить("ОтправлятьУведомления" , Истина); // Признак отправки уведомлений участникам - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md index 6b5c7d0eec..e2d62c0caf 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список всех событий календаря + + +
+ + *Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий событий + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПолучитьСписокСобытий(Токен, "55868c32be16935f0..."); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -[ + [ { "eventType": "default", "attachments": [ @@ -82,5 +86,4 @@ sidebar_position: 2 "kind": "calendar#event" }, ] - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Get-event.md b/docs/ru/md/Google_Calendar/Event-management/Get-event.md index 4737c2a618..b28d7bb494 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Get-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Get-event.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает событие по ID + + +
+ + *Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПолучитьСобытие(Токен, "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "eventType": "default", "attachments": [ { @@ -81,5 +85,4 @@ sidebar_position: 3 "etag": "\"3417013976948000\"", "kind": "calendar#event" } - ``` diff --git a/docs/ru/md/Google_Calendar/Event-management/Move-event.md b/docs/ru/md/Google_Calendar/Event-management/Move-event.md index 945e3502e8..abbca01d2c 100644 --- a/docs/ru/md/Google_Calendar/Event-management/Move-event.md +++ b/docs/ru/md/Google_Calendar/Event-management/Move-event.md @@ -6,6 +6,11 @@ sidebar_position: 5 Перемещает событие в другой календарь + + +
+ + *Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,14 +23,15 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Ответ = OPI_GoogleCalendar.ПереместитьСобытие(Токен, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "eventType": "default", "attachments": [ { @@ -82,5 +86,4 @@ sidebar_position: 5 "etag": "\"3417540102468000\"", "kind": "calendar#event" } - ``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md b/docs/ru/md/Google_Drive/Comment-management/Create-comment.md index 7985d7c7c9..5a5bcb7846 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Create-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Create-comment.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает комментарий к файлу или каталогу + + +
+ + *Функция СоздатьКомментарий(Знач Токен, Знач Идентификатор, Знач Комментарий) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Идентификатор = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; Комментарий = "Новый комментарий"; @@ -26,8 +31,9 @@ sidebar_position: 1 Ответ = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "content": "Новый комментарий", "htmlContent": "Новый комментарий", "author": { @@ -54,5 +58,4 @@ sidebar_position: 1 "deleted": false, "id": "AAABI3NNNAY" } - ``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md index 8f6785a98f..bc40556075 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Delete-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет комментарий по ID + + +
+ + *Функция УдалитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Ответ = OPI_GoogleDrive.УдалитьКомментарий(Токен, Идентификатор, Комментарий); //Соответствие - ``` + + ```sh title="Пример команды CLI" @@ -33,9 +39,6 @@ sidebar_position: 4 ``` - ```json title="Результат" - -'' - + '' ``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md index 01e4d32770..9c5094b2c7 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает список всех комментариев объекта + + +
+ + *Функция ПолучитьСписокКомментариев(Знач Токен, Знач ИДОбъекта) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; Ответ = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, ИДФайла); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "comments": [ { "content": "Новый комментарий", @@ -57,5 +61,4 @@ sidebar_position: 3 ], "kind": "drive#commentList" } - ``` diff --git a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md b/docs/ru/md/Google_Drive/Comment-management/Get-comment.md index a2b6f0ae50..ecf2890f72 100644 --- a/docs/ru/md/Google_Drive/Comment-management/Get-comment.md +++ b/docs/ru/md/Google_Drive/Comment-management/Get-comment.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает комментарий по ID + + +
+ + *Функция ПолучитьКомментарий(Знач Токен, Знач ИДОбъекта, Знач ИДКомментария) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; ИДКомментария = AAABI3NNNAY; @@ -26,8 +31,9 @@ sidebar_position: 2 Ответ = OPI_GoogleDrive.ПолучитьКомментарий(Токен, ИДФайла, ИДКомментария); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "content": "Новый комментарий", "htmlContent": "Новый комментарий", "author": { @@ -54,5 +58,4 @@ sidebar_position: 2 "deleted": false, "id": "AAABI3NNNAY" } - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md b/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md index 3d9b91ec40..0cdd1cc327 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Copy-object.md @@ -6,6 +6,11 @@ sidebar_position: 7 Копирует файл или каталог + + +
+ + *Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - НовоеИмя = "Скопированный файл.jpeg"; НовоеРасположение = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; @@ -28,8 +33,9 @@ sidebar_position: 7 Ответ = OPI_GoogleDrive.СкопироватьОбъект(Токен, Идентификатор, НовоеИмя, НовоеРасположение) //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,14 +43,11 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "mimeType": "image/jpeg", "name": "Скопированный файл.jpeg", "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", "kind": "drive#file" } - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md b/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md index 4545df4c52..2fc44ff61b 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает пустой каталог на диске + + +
+ + *Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Имя = "Тестовая папка"; Ответ = OPI_GoogleDrive.СоздатьПапку(Токен, Имя); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -34,14 +40,11 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "mimeType": "application/vnd.google-apps.folder", "name": "Тестовая папка", "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", "kind": "drive#file" } - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md b/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md index a375a5e7f9..7f607131d2 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Удаляет файл или каталог по ID + + +
+ + *Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,15 +21,16 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Ответ = OPI_GoogleDrive.УдалитьОбъект(Токен, Идентификатор); //Соответствие - ``` + + ```sh title="Пример команды CLI" @@ -32,9 +38,6 @@ sidebar_position: 9 ``` - ```json title="Результат" - -'' - + '' ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md index 5cdb704609..fa67135ae4 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает файл по ID + + +
+ + *Функция СкачатьФайл(Знач Токен, Знач Идентификатор, Знач ПутьСохранения = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 6 Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + ```bsl title="Пример кода" - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Ответ = OPI_GoogleDrive.СкачатьФайл(Токен, Идентификатор); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -34,9 +40,6 @@ sidebar_position: 6 ``` - ```json title="Результат" - <Двоичные данные файла> - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md index e24682e002..e593f78363 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-directories-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список каталогов диска + + +
+ + *Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий каталогов + ```bsl title="Пример кода" - Имя = "Описание"; Ответ = OPI_GoogleDrive.ПолучитьСписокКаталогов(Токен, Имя, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -[ + [ { "linkShareMetadata": { "securityUpdateEnabled": true, @@ -142,5 +146,4 @@ sidebar_position: 2 "kind": "drive#file" } ] - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md index 3ff35d547e..6ebf63c358 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-file-description.md @@ -6,6 +6,11 @@ sidebar_position: 10 + + +
+ + *Функция ПолучитьОписаниеФайла() Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -14,8 +19,8 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - Описание файла + ```bsl title="Пример кода" - Описание = Новый Соответствие; Описание.Вставить("MIME" , "image/jpeg"); // MIME-тип загружаемого файла @@ -25,8 +30,9 @@ sidebar_position: 10 Возврат Описание; - ``` + + ```sh title="Пример команды CLI" @@ -35,8 +41,3 @@ sidebar_position: 10 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md index d3a41173cb..8a3af2b3a4 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает список файлов + + +
+ + *Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий файлов + ```bsl title="Пример кода" - Каталог = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; Ответ = OPI_GoogleDrive.ПолучитьСписокФайлов(Токен, , Каталог); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -[ + [ { "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", "linkShareMetadata": { @@ -171,5 +175,4 @@ sidebar_position: 3 "size": "2114025" } ] - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md b/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md index 218cd605dd..5f14241c58 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Get-object-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает информацию о папке или файле по ID + + +
+ + *Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Идентификатор = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Ответ = OPI_GoogleDrive.ПолучитьИнформациюОбОбъекте(Токен, Идентификатор); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "linkShareMetadata": { "securityUpdateEnabled": true, "securityUpdateEligible": false @@ -140,5 +144,4 @@ sidebar_position: 1 "kind": "drive#file", "thumbnailVersion": "0" } - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md index dcd987b39d..0641d1072a 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Update-file.md @@ -6,6 +6,11 @@ sidebar_position: 8 Обновляет двоичные данные файла + + +
+ + *Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - НовоеИмя = "Обновленный файл.jpeg"; КартинкаЗамены = "C:\OPI\image2.jpg"; @@ -28,8 +33,9 @@ sidebar_position: 8 Ответ = OPI_GoogleDrive.ОбновитьФайл(Токен, Идентификатор, КартинкаЗамены, НовоеИмя) //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,14 +43,11 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "mimeType": "image/jpeg", "name": "Обновленный файл.jpg", "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", "kind": "drive#file" } - ``` diff --git a/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md b/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md index 2b7611605c..81a8ca3995 100644 --- a/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md +++ b/docs/ru/md/Google_Drive/File-and-directory-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Загружает файл на диск + + +
+ + *Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Описание = Новый Соответствие; Описание.Вставить("MIME" , "image/jpeg"); @@ -31,8 +36,9 @@ sidebar_position: 4 Ответ = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -40,14 +46,11 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "mimeType": "image/jpeg", "name": "Новый файл.jpg", "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", "kind": "drive#file" } - ``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md b/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md index a70cbdf5a3..a46aba24d4 100644 --- a/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md +++ b/docs/ru/md/Google_Sheets/Data-managment/Clear-cells.md @@ -6,6 +6,11 @@ sidebar_position: 2 Очищает значение в ячейках + + +
+ + *Функция ОчиститьЯчейки(Знач Токен, Знач Книга, Знач МассивЯчеек, Знач Лист = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - МассивЯчеек = Новый Массив; МассивЯчеек.Добавить("B2"); @@ -32,8 +37,9 @@ sidebar_position: 2 Ответ = OPI_GoogleSheets.ОчиститьЯчейки(Токен, Книга, МассивЯчеек, Лист); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "clearedRanges": [ "'Лист2'!B2", @@ -52,5 +56,4 @@ sidebar_position: 2 "'Лист2'!B4" ] } - ``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md b/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md index ceedc4feab..ddb378ad76 100644 --- a/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md +++ b/docs/ru/md/Google_Sheets/Data-managment/Get-cell-values.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает значения ячеек таблицы + + +
+ + *Функция ПолучитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач МассивЯчеек = "", Знач Лист = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - МассивЯчеек = Новый Массив; МассивЯчеек.Добавить("B2"); @@ -32,8 +37,9 @@ sidebar_position: 3 Ответ = OPI_GoogleSheets.ПолучитьЗначенияЯчеек(Токен, Книга, МассивЯчеек, Лист); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "valueRanges": [ { @@ -76,5 +80,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md b/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md index 212c5daf35..e2221ca1dc 100644 --- a/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md +++ b/docs/ru/md/Google_Sheets/Data-managment/Set-cell-values.md @@ -6,6 +6,11 @@ sidebar_position: 1 Устанавливает значения ячеек листа + + +
+ + *Функция УстановитьЗначенияЯчеек(Знач Токен, Знач Книга, Знач СоответствиеЗначений, Знач Лист = "", Знач ОсновноеИзмерение = "COLUMNS") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - СоответствиеЗначений = Новый Соответствие; СоответствиеЗначений.Вставить("A1", "Это A1"); @@ -38,8 +43,9 @@ sidebar_position: 1 Ответ = OPI_GoogleSheets.УстановитьЗначенияЯчеек(Токен, Книга, СоответствиеЗначений, Лист); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -47,10 +53,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "totalUpdatedRows": 4, "totalUpdatedColumns": 2, @@ -115,5 +119,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md index 991711edf7..e2dafbabb0 100644 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Create-spreadsheet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает новую книгу + + +
+ + *Функция СоздатьКнигу(Знач Токен, Знач Наименование, Знач МассивИменЛистов) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - МассивИменЛистов = Новый Массив; МассивИменЛистов.Добавить("Лист1"); @@ -29,8 +34,9 @@ sidebar_position: 1 Ответ = OPI_GoogleSheets.СоздатьКнигу(Токен, Наименование, МассивИменЛистов); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "properties": { "title": "Тестовая таблица", @@ -202,5 +206,4 @@ sidebar_position: 1 ], "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" } - ``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md index 79944c90c0..901f67a6b6 100644 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Edit-spreadsheet-title.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет наименование существующей книги + + +
+ + *Функция ИзменитьНаименованиеКниги(Знач Токен, Знач Книга, Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Наименование = "Тестовая таблица (изм.)"; @@ -26,8 +31,9 @@ sidebar_position: 3 Ответ = OPI_GoogleSheets.ИзменитьНаименованиеКниги(Токен, Книга, Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,14 +41,11 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ {} ] } - ``` diff --git a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md index a35cb42f12..5257a4a117 100644 --- a/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md +++ b/docs/ru/md/Google_Sheets/Spreadsheets-managment/Get-spreadsheet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает информацию о книге по ID + + +
+ + *Функция ПолучитьКнигу(Знач Токен, Знач Идентификатор) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Идентификатор = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Ответ = OPI_GoogleSheets.ПолучитьКнигу(Токен, Идентификатор); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "properties": { "title": "Тестовая таблица (изм.)", @@ -197,5 +201,4 @@ sidebar_position: 2 ], "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" } - ``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md index 18d061a915..38edede802 100644 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Add-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Добавляет новый лист в книгу + + +
+ + *Функция ДобавитьЛист(Знач Токен, Знач Книга, Знач Наименование) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Наименование = "Тестовый лист"; @@ -26,8 +31,9 @@ sidebar_position: 1 Ответ = OPI_GoogleSheets.ДобавитьЛист(Токен, Книга, Наименование); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ { @@ -57,5 +61,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md index 9d6dad4d12..7be71923a2 100644 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Copy-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 3 Копирует лист из одной книги в другую + + +
+ + *Функция КопироватьЛист(Знач Токен, Знач Откуда, Знач Куда, Знач Лист) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Откуда = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Куда = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; @@ -28,8 +33,9 @@ sidebar_position: 3 Ответ = OPI_GoogleSheets.КопироватьЛист(Токен, Откуда, Куда, Лист); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "sheetId": 1790807910, "title": "Лист2 (копия)", "index": 2, @@ -50,5 +54,4 @@ sidebar_position: 3 "columnCount": 26 } } - ``` diff --git a/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md b/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md index 5e7e5bbaac..9ed681bd1c 100644 --- a/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md +++ b/docs/ru/md/Google_Sheets/Working-with-sheets/Delete-sheet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Удаляет лист из книги + + +
+ + *Функция УдалитьЛист(Знач Токен, Знач Книга, Знач Лист) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google + ```bsl title="Пример кода" - Книга = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Лист = "1790807910"; @@ -26,8 +31,9 @@ sidebar_position: 2 Ответ = OPI_GoogleSheets.УдалитьЛист(Токен, Книга, Лист); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,14 +41,11 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "replies": [ {} ] } - ``` diff --git a/docs/ru/md/Notion/Blocks-managment/Create-block.md b/docs/ru/md/Notion/Blocks-managment/Create-block.md index f071ae6c58..ff56c5370a 100644 --- a/docs/ru/md/Notion/Blocks-managment/Create-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Create-block.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает новый блок на основе существующего блока + + +
+ + *Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Родитель = "5dd94c34fab04bff9..."; @@ -31,8 +36,9 @@ sidebar_position: 1 Ответ = OPI_Notion.СоздатьБлок(Токен, Родитель, "aa4137d4c8cc445d9f969c3968..."); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "request_id": "4de46f5b-d38b-4df5-b26e-32127db1096b", "block": {}, "type": "block", @@ -96,5 +100,4 @@ sidebar_position: 1 ], "object": "list" } - ``` diff --git a/docs/ru/md/Notion/Blocks-managment/Delete-block.md b/docs/ru/md/Notion/Blocks-managment/Delete-block.md index 1ac0a6b6b1..1178281d88 100644 --- a/docs/ru/md/Notion/Blocks-managment/Delete-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Delete-block.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет блок по ID + + +
+ + *Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Блок = "ca18df269bd24407852b91c30..."; @@ -25,8 +30,9 @@ sidebar_position: 4 Ответ = OPI_Notion.УдалитьБлок(Токен, ИДБлока); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "request_id": "62b95ed2-c9af-4be8-b75a-f6e4f69aef14", "to_do": { "color": "default", @@ -82,5 +86,4 @@ sidebar_position: 4 "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", "object": "block" } - ``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-block.md b/docs/ru/md/Notion/Blocks-managment/Return-block.md index 1f502fe4cb..ae2da6d1a1 100644 --- a/docs/ru/md/Notion/Blocks-managment/Return-block.md +++ b/docs/ru/md/Notion/Blocks-managment/Return-block.md @@ -6,6 +6,11 @@ sidebar_position: 2 Возвращает структуру блока по ID + + +
+ + *Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Блок = "ca18df269bd24407852b91c30..."; @@ -26,8 +31,9 @@ sidebar_position: 2 Ответ = OPI_Notion.ВернутьБлок(Токен, ИДБлока); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "request_id": "031886cc-537d-4025-b480-ecfdc9f2870c", "to_do": { "color": "default", @@ -83,5 +87,4 @@ sidebar_position: 2 "id": "d7021bdd-15b9-44ab-abcb-02bd2b1a5f6a", "object": "block" } - ``` diff --git a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md index 219b834064..a891217aa1 100644 --- a/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md +++ b/docs/ru/md/Notion/Blocks-managment/Return-child-blocks.md @@ -6,6 +6,11 @@ sidebar_position: 3 Созвращает список дочерних блоков блока-родителя + + +
+ + *Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Блок = "46c1500ed40c4e89ba6a22900..."; @@ -25,8 +30,9 @@ sidebar_position: 3 Ответ = OPI_Notion.ВернутьДочерниеБлоки(Токен, ИДБлока); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "request_id": "fea2a37b-5507-451d-a4be-14433811a69e", "block": {}, "type": "block", @@ -133,5 +137,4 @@ sidebar_position: 3 ], "object": "list" } - ``` diff --git a/docs/ru/md/Notion/Database-management/Create-database.md b/docs/ru/md/Notion/Database-management/Create-database.md index 204224aa39..c539bab1a2 100644 --- a/docs/ru/md/Notion/Database-management/Create-database.md +++ b/docs/ru/md/Notion/Database-management/Create-database.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает базу данных + + +
+ + *Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Родитель = "5dd94c34fab04bff9..."; @@ -47,8 +52,9 @@ sidebar_position: 1 Ответ = OPI_Notion.СоздатьБазуДанных(Токен, Родитель, Заголовок, Свойства); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -56,10 +62,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "request_id": "43adcae7-c8ee-4a7d-aba6-c2c43ad2c33b", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -195,5 +199,4 @@ sidebar_position: 1 }, "object": "database" } - ``` diff --git a/docs/ru/md/Notion/Database-management/Edit-database-properties.md b/docs/ru/md/Notion/Database-management/Edit-database-properties.md index 1c5a0de6de..4bedc32343 100644 --- a/docs/ru/md/Notion/Database-management/Edit-database-properties.md +++ b/docs/ru/md/Notion/Database-management/Edit-database-properties.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет свойства существующей базы + + +
+ + *Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; База = "5dd94c34fab04bff9..."; @@ -34,8 +39,9 @@ sidebar_position: 3 Ответ = OPI_Notion.ИзменитьСвойстваБазы(Токен, База, Свойства, Заголовок, Описание); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -43,10 +49,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "request_id": "d42b5700-9325-439e-98ce-252a007f5ed7", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -194,5 +198,4 @@ sidebar_position: 3 }, "object": "database" } - ``` diff --git a/docs/ru/md/Notion/Database-management/Get-database.md b/docs/ru/md/Notion/Database-management/Get-database.md index d788caee3f..89ac285005 100644 --- a/docs/ru/md/Notion/Database-management/Get-database.md +++ b/docs/ru/md/Notion/Database-management/Get-database.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получить данные о базе данных + + +
+ + *Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; База = "048ba0ce4f474e33900540d24..."; @@ -25,8 +30,9 @@ sidebar_position: 2 Ответ = OPI_Notion.ПолучитьБазуДанных(Токен, База); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "request_id": "9c6e06e9-ffa5-4a3c-b4ff-0368553ca066", "public_url": null, "url": "https://www.notion.so/048ba0ce4f474e33900540d249b01949", @@ -185,5 +189,4 @@ sidebar_position: 2 }, "object": "database" } - ``` diff --git a/docs/ru/md/Notion/Page-management/Create-page-in-database.md b/docs/ru/md/Notion/Page-management/Create-page-in-database.md index b7e87e83fd..5cb0357691 100644 --- a/docs/ru/md/Notion/Page-management/Create-page-in-database.md +++ b/docs/ru/md/Notion/Page-management/Create-page-in-database.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает страницу в базе-родителе + + +
+ + *Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Родитель = "5dd94c34fab04bff9..."; @@ -40,8 +45,9 @@ sidebar_position: 2 Ответ = OPI_Notion.СоздатьСтраницуВБазу(Токен, База, Данные); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -49,10 +55,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "request_id": "03fd3bd2-6dd1-4ca2-bf85-9233748a745f", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -198,5 +202,4 @@ sidebar_position: 2 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/ru/md/Notion/Page-management/Create-page.md b/docs/ru/md/Notion/Page-management/Create-page.md index e80242e3f7..7695b9c4fd 100644 --- a/docs/ru/md/Notion/Page-management/Create-page.md +++ b/docs/ru/md/Notion/Page-management/Create-page.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает дочернюю страницу над другой страницей-родителем + + +
+ + *Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Родитель = "5dd94c34fab04bff9..."; @@ -27,8 +32,9 @@ sidebar_position: 1 Ответ = OPI_Notion.СоздатьСтраницу(Токен, Родитель, Заголовок); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "request_id": "f145f634-ea3a-4f74-b079-f365ecbcf583", "public_url": null, "url": "https://www.notion.so/1-4392f919813c4c8d84017d973bddaabf", @@ -88,5 +92,4 @@ sidebar_position: 1 "id": "4392f919-813c-4c8d-8401-7d973bddaabf", "object": "page" } - ``` diff --git a/docs/ru/md/Notion/Page-management/Edit-page-properties.md b/docs/ru/md/Notion/Page-management/Edit-page-properties.md index 811d037f65..fe7d5ad5ad 100644 --- a/docs/ru/md/Notion/Page-management/Edit-page-properties.md +++ b/docs/ru/md/Notion/Page-management/Edit-page-properties.md @@ -6,6 +6,11 @@ sidebar_position: 4 Изменяет свойства существующей страницы + + +
+ + *Функция ИзменитьСвойстваСтраницы(Знач Токен, Знач Страница, Знач Данные = "", Знач Иконка = "", Знач Обложка = "", Знач Архивирована = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Страница = "5dd94c34fab04bff9..."; @@ -41,8 +46,9 @@ sidebar_position: 4 Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -50,10 +56,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "request_id": "a02741b2-4eb8-43ae-9a2e-542d5dd10687", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -209,5 +213,4 @@ sidebar_position: 4 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/ru/md/Notion/Page-management/Get-page.md b/docs/ru/md/Notion/Page-management/Get-page.md index fb16096154..2a42933502 100644 --- a/docs/ru/md/Notion/Page-management/Get-page.md +++ b/docs/ru/md/Notion/Page-management/Get-page.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию о странице по ID + + +
+ + *Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Страница = "a574281614174169bf55dbae4..."; @@ -25,8 +30,9 @@ sidebar_position: 3 Ответ = OPI_Notion.ПолучитьСтраницу(Токен, Страница); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "request_id": "61eaaa91-41fc-4523-a445-602805afb281", "public_url": null, "url": "https://www.notion.so/a574281614174169bf55dbae44f46d9c", @@ -193,5 +197,4 @@ sidebar_position: 3 "id": "a5742816-1417-4169-bf55-dbae44f46d9c", "object": "page" } - ``` diff --git a/docs/ru/md/Notion/Users/Get-user-data.md b/docs/ru/md/Notion/Users/Get-user-data.md index b65dcb0901..31bfb3a165 100644 --- a/docs/ru/md/Notion/Users/Get-user-data.md +++ b/docs/ru/md/Notion/Users/Get-user-data.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает данные пользователя по ID + + +
+ + *Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; ИДПользователя = "ed71865a989146bc86cdwdf24..."; @@ -25,8 +30,9 @@ sidebar_position: 2 Ответ = OPI_Notion.ПолучитьДанныеПользователя(Токен, ИДПользователя); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "request_id": "f33d34a8-f3cf-41b5-bdf5-4a07cf7d7118", "person": { "email": "ex@gmail.com" @@ -48,5 +52,4 @@ sidebar_position: 2 "id": "ed71865a-9891-1111-86cd-1111111", "object": "user" } - ``` diff --git a/docs/ru/md/Notion/Users/User-list.md b/docs/ru/md/Notion/Users/User-list.md index 1dde8c77a5..443f5a47e1 100644 --- a/docs/ru/md/Notion/Users/User-list.md +++ b/docs/ru/md/Notion/Users/User-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Возвращает список пользователей рабочего пространства + + +
+ + *Функция СписокПользователей(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,15 +20,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion + ```bsl title="Пример кода" - Токен = "secret_9RsfMrRMqZwqp0Zl0B..."; Ответ = OPI_Notion.СписокПользователей(Токен); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "request_id": "ea9a6b96-0b02-4866-a60a-2958e514af38", "user": {}, "type": "user", @@ -68,5 +72,4 @@ sidebar_position: 1 ], "object": "list" } - ``` diff --git a/docs/ru/md/Slack/Block-formation/Generate-image-block.md b/docs/ru/md/Slack/Block-formation/Generate-image-block.md index 36c00dcb90..7421d9019f 100644 --- a/docs/ru/md/Slack/Block-formation/Generate-image-block.md +++ b/docs/ru/md/Slack/Block-formation/Generate-image-block.md @@ -6,6 +6,11 @@ sidebar_position: 1 Формирует блок с картинкой для добавления в массив блоков сообщения + + +
+ + *Функция СформироватьБлокКартинку(Знач URL, Знач АльтернативныйТекст = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - Блок картинки + ```bsl title="Пример кода" - Текст = "Картинка альпаки"; URL = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"; @@ -25,8 +30,9 @@ sidebar_position: 1 Ответ = OPI_Slack.СформироватьБлокКартинку(URL, Текст); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,13 +40,10 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "alt_text": "Yo", "image_url": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1", "type": "image" } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Archive-channel.md b/docs/ru/md/Slack/Channel-management/Archive-channel.md index f1b438a2cc..ac0a44df66 100644 --- a/docs/ru/md/Slack/Channel-management/Archive-channel.md +++ b/docs/ru/md/Slack/Channel-management/Archive-channel.md @@ -6,6 +6,11 @@ sidebar_position: 4 Архивирует активный канал + + +
+ + *Функция АрхивироватьКанал(Знач Токен, Знач Канал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; @@ -25,8 +30,9 @@ sidebar_position: 4 Ответ = OPI_Slack.АрхивироватьКанал(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,11 +40,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Create-channel.md b/docs/ru/md/Slack/Channel-management/Create-channel.md index 33d0989ef6..4069310b76 100644 --- a/docs/ru/md/Slack/Channel-management/Create-channel.md +++ b/docs/ru/md/Slack/Channel-management/Create-channel.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает новый канал + + +
+ + *Функция СоздатьКанал(Знач Токен, Знач Название, Знач Приватный = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Название = "testcov" + Строка(Новый УникальныйИдентификатор); Ответ = OPI_Slack.СоздатьКанал(Токен, Название, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -81,5 +85,4 @@ sidebar_position: 3 "priority": 0 } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-history.md b/docs/ru/md/Slack/Channel-management/Get-channel-history.md index 7517314728..e0254769b3 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-history.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-history.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает информацию событиях канала + + +
+ + *Функция ПолучитьИсториюКанала(Знач Токен, Знач Канал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПолучитьИсториюКанала(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "ok": true, "messages": [ { @@ -76,5 +80,4 @@ sidebar_position: 6 "channel_actions_ts": null, "channel_actions_count": 0 } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-list.md b/docs/ru/md/Slack/Channel-management/Get-channel-list.md index eb048d3ef2..52be38ab68 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-list.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список доступных каналов + + +
+ + *Функция ПолучитьСписокКаналов(Знач Токен, Знач ИсключатьАрхивированные = Ложь, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИсключатьАрхивированные = Истина; Ответ = OPI_Slack.ПолучитьСписокКаналов(Токен, ИсключатьАрхивированные); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "channels": [ { @@ -85,5 +89,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md index 1166bb7eeb..eb462971a6 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel-user-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список пользователей указанного канала + + +
+ + *Функция ПолучитьСписокПользователейКанала(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПолучитьСписокПользователейКанала(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "members": [ "U06UG1CAYH2" @@ -46,5 +50,4 @@ sidebar_position: 2 "next_cursor": "" } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Get-channel.md b/docs/ru/md/Slack/Channel-management/Get-channel.md index c47b62594a..11659884ee 100644 --- a/docs/ru/md/Slack/Channel-management/Get-channel.md +++ b/docs/ru/md/Slack/Channel-management/Get-channel.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает информацию о канале + + +
+ + *Функция ПолучитьКанал(Знач Токен, Знач Канал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПолучитьКанал(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -79,5 +83,4 @@ sidebar_position: 5 "previous_names": [] } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md index 525f0ca0e3..e9c6baa02e 100644 --- a/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md +++ b/docs/ru/md/Slack/Channel-management/Invite-users-to-channel.md @@ -6,6 +6,11 @@ sidebar_position: 7 Добавляет указанных пользователей в канал + + +
+ + *Функция ПригласитьПользователейВКанал(Знач Токен, Знач Канал, Знач МассивПользователей) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; МассивПользователей = Новый Массив; @@ -27,8 +32,9 @@ sidebar_position: 7 Ответ = OPI_Slack.ПригласитьПользователейВКанал(Токен, Канал, МассивПользователей); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -82,5 +86,4 @@ sidebar_position: 7 "previous_names": [] } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Join-channel.md b/docs/ru/md/Slack/Channel-management/Join-channel.md index 6f74104288..9be47d3ae1 100644 --- a/docs/ru/md/Slack/Channel-management/Join-channel.md +++ b/docs/ru/md/Slack/Channel-management/Join-channel.md @@ -6,6 +6,11 @@ sidebar_position: 9 Добавляет текущего бота в канал + + +
+ + *Функция ВступитьВКанал(Знач Токен, Знач Канал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ВступитьВКанал(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 9 "priority": 0 } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md index c3c2774f32..1ea8190cd3 100644 --- a/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md +++ b/docs/ru/md/Slack/Channel-management/Kick-user-from-channel.md @@ -6,6 +6,11 @@ sidebar_position: 8 Удаляет указанного пользователя из канала + + +
+ + *Функция ВыгнатьПользователяИзКанала(Знач Токен, Знач Канал, Знач Пользователь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Пользователь = "U06UG1CAYH2"; Канал = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 8 Ответ = OPI_Slack.ВыгнатьПользователяИзКанала(Токен, Канал, Пользователь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,11 +41,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "ok": true } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Leave-channel.md b/docs/ru/md/Slack/Channel-management/Leave-channel.md index b4e87efcaa..d98c2cda10 100644 --- a/docs/ru/md/Slack/Channel-management/Leave-channel.md +++ b/docs/ru/md/Slack/Channel-management/Leave-channel.md @@ -6,6 +6,11 @@ sidebar_position: 10 Удаляет текущего бота из канала + + +
+ + *Функция ПокинутьКанал(Знач Токен, Знач Канал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПокинутьКанал(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "ok": true } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Rename-channel.md b/docs/ru/md/Slack/Channel-management/Rename-channel.md index 114fa0bc87..7e868bf781 100644 --- a/docs/ru/md/Slack/Channel-management/Rename-channel.md +++ b/docs/ru/md/Slack/Channel-management/Rename-channel.md @@ -6,6 +6,11 @@ sidebar_position: 13 Изменяет название канала + + +
+ + *Функция ПереименоватьКанал(Знач Токен, Знач Канал, Знач Название) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 13 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Название = "testcov" + Строка(Новый УникальныйИдентификатор); Канал = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 13 Ответ = OPI_Slack.ПереименоватьКанал(Токен, Канал, Название); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 13 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -83,5 +87,4 @@ sidebar_position: 13 ] } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md b/docs/ru/md/Slack/Channel-management/Set-channel-goal.md index 7a9016d9be..101a5554d5 100644 --- a/docs/ru/md/Slack/Channel-management/Set-channel-goal.md +++ b/docs/ru/md/Slack/Channel-management/Set-channel-goal.md @@ -6,6 +6,11 @@ sidebar_position: 12 Устанавливает цель (описание) канала + + +
+ + *Функция УстановитьЦельКанала(Знач Токен, Знач Канал, Знач Цель) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 12 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Цель = "Тестовая цель"; Канал = "C070VPMKN8J"; @@ -26,8 +31,9 @@ sidebar_position: 12 Ответ = OPI_Slack.УстановитьЦельКанала(Токен, Канал, Цель); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 12 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 12 "previous_names": [] } } - ``` diff --git a/docs/ru/md/Slack/Channel-management/Set-channel-topic.md b/docs/ru/md/Slack/Channel-management/Set-channel-topic.md index cc3fda5734..04bb4ec608 100644 --- a/docs/ru/md/Slack/Channel-management/Set-channel-topic.md +++ b/docs/ru/md/Slack/Channel-management/Set-channel-topic.md @@ -6,6 +6,11 @@ sidebar_position: 11 Устанавливает тему канала + + +
+ + *Функция УстановитьТемуКанала(Знач Токен, Знач Канал, Знач Тема) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 11 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Тема = "Тестовая тема"; @@ -26,8 +31,9 @@ sidebar_position: 11 Ответ = OPI_Slack.УстановитьТемуКанала(Токен, Канал, Тема); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 11 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": { "id": "C070VPMKN8J", @@ -80,5 +84,4 @@ sidebar_position: 11 "previous_names": [] } } - ``` diff --git a/docs/ru/md/Slack/Dialog-management/Close-dialog.md b/docs/ru/md/Slack/Dialog-management/Close-dialog.md index 0522f90248..f6e36ac2dd 100644 --- a/docs/ru/md/Slack/Dialog-management/Close-dialog.md +++ b/docs/ru/md/Slack/Dialog-management/Close-dialog.md @@ -6,6 +6,11 @@ sidebar_position: 2 Закрывает существующий диалог + + +
+ + *Функция ЗакрытьДиалог(Знач Токен, Знач Диалог) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Диалог = "D06UAKK1C6R"; Ответ = OPI_Slack.ЗакрытьДиалог(Токен, Диалог); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,13 +39,10 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "already_closed": false, "no_op": false } - ``` diff --git a/docs/ru/md/Slack/Dialog-management/Open-dialog.md b/docs/ru/md/Slack/Dialog-management/Open-dialog.md index 8bb499dbb3..fca87986d9 100644 --- a/docs/ru/md/Slack/Dialog-management/Open-dialog.md +++ b/docs/ru/md/Slack/Dialog-management/Open-dialog.md @@ -6,6 +6,11 @@ sidebar_position: 1 Открывает новый диалог с одним или несколькими пользователями + + +
+ + *Функция ОткрытьДиалог(Знач Токен, Знач МассивПользователей) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - МассивПользователей = Новый Массив; МассивПользователей.Добавить("U123456"); @@ -26,8 +31,9 @@ sidebar_position: 1 Ответ = OPI_Slack.ОткрытьДиалог(Токен, МассивПользователей); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "no_op": false, "already_open": false, @@ -46,5 +50,4 @@ sidebar_position: 1 "id": "D06UAKK1C6R" } } - ``` diff --git a/docs/ru/md/Slack/External-files-management/Add-external-file.md b/docs/ru/md/Slack/External-files-management/Add-external-file.md index 6be20f9652..cb79b9e8d2 100644 --- a/docs/ru/md/Slack/External-files-management/Add-external-file.md +++ b/docs/ru/md/Slack/External-files-management/Add-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Добавляет новый внешний файл + + +
+ + *Функция ДобавитьВнешнийФайл(Знач Токен, Знач URL, Знач Заголовок) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - URL = https://opi.neocities.org/test_data/document.docx; Заголовок = "Новый файл"; @@ -26,8 +31,9 @@ sidebar_position: 3 Ответ = OPI_Slack.ДобавитьВнешнийФайл(Токен, URL, Заголовок); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -76,5 +80,4 @@ sidebar_position: 3 "file_access": "visible" } } - ``` diff --git a/docs/ru/md/Slack/External-files-management/Delete-external-file.md b/docs/ru/md/Slack/External-files-management/Delete-external-file.md index cbbafc50ce..c53a697f4b 100644 --- a/docs/ru/md/Slack/External-files-management/Delete-external-file.md +++ b/docs/ru/md/Slack/External-files-management/Delete-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 5 Удаляет внешний файл из Slack + + +
+ + *Функция УдалитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИдентификаторФайла = "F070P52CU94"; Ответ = OPI_Slack.УдалитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true } - ``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file-list.md b/docs/ru/md/Slack/External-files-management/Get-external-file-list.md index 238b717898..078a77db5c 100644 --- a/docs/ru/md/Slack/External-files-management/Get-external-file-list.md +++ b/docs/ru/md/Slack/External-files-management/Get-external-file-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список внешних файлов пользователя или канала + + +
+ + *Функция ПолучитьСписокВнешнихФайлов(Знач Токен, Знач Канал = "", Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПолучитьСписокВнешнихФайлов(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,15 +40,12 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "files": [], "response_metadata": { "next_cursor": "" } } - ``` diff --git a/docs/ru/md/Slack/External-files-management/Get-external-file.md b/docs/ru/md/Slack/External-files-management/Get-external-file.md index 66f4b7d7e8..f5e7c01994 100644 --- a/docs/ru/md/Slack/External-files-management/Get-external-file.md +++ b/docs/ru/md/Slack/External-files-management/Get-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает информацию о внешнем файле + + +
+ + *Функция ПолучитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИдентификаторФайла = "F070P52CU94"; Ответ = OPI_Slack.ПолучитьВнешнийФайл(Токен, ИдентификаторФайла); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -74,5 +78,4 @@ sidebar_position: 2 "file_access": "visible" } } - ``` diff --git a/docs/ru/md/Slack/External-files-management/Send-external-file.md b/docs/ru/md/Slack/External-files-management/Send-external-file.md index 745b8695b6..a24d5bccd5 100644 --- a/docs/ru/md/Slack/External-files-management/Send-external-file.md +++ b/docs/ru/md/Slack/External-files-management/Send-external-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Отправляет внейшний файл по списку каналов + + +
+ + *Функция ОтправитьВнешнийФайл(Знач Токен, Знач ИдентификаторФайла, Знач МассивКаналов) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; ИдентификаторФайла = "F070P52CU94"; @@ -26,8 +31,9 @@ sidebar_position: 4 Ответ = OPI_Slack.ОтправитьВнешнийФайл(Токен, ИдентификаторФайла, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "file": { "id": "F070P52CU94", @@ -93,5 +97,4 @@ sidebar_position: 4 "file_access": "visible" } } - ``` diff --git a/docs/ru/md/Slack/File-managment/Delete-file.md b/docs/ru/md/Slack/File-managment/Delete-file.md index 9e187f2748..3700f50853 100644 --- a/docs/ru/md/Slack/File-managment/Delete-file.md +++ b/docs/ru/md/Slack/File-managment/Delete-file.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет файл на Slack + + +
+ + *Функция УдалитьФайл(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИдентификаторФайла = "F070VL6FQFM"; Ответ = OPI_Slack.УдалитьФайл(Токен, ИдентификаторФайла); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true } - ``` diff --git a/docs/ru/md/Slack/File-managment/Get-file-data.md b/docs/ru/md/Slack/File-managment/Get-file-data.md index e6362ce290..c264e02da7 100644 --- a/docs/ru/md/Slack/File-managment/Get-file-data.md +++ b/docs/ru/md/Slack/File-managment/Get-file-data.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию о файле + + +
+ + *Функция ПолучитьДанныеФайла(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИдентификаторФайла = "F070VL6FQFM"; Ответ = OPI_Slack.ПолучитьДанныеФайла(Токен, ИдентификаторФайла); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "file": { "id": "F070VL6FQFM", @@ -78,5 +82,4 @@ sidebar_position: 3 "next_cursor": "" } } - ``` diff --git a/docs/ru/md/Slack/File-managment/Get-files-list.md b/docs/ru/md/Slack/File-managment/Get-files-list.md index e1b0e61376..bb69d03efe 100644 --- a/docs/ru/md/Slack/File-managment/Get-files-list.md +++ b/docs/ru/md/Slack/File-managment/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список файлов бота или канала + + +
+ + *Функция ПолучитьСписокФайлов(Знач Токен, Знач Канал = "", Знач НомерСтраницы = 1) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - НомерСтраницы = 1; Канал = "C123456"; @@ -26,8 +31,9 @@ sidebar_position: 1 Ответ = OPI_Slack.ПолучитьСписокФайлов(Токен, Канал, НомерСтраницы); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "files": [ { @@ -78,5 +82,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-private.md b/docs/ru/md/Slack/File-managment/Make-file-private.md index c4c3e409f2..b56686a6af 100644 --- a/docs/ru/md/Slack/File-managment/Make-file-private.md +++ b/docs/ru/md/Slack/File-managment/Make-file-private.md @@ -6,6 +6,11 @@ sidebar_position: 6 Удаляет публичный URL у файла. Требует токен пользователя + + +
+ + *Функция СделатьФайлПриватным(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,11 +21,9 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack -```bsl title="Пример кода" - -``` + ```sh title="Пример команды CLI" @@ -29,8 +32,3 @@ sidebar_position: 6 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Slack/File-managment/Make-file-public.md b/docs/ru/md/Slack/File-managment/Make-file-public.md index b2cf407b0d..e5979fa890 100644 --- a/docs/ru/md/Slack/File-managment/Make-file-public.md +++ b/docs/ru/md/Slack/File-managment/Make-file-public.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает публичный URL для файла. Требует токен пользователя + + +
+ + *Функция СделатьФайлПубличным(Знач Токен, Знач ИдентификаторФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,11 +21,9 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack -```bsl title="Пример кода" - -``` + ```sh title="Пример команды CLI" @@ -29,8 +32,3 @@ sidebar_position: 5 ``` -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Slack/File-managment/Upload-file.md b/docs/ru/md/Slack/File-managment/Upload-file.md index 458b425336..6a003045e5 100644 --- a/docs/ru/md/Slack/File-managment/Upload-file.md +++ b/docs/ru/md/Slack/File-managment/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 2 Загружает файл на сервера Slack + + +
+ + *Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач ИмяФайла, Знач Заголовок, Знач Канал = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - ИмяФайла = "megadoc.docx"; Файл = Новый ДвоичныеДанные("D:\" + ИмяФайла); @@ -30,8 +35,9 @@ sidebar_position: 2 Ответ = OPI_Slack.ЗагрузитьФайл(Токен, Файл, ИмяФайла, Заголовок, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ);//JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -39,10 +45,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "files": [ { @@ -82,5 +86,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md index 3c87c900a5..62cdf23521 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-bot-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает основную информацию о боте + + +
+ + *Функция ПолучитьИнформациюОБоте(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,15 +20,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Ответ = OPI_Slack.ПолучитьИнформациюОБоте(Токен); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "url": "https://openintegrationsgroup.slack.com/", "team": "OpenIntegrations", @@ -44,5 +48,4 @@ sidebar_position: 1 "bot_id": "B06TZ0MJV5M", "is_enterprise_install": false } - ``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-user-list.md b/docs/ru/md/Slack/Management-and-settings/Get-user-list.md index d8437fcf4e..c3bcab37f8 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-user-list.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-user-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает список пользователей рабочей области + + +
+ + *Функция ПолучитьСписокПользователей(Знач Токен, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,15 +21,16 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Ответ = OPI_Slack.ПолучитьСписокПользователей(Токен, Курсор); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "members": [ { @@ -190,5 +194,4 @@ sidebar_position: 3 "next_cursor": "" } } - ``` diff --git a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md index aa92538029..c77aebabda 100644 --- a/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md +++ b/docs/ru/md/Slack/Management-and-settings/Get-workspace-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список рабочих областей, в которых подключен бот + + +
+ + *Функция ПолучитьСписокРабочихОбластей(Знач Токен, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,15 +21,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Ответ = OPI_Slack.ПолучитьСписокРабочихОбластей(Токен); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "teams": [ { @@ -44,5 +48,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/ru/md/Slack/Message-management/Delete-message.md b/docs/ru/md/Slack/Message-management/Delete-message.md index 44a2fd4e83..c7069fb8a8 100644 --- a/docs/ru/md/Slack/Message-management/Delete-message.md +++ b/docs/ru/md/Slack/Message-management/Delete-message.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет сообщение канала по timestamp + + +
+ + *Функция УдалитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач ЭтоОтложенное = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C06UFNUTKUL"; Отметка = "1714146538.221929"; @@ -27,8 +32,9 @@ sidebar_position: 4 Ответ = OPI_Slack.УдалитьСообщение(Токен, Канал, Отметка); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -36,13 +42,10 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929" } - ``` diff --git a/docs/ru/md/Slack/Message-management/Edit-message.md b/docs/ru/md/Slack/Message-management/Edit-message.md index d4fbf080c4..5f6cf6acfa 100644 --- a/docs/ru/md/Slack/Message-management/Edit-message.md +++ b/docs/ru/md/Slack/Message-management/Edit-message.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет состав существующего сообщения + + +
+ + *Функция ИзменитьСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Текст = "", Знач МассивБлоков = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Отметка = "1714146538.221929"; @@ -29,8 +34,9 @@ sidebar_position: 3 Ответ = OPI_Slack.ИзменитьСообщение(Токен, Канал, Отметка, Текст); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929", @@ -85,5 +89,4 @@ sidebar_position: 3 ] } } - ``` diff --git a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md index b3f3f97255..52c32c57b2 100644 --- a/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md +++ b/docs/ru/md/Slack/Message-management/Get-delayed-message-list.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает список отложенных сообщений канала + + +
+ + *Функция ПолучитьСписокОтложенныхСообщений(Знач Токен, Знач Канал, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Ответ = OPI_Slack.ПолучитьСписокОтложенныхСообщений(Токен, Канал); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -34,15 +40,12 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true, "scheduled_messages": [], "response_metadata": { "next_cursor": "" } } - ``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-link.md b/docs/ru/md/Slack/Message-management/Get-message-link.md index a675832d5c..5411fa679b 100644 --- a/docs/ru/md/Slack/Message-management/Get-message-link.md +++ b/docs/ru/md/Slack/Message-management/Get-message-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает постоянный UTL к сообщению канала + + +
+ + *Функция ПолучитьСсылкуНаСообщение(Знач Токен, Знач Канал, Знач Отметка) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Отметка = "1714146538.221929"; @@ -26,8 +31,9 @@ sidebar_position: 6 Ответ = OPI_Slack.ПолучитьСсылкуНаСообщение(Токен, Канал, Отметка); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -35,13 +41,10 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "ok": true, "permalink": "https://openintegrationsgroup.slack.com/archives/C06UFNUTKUL/p1714146538221929", "channel": "C06UFNUTKUL" } - ``` diff --git a/docs/ru/md/Slack/Message-management/Get-message-reply-list.md b/docs/ru/md/Slack/Message-management/Get-message-reply-list.md index 4b8be1ee85..011a440a27 100644 --- a/docs/ru/md/Slack/Message-management/Get-message-reply-list.md +++ b/docs/ru/md/Slack/Message-management/Get-message-reply-list.md @@ -6,6 +6,11 @@ sidebar_position: 7 Получает массив сообщений, которые являются ответом на указанное + + +
+ + *Функция ПолучитьСписокОтветовНаСообщение(Знач Токен, Знач Канал, Знач Отметка, Знач Курсор = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Отметка = "1714146538.221929"; @@ -27,8 +32,9 @@ sidebar_position: 7 Ответ = OPI_Slack.ПолучитьСписокОтветовНаСообщение(Токен, Канал, Отметка); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "ok": true, "messages": [ { @@ -88,5 +92,4 @@ sidebar_position: 7 ], "has_more": false } - ``` diff --git a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md index a37fe88a47..6ecc5003be 100644 --- a/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md +++ b/docs/ru/md/Slack/Message-management/Send-ephemeral-message.md @@ -6,6 +6,11 @@ sidebar_position: 2 Отправляет сообщение, которое приходит в канал, но видно только конкретному пользователю + + +
+ + *Функция ОтправитьЭфемерноеСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач Пользователь = "", Знач Блоки = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Блок = OPI_Slack.СформироватьБлокКартинку("https://opi.neocities.org/test_data/picture.jpg", "Картинка"); @@ -28,8 +33,9 @@ sidebar_position: 2 Ответ = OPI_Slack.ОтправитьЭфемерноеСообщение(Токен, Канал, , Пользователь, Блок); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,12 +43,9 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "message_ts": "1714146540.000300" } - ``` diff --git a/docs/ru/md/Slack/Message-management/Send-message.md b/docs/ru/md/Slack/Message-management/Send-message.md index 7d88dcc697..e2d72279b5 100644 --- a/docs/ru/md/Slack/Message-management/Send-message.md +++ b/docs/ru/md/Slack/Message-management/Send-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Отправляет сообщение в выбранный час + + +
+ + *Функция ОтправитьСообщение(Знач Токен, Знач Канал, Знач Текст = "", Знач ДатаОтправки = "", Знач Блоки = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack + ```bsl title="Пример кода" - Канал = "C070VPMKN8J"; Текст = "Тестовое сообщение"; @@ -28,8 +33,9 @@ sidebar_position: 1 Ответ = OPI_Slack.ОтправитьСообщение(Токен, Канал, Текст); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "channel": "C06UFNUTKUL", "ts": "1714146538.221929", @@ -84,5 +88,4 @@ sidebar_position: 1 ] } } - ``` diff --git a/docs/ru/md/Telegram/Administration/Ban.md b/docs/ru/md/Telegram/Administration/Ban.md index c7d0bf14c2..b2a9a6f99e 100644 --- a/docs/ru/md/Telegram/Administration/Ban.md +++ b/docs/ru/md/Telegram/Administration/Ban.md @@ -6,6 +6,11 @@ sidebar_position: 1 Банит пользователя в выбранном чате + + +
+ + *Функция Бан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDПользователя = "461699897"; IDКанала = "@testsichee"; Результат = OPI_Telegram.Бан(Токен, IDКанала, IDПользователя); - ``` + + ```sh title="Пример команды CLI" @@ -33,13 +39,10 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": false, "error_code": 400, "description": "Bad Request: can't remove chat owner" } - ``` diff --git a/docs/ru/md/Telegram/Administration/Create-invitation-link.md b/docs/ru/md/Telegram/Administration/Create-invitation-link.md index 2e08f8f7dd..4d8fb1685f 100644 --- a/docs/ru/md/Telegram/Administration/Create-invitation-link.md +++ b/docs/ru/md/Telegram/Administration/Create-invitation-link.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает ссылку для вступления в закрытый чат + + +
+ + *Функция СоздатьСсылкуПриглашение(Знач Токен, Знач IDЧата, Знач Заголовок = "", Знач ДатаИстечения = "", Знач ЛимитПользователей = 0) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDКанала = "@testsichee"; Сутки = 86400; @@ -31,8 +36,9 @@ sidebar_position: 3 UnixИстечение = OPI_Инструменты.UNIXTime(Истечение); Результат = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, IDКанала, Заголовок, Истечение, 200); - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "invite_link": "https://t.me/+W-9MzjOejStiYzYy", @@ -61,5 +65,4 @@ sidebar_position: 3 "is_revoked": false } } - ``` diff --git a/docs/ru/md/Telegram/Administration/Delete-message.md b/docs/ru/md/Telegram/Administration/Delete-message.md index 76aab13932..29a4177ecc 100644 --- a/docs/ru/md/Telegram/Administration/Delete-message.md +++ b/docs/ru/md/Telegram/Administration/Delete-message.md @@ -6,6 +6,11 @@ sidebar_position: 7 Удаляет указанное сообщение из чата или канала + + +
+ + *Функция УдалитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "@testsichee"; IDСообщения = "5385"; Результат = OPI_Telegram.УдалитьСообщение(Токен, IDЧата, IDСообщения); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Administration/Get-participant-count.md b/docs/ru/md/Telegram/Administration/Get-participant-count.md index 40dd0bead1..52bb31f228 100644 --- a/docs/ru/md/Telegram/Administration/Get-participant-count.md +++ b/docs/ru/md/Telegram/Administration/Get-participant-count.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает общее число участников чата + + +
+ + *Функция ПолучитьЧислоУчастников(Знач Токен, Знач IDЧата) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDКанала = "@testsichee"; Результат = OPI_Telegram.ПолучитьЧислоУчастников(Токен, IDКанала); - ``` + + ```sh title="Пример команды CLI" @@ -31,12 +37,9 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "ok": true, "result": 2 } - ``` diff --git a/docs/ru/md/Telegram/Administration/Pin-message.md b/docs/ru/md/Telegram/Administration/Pin-message.md index 9c3642bc8d..075c098480 100644 --- a/docs/ru/md/Telegram/Administration/Pin-message.md +++ b/docs/ru/md/Telegram/Administration/Pin-message.md @@ -6,6 +6,11 @@ sidebar_position: 4 Закрепляет сообщение в шапке чата + + +
+ + *Функция ЗакрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDКанала = "@testsichee"; IDСообщения = "4951"; Результат = OPI_Telegram.ЗакрепитьСообщение(Токен, IDКанала, IDСообщения); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Administration/Unban.md b/docs/ru/md/Telegram/Administration/Unban.md index 15bf04b900..d24ee2e756 100644 --- a/docs/ru/md/Telegram/Administration/Unban.md +++ b/docs/ru/md/Telegram/Administration/Unban.md @@ -6,6 +6,11 @@ sidebar_position: 2 Разбанивает забаненного ранее пользователя + + +
+ + *Функция Разбан(Знач Токен, Знач IDЧата, Знач IDПользователя) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDПользователя = "461699897"; IDКанала = "@testsichee"; Результат = OPI_Telegram.Разбан(Токен, IDКанала, IDПользователя); - ``` + + ```sh title="Пример команды CLI" @@ -33,13 +39,10 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": false, "error_code": 400, "description": "Bad Request: can't remove chat owner" } - ``` diff --git a/docs/ru/md/Telegram/Administration/Unpin-message.md b/docs/ru/md/Telegram/Administration/Unpin-message.md index 2b89a5f847..a20be8caa2 100644 --- a/docs/ru/md/Telegram/Administration/Unpin-message.md +++ b/docs/ru/md/Telegram/Administration/Unpin-message.md @@ -6,6 +6,11 @@ sidebar_position: 5 Открепляет сообщение в шапке чата + + +
+ + *Функция ОткрепитьСообщение(Знач Токен, Знач IDЧата, Знач IDСообщения) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDКанала = "@testsichee"; IDСообщения = "4951"; Результат = OPI_Telegram.ОткрепитьСообщение(Токен, IDКанала, IDСообщения); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md index ef487c0b9d..21265d7795 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Delete-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет URL обработчика событий бота для работы в режиме Webhook + + +
+ + *Функция УдалитьWebhook(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,12 +20,13 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Результат = OPI_Telegram.УдалитьWebhook(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -28,13 +34,10 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true, "description": "Webhook was deleted" } - ``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md index 1da4e564ec..78da161811 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 5 Скачивает файл с серверов Telegram + + +
+ + *Функция СкачатьФайл(Знач Токен, Знач IDФайла) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 5 Возвращаемое значение: ДвоичныеДанные - данные файла + ```bsl title="Пример кода" - IDФайла = "AgACAgIAAx0EcNsaZQACE1lmXraQ7CsFNZ2Jrqimp9A0ir3mQQACmtkxG77-sUoMcnd_RvALsgEAAwIAA3MAAzUE"; Токен = "6129457865:AAFyzNYOAFbu..."; Результат = OPI_Telegram.СкачатьФайл(Токен, IDФайла); - ``` + + ```sh title="Пример команды CLI" @@ -31,9 +37,6 @@ sidebar_position: 5 ``` - ```json title="Результат" - <Двоичные данные файла> - ``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md index ce43a79504..f4405f0591 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-bot-information.md @@ -3,7 +3,12 @@ sidebar_position: 1 --- # Получить информацию о боте -Выполняет запрос getMe, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. + Выполняет запрос /getMe, возвращающий базовую информацию о боте: имя, id, возможность добавлять бота в группы и т.д. + + + + +
*Функция ПолучитьИнформациюБота(Знач Токен) Экспорт* @@ -15,12 +20,13 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Результат = OPI_Telegram.ПолучитьИнформациюБота(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -28,10 +34,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "id": 6129457865, @@ -44,5 +48,4 @@ sidebar_position: 1 "can_connect_to_business": false } } - ``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md index c518826604..f18b4e9f7b 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Get-updates.md @@ -3,7 +3,12 @@ sidebar_position: 2 --- # Получить обновления -Выполняет запрос getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме + Выполняет запрос /getUpdates, возвращающий информацию о событиях бота. Используется при работе в polling режиме + + + + +
*Функция ПолучитьОбновления(Знач Токен, Знач Таймаут = 0, Знач Смещение = "") Экспорт* @@ -17,12 +22,13 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Результат = OPI_Telegram.ПолучитьОбновления(Токен); - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "result": [ { @@ -360,5 +364,4 @@ sidebar_position: 2 } ] } - ``` diff --git a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md index 3413753d54..f639633688 100644 --- a/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md +++ b/docs/ru/md/Telegram/Data-retrieval-and-settings/Set-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 3 Устанавливает URL обработчика событий бота для работы в режиме Webhook + + +
+ + *Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; URL = "https://api.athenaeum.digital/opi/hs/twitter"; Результат = OPI_Telegram.УстановитьWebhook(Токен, URL); - ``` + + ```sh title="Пример команды CLI" @@ -31,13 +37,10 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true, "description": "Webhook was set" } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md b/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md index c85d17a308..cdbd4ab038 100644 --- a/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md +++ b/docs/ru/md/Telegram/Data-sending/Form-keyboard-from-button-array.md @@ -6,6 +6,11 @@ sidebar_position: 12 Формирует простую JSON клавиатуру из массив кнопок для сообщения или нижней панели + + +
+ + *Функция СформироватьКлавиатуруПоМассивуКнопок(Знач МассивКнопок, Знач ПодСообщением = Ложь, Знач ОднаПодОдной = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 12 Возвращаемое значение: Строка - JSON клавиатуры + ```bsl title="Пример кода" - МассивКнопок = Новый Массив; МассивКнопок.Добавить("Отлично"); @@ -27,8 +32,9 @@ sidebar_position: 12 Клавиатура = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок, Истина, Истина); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 12 ``` - ```json title="Результат" - -{ + { "inline_keyboard":[ [ { @@ -62,5 +66,4 @@ sidebar_position: 12 ], "rows":1 } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Forward-message.md b/docs/ru/md/Telegram/Data-sending/Forward-message.md index ee8126c9cd..a37fc1efb6 100644 --- a/docs/ru/md/Telegram/Data-sending/Forward-message.md +++ b/docs/ru/md/Telegram/Data-sending/Forward-message.md @@ -6,6 +6,11 @@ sidebar_position: 11 Пересылает сообщение между чатами или в рамках одного чата + + +
+ + *Функция ПереслатьСообщение(Знач Токен, Знач IDОригинала, Знач ОткудаID, Знач КудаID) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,16 +23,17 @@ sidebar_position: 11 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; IDСообщения = "4951"; Результат = OPI_Telegram.ПереслатьСообщение(Токен, IDСообщения, IDКанала, IDЧата); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 11 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4649, @@ -78,5 +82,4 @@ sidebar_position: 11 "text": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-audio.md b/docs/ru/md/Telegram/Data-sending/Send-audio.md index d559d05d05..0549dfb3d3 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-audio.md +++ b/docs/ru/md/Telegram/Data-sending/Send-audio.md @@ -6,6 +6,11 @@ sidebar_position: 4 Отправляет аудиофайл в чат или канал + + +
+ + *Функция ОтправитьАудио(Знач Токен, Знач IDЧата, Знач Текст, Знач Аудио, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 4 Результат = OPI_Telegram.ОтправитьАудио(Токен, IDЧата, Текст, Аудио); Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоПуть); Результат = OPI_Telegram.ОтправитьАудио(Токен, IDКанала, Текст, АудиоДД); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4641, @@ -79,5 +83,4 @@ sidebar_position: 4 "caption": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-contact.md b/docs/ru/md/Telegram/Data-sending/Send-contact.md index 9224695a92..d703522301 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-contact.md +++ b/docs/ru/md/Telegram/Data-sending/Send-contact.md @@ -6,6 +6,11 @@ sidebar_position: 9 Отправляет контакт с именем и номером телефона + + +
+ + *Функция ОтправитьКонтакт(Знач Токен, Знач IDЧата, Знач Имя, Знач Фамилия, Знач Телефон, Знач Клавиатура = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -31,8 +36,9 @@ sidebar_position: 9 Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDЧата , Имя, Фамилия, Телефон); Результат = OPI_Telegram.ОтправитьКонтакт(Токен, IDКанала, Имя, Фамилия, Телефон); - ``` + + ```sh title="Пример команды CLI" @@ -40,10 +46,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4647, @@ -68,5 +72,4 @@ sidebar_position: 9 } } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-document.md b/docs/ru/md/Telegram/Data-sending/Send-document.md index 2f44ce9cee..441a986206 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-document.md +++ b/docs/ru/md/Telegram/Data-sending/Send-document.md @@ -6,6 +6,11 @@ sidebar_position: 5 Отправляет документ в чат или канал + + +
+ + *Функция ОтправитьДокумент(Знач Токен, Знач IDЧата, Знач Текст, Знач Документ, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 5 Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDЧата, Текст, Документ); Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументПуть); Результат = OPI_Telegram.ОтправитьДокумент(Токен, IDКанала, Текст, ДокументДД); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4642, @@ -76,5 +80,4 @@ sidebar_position: 5 "caption": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-gif.md b/docs/ru/md/Telegram/Data-sending/Send-gif.md index 9027fa8429..9b88788fdd 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-gif.md +++ b/docs/ru/md/Telegram/Data-sending/Send-gif.md @@ -6,6 +6,11 @@ sidebar_position: 6 Отправляет гифку в чат или канал + + +
+ + *Функция ОтправитьГифку(Знач Токен, Знач IDЧата, Знач Текст, Знач Гифка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 6 Результат = OPI_Telegram.ОтправитьГифку(Токен, IDЧата, Текст, Гифка); Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаПуть); Результат = OPI_Telegram.ОтправитьГифку(Токен, IDКанала, Текст, ГифкаДД); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4643, @@ -114,5 +118,4 @@ sidebar_position: 6 "caption": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-image.md b/docs/ru/md/Telegram/Data-sending/Send-image.md index da1a346efc..4eab6cc1a9 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-image.md +++ b/docs/ru/md/Telegram/Data-sending/Send-image.md @@ -6,6 +6,11 @@ sidebar_position: 2 Отправляет картинку в чат или канал + + +
+ + *Функция ОтправитьКартинку(Знач Токен, Знач IDЧата, Знач Текст, Знач Картинка, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 2 Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаПуть); Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDКанала, Текст, КартинкаДД); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4639, @@ -106,5 +110,4 @@ sidebar_position: 2 "caption": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-location.md b/docs/ru/md/Telegram/Data-sending/Send-location.md index 6f03fdb4e7..135abbb69a 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-location.md +++ b/docs/ru/md/Telegram/Data-sending/Send-location.md @@ -6,6 +6,11 @@ sidebar_position: 8 Отправляет местоположение по географической широте и долготе в чат или канал + + +
+ + *Функция ОтправитьМестоположение(Знач Токен, Знач IDЧата, Знач Широта, Знач Долгота, Знач Клавиатура = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -29,8 +34,9 @@ sidebar_position: 8 Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDЧата, Ширина, Долгота); Результат = OPI_Telegram.ОтправитьМестоположение(Токен, IDКанала, Ширина, Долгота); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4646, @@ -65,5 +69,4 @@ sidebar_position: 8 } } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-media-group.md b/docs/ru/md/Telegram/Data-sending/Send-media-group.md index d371fa61ff..cf8635e767 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-media-group.md +++ b/docs/ru/md/Telegram/Data-sending/Send-media-group.md @@ -6,6 +6,11 @@ sidebar_position: 7 Отправляет набор файлов в чат или канал. Варианты типов медиа: audio, document, photo, video + + +
+ + *Функция ОтправитьМедиагруппу(Знач Токен, Знач IDЧата, Знач Текст, Знач СоответствиеФайлов, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ"; Описание = "Группа картинок"; @@ -32,8 +37,9 @@ sidebar_position: 7 Ответ = OPI_Telegram.ОтправитьМедиагруппу(Токен, 1234567890, Описание, СоответствиеФайлов); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ_); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "ok": true, "result": [ { @@ -147,5 +151,4 @@ sidebar_position: 7 } ] } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-poll.md b/docs/ru/md/Telegram/Data-sending/Send-poll.md index f4f369d876..89ba125e60 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-poll.md +++ b/docs/ru/md/Telegram/Data-sending/Send-poll.md @@ -6,6 +6,11 @@ sidebar_position: 10 Отправляет опрос с вариантами ответа + + +
+ + *Функция ОтправитьОпрос(Знач Токен, Знач IDЧата, Знач Вопрос, Знач МассивОтветов, Знач Анонимный = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -34,8 +39,9 @@ sidebar_position: 10 Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDЧата , Вопрос, МассивОтветов, Ложь); Результат = OPI_Telegram.ОтправитьОпрос(Токен, IDКанала, Вопрос, МассивОтветов, Истина); - ``` + + ```sh title="Пример команды CLI" @@ -43,10 +49,8 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4648, @@ -93,5 +97,4 @@ sidebar_position: 10 } } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-text-message.md b/docs/ru/md/Telegram/Data-sending/Send-text-message.md index 24044c6c29..dff862998b 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-text-message.md +++ b/docs/ru/md/Telegram/Data-sending/Send-text-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Отправляет текстовое сообщение в чат или канал + + +
+ + *Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач IDЧата, Знач Текст, Знач Клавиатура = "", Знач Разметка = "Markdown", Знач IDВходящего = 0) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -29,8 +34,9 @@ sidebar_position: 1 Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст); Результат = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDКанала, Текст); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4638, @@ -62,5 +66,4 @@ sidebar_position: 1 "text": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Data-sending/Send-video.md b/docs/ru/md/Telegram/Data-sending/Send-video.md index 4443770e9b..b8f21bfd55 100644 --- a/docs/ru/md/Telegram/Data-sending/Send-video.md +++ b/docs/ru/md/Telegram/Data-sending/Send-video.md @@ -6,6 +6,11 @@ sidebar_position: 3 Отправляет видео в чат или канал + + +
+ + *Функция ОтправитьВидео(Знач Токен, Знач IDЧата, Знач Текст, Знач Видео, Знач Клавиатура = "", Знач Разметка = "Markdown") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; IDЧата = "461699897"; IDКанала = "@testsichee"; @@ -36,8 +41,9 @@ sidebar_position: 3 Результат = OPI_Telegram.ОтправитьВидео(Токен, IDЧата, Текст, Видео); Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоПуть); Результат = OPI_Telegram.ОтправитьВидео(Токен, IDКанала, Текст, ВидеоДД); - ``` + + ```sh title="Пример команды CLI" @@ -45,10 +51,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_id": 4640, @@ -93,5 +97,4 @@ sidebar_position: 3 "caption": "Строковое значение" } } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md b/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md index 020a802375..3114d85332 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Clear-thread-pinned-messages-list.md @@ -6,6 +6,11 @@ sidebar_position: 10 Очищает список закрепленных сообщений в теме форума + + +
+ + *Функция ОчиститьСписокЗакрепленныхСообщенийТемы(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Тема = "2673"; Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат); Результат = OPI_Telegram.ОчиститьСписокЗакрепленныхСообщенийТемы(Токен, Чат, Тема); - ``` + + ```sh title="Пример команды CLI" @@ -34,12 +40,9 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md index 6fdc5450f5..b4a9a7e748 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Close-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 4 Закрывает тему для новых сообщений + + +
+ + *Функция ЗакрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Тема = "2673"; Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат); // Закрывает главную тему Результат = OPI_Telegram.ЗакрытьТемуФорума(Токен, Чат, Тема); - ``` + + ```sh title="Пример команды CLI" @@ -34,12 +40,9 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md index b84f49d5b6..02da7a7802 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Create-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает новую тему в группе с включенным функционалом тем + + +
+ + *Функция СоздатьТемуФорума(Знач Токен, Знач IDЧата, Знач Заголовок, Знач IDИконки = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,16 +23,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Иконка = "5357419403325481346"; Имя = "Тестовая тема " + Строка(Новый УникальныйИдентификатор); Результат = OPI_Telegram.СоздатьТемуФорума(Токен, Чат, Имя, Иконка); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "ok": true, "result": { "message_thread_id": 2457, @@ -47,5 +51,4 @@ sidebar_position: 2 "icon_custom_emoji_id": "5357419403325481346" } } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md index 1a83281b8e..9be377061b 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Delete-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 6 Удаляет тему форума + + +
+ + *Функция УдалитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Тема = "2673"; Результат = OPI_Telegram.УдалитьТемуФорума(Токен, Чат, Тема); - ``` + + ```sh title="Пример команды CLI" @@ -33,12 +39,9 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md index acd9349374..ab9670be97 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Edit-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает новую тему в группе с включенным функционалом тем + + +
+ + *Функция ИзменитьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы, Знач Заголовок = Неопределено, Знач IDИконки = Неопределено) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Тема = "2673"; @@ -28,8 +33,9 @@ sidebar_position: 3 НовяИконка = "5310132165583840589"; Результат = OPI_Telegram.ИзменитьТемуФорума(Токен, Чат, Тема, НовоеИмя, НовяИконка); - ``` + + ```sh title="Пример команды CLI" @@ -37,12 +43,9 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md b/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md index ac08a1a886..393e9e1d1d 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Edit-main-forum-topic-name.md @@ -6,6 +6,11 @@ sidebar_position: 9 Изменяет имя главной темы форума + + +
+ + *Функция ИзменитьИмяГлавнойТемыФорума(Знач Токен, Знач IDЧата, Знач Заголовок) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Заголовок = "Новое имя главной темы " + Строка(Новый УникальныйИдентификатор); Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Результат = OPI_Telegram.ИзменитьИмяГлавнойТемыФорума(Токен, Чат, Заголовок); - ``` + + ```sh title="Пример команды CLI" @@ -32,12 +38,9 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md b/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md index d3389babd0..95ec4ce725 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Get-avatar-icon-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает соответствие ID Emoji для установки в качестве иконок тем форума + + +
+ + *Функция ПолучитьСписокИконокАватаров(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - Ключ > ID, Значение > Emoji + ```bsl title="Пример кода" - Ответ = ПолучитьСписокИконокАватаров("6129457325:BWDF..."); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "5434144690511290129": "📰", "5312536423851630001": "💡", "5312016608254762256": "⚡️", @@ -147,5 +151,4 @@ sidebar_position: 1 "5237999392438371490": "🦮", "5235912661102773458": "🐈" } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md index 256beea221..60f5e683c2 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Hide-main-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 7 Скрывает главную тему форума + + +
+ + *Функция СкрытьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Результат = OPI_Telegram.СкрытьГлавнуюТемуФорума(Токен, Чат); - ``` + + ```sh title="Пример команды CLI" @@ -31,12 +37,9 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md index 014537f69e..a00ad6788b 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Open-forum-thread.md @@ -6,6 +6,11 @@ sidebar_position: 5 Повторно открывает ранее закрытую тему форума + + +
+ + *Функция ОткрытьТемуФорума(Знач Токен, Знач IDЧата, Знач IDТемы = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Тема = "2673"; Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат); // Открывает главную тему Результат = OPI_Telegram.ОткрытьТемуФорума(Токен, Чат, Тема); - ``` + + ```sh title="Пример команды CLI" @@ -34,12 +40,9 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md b/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md index 6d41b819bd..73c5660def 100644 --- a/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md +++ b/docs/ru/md/Telegram/Forum-topic-management/Show-main-forum-topic.md @@ -6,6 +6,11 @@ sidebar_position: 8 Показывает ранее скрытую главную тему форума + + +
+ + *Функция ПоказатьГлавнуюТемуФорума(Знач Токен, Знач IDЧата) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram + ```bsl title="Пример кода" - Токен = "6129457865:AAFyzNYOAFbu..."; Чат = "-1001971186208"; Результат = OPI_Telegram.ПоказатьГлавнуюТемуФорума(Токен, Чат); - ``` + + ```sh title="Пример команды CLI" @@ -31,12 +37,9 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "ok": true, "result": true } - ``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md index c1e1aa12ce..0eb27922ab 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md +++ b/docs/ru/md/Twitter/Data-and-settings/Get-authorization-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Формирует ссылку для авторизации через браузер + + +
+ + *Функция ПолучитьСсылкуАвторизации(Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,13 +20,14 @@ sidebar_position: 1 Возвращаемое значение: Строка - URL для перехода в браузере + ```bsl title="Пример кода" - Ответ = OPI_Twitter.ПолучитьСсылкуАвторизации(Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -29,9 +35,6 @@ sidebar_position: 1 ``` - ```json title="Результат" - -"https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" - + "https://twitter.com/i/oauth2/authorize?response_type=code&client_id=ZG1vSmxlVTJXYi05M2c0ek9iV246MTpjaQ&redirect_uri=https%3A%2F%2Fapi.athenaeum.digital%2Fopi%2Fhs%2Ftwitter&scope=tweet.read%20tweet.write%20tweet.moderate.write%20users.read%20follows.read%20follows.write%20offline.access%20space.read%20mute.read%20mute.write%20like.read%20like.write%20list.read%20list.write%20block.read%20block.write%20bookmark.read%20bookmark.write&state=state&code_challenge=challenge&code_challenge_method=plain" ``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Get-token.md b/docs/ru/md/Twitter/Data-and-settings/Get-token.md index 58f012671d..fb80c2a2cc 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Get-token.md +++ b/docs/ru/md/Twitter/Data-and-settings/Get-token.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации + + +
+ + *Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - Ответ = OPI_Twitter.ПолучитьТокен(Код, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,15 +37,12 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", "expires_in": 7200, "token_type": "bearer" } - ``` diff --git a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md index 9c7bf55314..a0633154c2 100644 --- a/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md +++ b/docs/ru/md/Twitter/Data-and-settings/Refresh-token.md @@ -6,6 +6,11 @@ sidebar_position: 3 Обновляет v2 токен при помощи refresh_token + + +
+ + *Функция ОбновитьТокен(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,8 +20,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - Ответ = OPI_Twitter.ОбновитьТокен(Параметры); Константы.TwitterToken.Установить(Ответ["access_token"]); @@ -24,8 +29,9 @@ sidebar_position: 3 Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -33,15 +39,12 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "refresh_token": "TmttM11111111111111111MY2dkNy1EZklLNmxIT1111111111111111xNTg2ODI6MTowOnJ0OjE", "access_token": "UTBtWXd11111111111111111111113TkRxWEdxdF9hVlQzOjE3MDUwNTMxNTg2ODE6MTowOmF0OjE", "scope": "mute.write tweet.moderate.write block.read follows.read offline.access list.write bookmark.read list.read tweet.write space.read block.write like.write like.read users.read tweet.read bookmark.write mute.read follows.write", "expires_in": 7200, "token_type": "bearer" } - ``` diff --git a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md index 153cc4f748..a48ac50962 100644 --- a/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-gif-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает твит с вложением-гифкой + + +
+ + *Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - МассивКартинок = Новый Массив; МассивКартинок.Добавить("C:\1.gif"); @@ -27,8 +32,9 @@ sidebar_position: 3 Ответ = OPI_Twitter.СоздатьТвитГифки("Гифки", МассивКартинок, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "data": { "text": "Природа https://t.co/VWkWU11111", "id": "1746086669499924991", @@ -48,5 +52,4 @@ sidebar_position: 3 ] } } - ``` diff --git a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md b/docs/ru/md/Twitter/Tweets/Create-image-tweet.md index 53e618419e..1c7e9f8b8c 100644 --- a/docs/ru/md/Twitter/Tweets/Create-image-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-image-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает твит с картинкой вложением + + +
+ + *Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - МассивКартинок = Новый Массив; МассивКартинок.Добавить("C:\logo.png"); @@ -27,8 +32,9 @@ sidebar_position: 2 Ответ = OPI_Twitter.СоздатьТвитКартинки("Альпака", МассивКартинок, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "data": { "text": "Альпака https://t.co/OodoWT1AAA", "id": "1745753004542726629", @@ -48,5 +52,4 @@ sidebar_position: 2 ] } } - ``` diff --git a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md index 60aa602817..e7be57f47c 100644 --- a/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-poll-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает твит с опросом + + +
+ + *Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - МассивВариантов = Новый Массив; МассивВариантов.Добавить("Хорошо"); @@ -29,8 +34,9 @@ sidebar_position: 5 Ответ = OPI_Twitter.СоздатьТвитОпрос("Как дела?", МассивВариантов, 60, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "data": { "text": "Как дела?", "id": "1746082302268969388", @@ -50,5 +54,4 @@ sidebar_position: 5 ] } } - ``` diff --git a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md b/docs/ru/md/Twitter/Tweets/Create-text-tweet.md index 14ba855494..7e53850b74 100644 --- a/docs/ru/md/Twitter/Tweets/Create-text-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-text-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает твит без вложений + + +
+ + *Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") ЭкспортВозврат СоздатьПроизвольныйТвит(Текст, , , , Параметры);КонецФункции* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - Ответ = OPI_Twitter.СоздатьТекстовыйТвит("Обычный текстовый твит", Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "data": { "text": "Обычный текстовый твит", "id": "1745752006310895822", @@ -43,5 +47,4 @@ sidebar_position: 1 ] } } - ``` diff --git a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md b/docs/ru/md/Twitter/Tweets/Create-video-tweet.md index 6dcff3775f..f07c64259b 100644 --- a/docs/ru/md/Twitter/Tweets/Create-video-tweet.md +++ b/docs/ru/md/Twitter/Tweets/Create-video-tweet.md @@ -6,6 +6,11 @@ sidebar_position: 4 Создает твит с видеовложением + + +
+ + *Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter + ```bsl title="Пример кода" - МассивКартинок = Новый Массив; МассивКартинок.Добавить("C:\1.mp4"); @@ -27,8 +32,9 @@ sidebar_position: 4 Ответ = OPI_Twitter.СоздатьТвитВидео("Природа", МассивКартинок, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "data": { "text": "Альпака https://t.co/OodoWT1AAA", "id": "1745753004542726629", @@ -48,5 +52,4 @@ sidebar_position: 4 ] } } - ``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-ad.md b/docs/ru/md/VK/Ad-account-management/Create-ad.md index 326d06282a..045d9f824d 100644 --- a/docs/ru/md/VK/Ad-account-management/Create-ad.md +++ b/docs/ru/md/VK/Ad-account-management/Create-ad.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает рекламное объявление на основе поста + + +
+ + *Функция СоздатьРекламноеОбъявление(Знач НомерКампании, Знач ДневнойЛимит, Знач НомерКатегории, Знач IDПоста, Знач IDКабинета, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,14 +25,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.СоздатьРекламноеОбъявление(1029683999, 166, 126, 221, 1607951446, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -35,15 +41,12 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "response": [ { "id": 171372386 } ] } - ``` diff --git a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md index 0ed1e3bfe9..3d751d1eed 100644 --- a/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md +++ b/docs/ru/md/VK/Ad-account-management/Create-advertising-campaign.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает кампанию в выбранном рекламном кабинете + + +
+ + *Функция СоздатьРекламнуюКампанию(Знач IDКабинета, Знач Наименование, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.СоздатьРекламнуюКампанию(1234567890, "Новая рекламная кампания", Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,15 +38,12 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "response": [ { "id": 1029701085 } ] } - ``` diff --git a/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md b/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md index 871f39bf72..0f2faf2661 100644 --- a/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md +++ b/docs/ru/md/VK/Ad-account-management/Get-advertising-category-list.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает список id рекламных категорий для создания рекламного объявления + + +
+ + *Функция ПолучитьСписокРекламныхКатегорий(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСписокРекламныхКатегорий(Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": { "v2": [ { @@ -64,5 +68,4 @@ sidebar_position: 4 ] } } - ``` 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 efa549cb07..076713830d 100644 --- a/docs/ru/md/VK/Ad-account-management/Pause-advertising.md +++ b/docs/ru/md/VK/Ad-account-management/Pause-advertising.md @@ -6,6 +6,11 @@ sidebar_position: 3 Приостанавливает показ рекламного объявления + + +
+ + *Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПриостановитьРекламноеОбъявление(1234567890, 1029701085, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,15 +38,12 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": [ { "id": 1029701085 } ] } - ``` diff --git a/docs/ru/md/VK/Community-managment/Create-album.md b/docs/ru/md/VK/Community-managment/Create-album.md index c5895e7534..772ffd8bcd 100644 --- a/docs/ru/md/VK/Community-managment/Create-album.md +++ b/docs/ru/md/VK/Community-managment/Create-album.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает альбом для хранения картинок + + +
+ + *Функция СоздатьАльбом(Знач Наименование, Знач Описание = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Имя = "Альбом из автотеста"; Описание = "Новый альбом из автотеста"; Результат = OPI_VK.СоздатьАльбом(Имя, Описание, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "response": { "id": 304498513, "owner_id": -218861756, @@ -53,5 +57,4 @@ sidebar_position: 5 "upload_by_admins_only": 1 } } - ``` diff --git a/docs/ru/md/VK/Community-managment/Create-composite-post.md b/docs/ru/md/VK/Community-managment/Create-composite-post.md index 809c227203..c8cf4570ed 100644 --- a/docs/ru/md/VK/Community-managment/Create-composite-post.md +++ b/docs/ru/md/VK/Community-managment/Create-composite-post.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает пост на основе массива идетификаторов объектов (картинок, видео и др.) + + +
+ + *Функция СоздатьСоставнойПост(Знач Текст, Знач Объекты, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Текст = "Пост из автотеста"; URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -45,8 +50,9 @@ sidebar_position: 2 МассивВложений.Добавить("video" + ВладелецВидео + "_" + IDВидео); Результат = OPI_VK.СоздатьСоставнойПост(Текст, МассивВложений, Ложь, URL, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -54,13 +60,10 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "response": { "post_id": 2126 } } - ``` diff --git a/docs/ru/md/VK/Community-managment/Create-poll.md b/docs/ru/md/VK/Community-managment/Create-poll.md index f74d3ffcdc..625db8a325 100644 --- a/docs/ru/md/VK/Community-managment/Create-poll.md +++ b/docs/ru/md/VK/Community-managment/Create-poll.md @@ -6,6 +6,11 @@ sidebar_position: 4 Создает опрос с вариантами ответа + + +
+ + *Функция СоздатьОпрос(Знач Вопрос, Знач МассивОтветов, Знач Картинка = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Вопрос = "Какой ваш любимый цвет?"; @@ -29,8 +34,9 @@ sidebar_position: 4 МассивВариантов.Добавить("Зеленый"); Результат = OPI_VK.СоздатьОпрос(Вопрос, МассивВариантов, , Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -38,13 +44,10 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": { "post_id": 2127 } } - ``` diff --git a/docs/ru/md/VK/Community-managment/Create-post.md b/docs/ru/md/VK/Community-managment/Create-post.md index 06c409db86..89367ae2d7 100644 --- a/docs/ru/md/VK/Community-managment/Create-post.md +++ b/docs/ru/md/VK/Community-managment/Create-post.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает пост с картинками + + +
+ + *Функция СоздатьПост(Знач Текст, Знач МассивКартинок, Знач Реклама = Ложь, Знач СсылкаПодЗаписью = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Текст = "Пост из автотеста"; URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -37,8 +42,9 @@ sidebar_position: 1 Результат = OPI_VK.СоздатьПост(Текст, МассивКартинок, Истина, URL, Параметры); Результат = OPI_VK.СоздатьПост(Текст, Картинка, Ложь , , Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -46,13 +52,10 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "response": { "post_id": 2123 } } - ``` diff --git a/docs/ru/md/VK/Community-managment/Create-story.md b/docs/ru/md/VK/Community-managment/Create-story.md index 7c5fb2306b..058e3f4991 100644 --- a/docs/ru/md/VK/Community-managment/Create-story.md +++ b/docs/ru/md/VK/Community-managment/Create-story.md @@ -6,6 +6,11 @@ sidebar_position: 7 Создает историю из картинки + + +
+ + *Функция СоздатьИсторию(Знач Картинка, Знач URL = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); URL = "https://github.com/Bayselonarrend/OpenIntegrations"; @@ -29,8 +34,9 @@ sidebar_position: 7 Результат = OPI_VK.СоздатьИсторию(Картинка , URL, Параметры); Результат = OPI_VK.СоздатьИсторию(ИВФ, , Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -38,10 +44,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "response": { "count": 1, "items": [ @@ -134,5 +138,4 @@ sidebar_position: 7 ] } } - ``` diff --git a/docs/ru/md/VK/Community-managment/Delete-album.md b/docs/ru/md/VK/Community-managment/Delete-album.md index 4d757e8a57..6395c91687 100644 --- a/docs/ru/md/VK/Community-managment/Delete-album.md +++ b/docs/ru/md/VK/Community-managment/Delete-album.md @@ -6,6 +6,11 @@ sidebar_position: 6 Удаляет ранее созданный альбом + + +
+ + *Функция УдалитьАльбом(Знач IDАльбома, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДАльбома = "304549394"; Результат = OPI_VK.УдалитьАльбом(ИДАльбома, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Community-managment/Delete-image.md b/docs/ru/md/VK/Community-managment/Delete-image.md index 76f11c0967..058f866562 100644 --- a/docs/ru/md/VK/Community-managment/Delete-image.md +++ b/docs/ru/md/VK/Community-managment/Delete-image.md @@ -6,6 +6,11 @@ sidebar_position: 9 Удалить картинку из альбома + + +
+ + *Функция УдалитьКартинку(Знач IDКартинки, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДКартинки = "457244340"; Результат = OPI_VK.УдалитьКартинку(ИДКартинки, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Community-managment/Delete-post.md b/docs/ru/md/VK/Community-managment/Delete-post.md index 297280ee5f..edf9dda4d0 100644 --- a/docs/ru/md/VK/Community-managment/Delete-post.md +++ b/docs/ru/md/VK/Community-managment/Delete-post.md @@ -6,6 +6,11 @@ sidebar_position: 3 Удаляет пост по id + + +
+ + *Функция УдалитьПост(Знач IDПоста, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДПоста = "2304"; Результат = OPI_VK.УдалитьПост(ИДПоста, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Community-managment/Save-image-to-album.md b/docs/ru/md/VK/Community-managment/Save-image-to-album.md index 5b8e28406d..0001c4b2c1 100644 --- a/docs/ru/md/VK/Community-managment/Save-image-to-album.md +++ b/docs/ru/md/VK/Community-managment/Save-image-to-album.md @@ -6,6 +6,11 @@ sidebar_position: 8 Сохраняет картинку в альбом сообщества + + +
+ + *Функция СохранитьКартинкуВАльбом(Знач IDАльбома, Знач Картинка, Знач Описание = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ОписаниеКартинки = "Картинка автотест"; ИДАльбома = "304549394"; @@ -32,8 +37,9 @@ sidebar_position: 8 Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, Картинка, ОписаниеКартинки, Параметры); Результат = OPI_VK.СохранитьКартинкуВАльбом(ИДАльбома, ИВФ, ОписаниеКартинки, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -41,10 +47,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "response": [ { "album_id": 304498513, @@ -120,5 +124,4 @@ sidebar_position: 8 } ] } - ``` diff --git a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md index 62975fbd9c..b9546b434e 100644 --- a/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md +++ b/docs/ru/md/VK/Community-managment/Upload-photo-to-server.md @@ -6,6 +6,11 @@ sidebar_position: 11 Загружает фото на сервер для его дальнейшего использования + + +
+ + *Функция ЗагрузитьФотоНаСервер(Знач Картинка, Знач Параметры = "", Знач Вид = "Пост") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 11 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Картинка = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные ИВФ = ПолучитьИмяВременногоФайла("png"); @@ -26,8 +31,9 @@ sidebar_position: 11 ЗагрузкаКартинки = OPI_VK.ЗагрузитьФотоНаСервер(Картинка, Параметры); ЗагрузкаКартинки = OPI_VK.ЗагрузитьФотоНаСервер(ИВФ, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -35,9 +41,7 @@ sidebar_position: 11 ``` - ```json title="Результат" - { "response":[ { @@ -51,5 +55,4 @@ sidebar_position: 11 } ] } - ``` diff --git a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md b/docs/ru/md/VK/Community-managment/Upload-video-to-server.md index f512515812..185445618e 100644 --- a/docs/ru/md/VK/Community-managment/Upload-video-to-server.md +++ b/docs/ru/md/VK/Community-managment/Upload-video-to-server.md @@ -6,6 +6,11 @@ sidebar_position: 10 Загружает видео в группу с возможностью его дальнейшего использования + + +
+ + *Функция ЗагрузитьВидеоНаСервер(Знач Видео, Знач Наименование, Знач Описание = "", Знач Альбом = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,16 +24,17 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Видео = "C:/nature.mp4"; Наименование = "Новое видео"; Описание = "Описание видео"; Результат = OPI_VK.ЗагрузитьВидеоНаСервер(Видео, Наименование, Описание, , Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -36,15 +42,12 @@ sidebar_position: 10 ``` - ```json title="Результат" - -{ + { "video_hash": "a833866c6db82314f7", "size": 1137878, "direct_link": "https://vkvd124.mycdn.me/?expires=1718104740308&srcIp=20.172.5.93&pr=40&srcAg=UNKNOWN&ms=185.226.53.168&type=4&sig=bcm4dKyuOlo&ct=27&urls=45.136.20.202&clientType=14&appId=512000384397&zs=43&id=6569231256185", "owner_id": -218861756, "video_id": 456239138 } - ``` diff --git a/docs/ru/md/VK/Discussion-management/Close-discussion.md b/docs/ru/md/VK/Discussion-management/Close-discussion.md index 03f1faf8db..629549004c 100644 --- a/docs/ru/md/VK/Discussion-management/Close-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Close-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 2 Закрывает или удаляет обсуждение + + +
+ + *Функция ЗакрытьОбсуждение(Знач IDОбсуждения, Знач УдалитьПолностью = Ложь, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,13 +22,14 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДОбсуждения = "51206275"; Результат = OPI_VK.ЗакрытьОбсуждение(ИДОбсуждения, Ложь, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Discussion-management/Create-discussion.md b/docs/ru/md/VK/Discussion-management/Create-discussion.md index 33680f9a30..e1b25fd614 100644 --- a/docs/ru/md/VK/Discussion-management/Create-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Create-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 1 Создает новое обсуждение + + +
+ + *Функция СоздатьОбсуждение(Знач Наименование, Знач ТекстПервогоСообщения, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Название = "Обсуждаем: какой цвет лучше?"; Сообщение = "Красный, желтый, синий или какой-то другой?"; Результат = OPI_VK.СоздатьОбсуждение(Название, Сообщение, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "response": 51182455 } - ``` diff --git a/docs/ru/md/VK/Discussion-management/Open-discussion.md b/docs/ru/md/VK/Discussion-management/Open-discussion.md index 5c686b9ab2..b55a20b99e 100644 --- a/docs/ru/md/VK/Discussion-management/Open-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Open-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 3 Открывает ранее закрытое обсуждение + + +
+ + *Функция ОткрытьОбсуждение(Знач IDОбсуждения, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,13 +21,14 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДОбсуждения = "51206275"; Результат = OPI_VK.ОткрытьОбсуждение(ИДОбсуждения, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -30,11 +36,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Discussion-management/Write-in-discussion.md b/docs/ru/md/VK/Discussion-management/Write-in-discussion.md index b10c4ee0ce..d515ff6076 100644 --- a/docs/ru/md/VK/Discussion-management/Write-in-discussion.md +++ b/docs/ru/md/VK/Discussion-management/Write-in-discussion.md @@ -6,6 +6,11 @@ sidebar_position: 4 Добавляет сообщение в обсуждение от имени группы + + +
+ + *Функция НаписатьВОбсуждение(Знач IDОбсуждения, Знач Текст, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,15 +22,16 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); ИДОбсуждения = "51206275"; Сообщение = "Мне больше нравится желтый"; Результат = OPI_VK.НаписатьВОбсуждение(ИДОбсуждения, Сообщение, Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": 705 } - ``` diff --git a/docs/ru/md/VK/Interactive-actions/Like-post.md b/docs/ru/md/VK/Interactive-actions/Like-post.md index 5f4c9d00a3..549c705b63 100644 --- a/docs/ru/md/VK/Interactive-actions/Like-post.md +++ b/docs/ru/md/VK/Interactive-actions/Like-post.md @@ -6,6 +6,11 @@ sidebar_position: 1 Ставит лайк на пост + + +
+ + *Функция ПоставитьЛайк(Знач IDПоста, Знач IDСтены = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПоставитьЛайк(221, ,Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,13 +38,10 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "response": { "likes": 1 } } - ``` diff --git a/docs/ru/md/VK/Interactive-actions/Make-repost.md b/docs/ru/md/VK/Interactive-actions/Make-repost.md index cbe3400798..239e27c910 100644 --- a/docs/ru/md/VK/Interactive-actions/Make-repost.md +++ b/docs/ru/md/VK/Interactive-actions/Make-repost.md @@ -6,6 +6,11 @@ sidebar_position: 2 Делает репост записи + + +
+ + *Функция СделатьРепост(Знач IDПоста, Знач IDСтены = "", Знач ЦелеваяСтена = "", Знач Рекламный = Ложь, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,14 +24,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.СделатьРепост(2571, -218704372, , , Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "response": { "mail_repost_count": 2, "likes_count": 7, @@ -52,5 +56,4 @@ sidebar_position: 2 "success": 1 } } - ``` diff --git a/docs/ru/md/VK/Interactive-actions/Shorten-link.md b/docs/ru/md/VK/Interactive-actions/Shorten-link.md index 13e79feb58..249dd0b663 100644 --- a/docs/ru/md/VK/Interactive-actions/Shorten-link.md +++ b/docs/ru/md/VK/Interactive-actions/Shorten-link.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает сокращенный URL из обычного + + +
+ + *Функция СократитьСсылку(Знач URL, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,13 +21,14 @@ sidebar_position: 5 Возвращаемое значение: Строка - Сокращенный URL + ```bsl title="Пример кода" - Ответ = OPI_VK.СократитьСсылку("https://github.com/Bayselonarrend/OpenIntegrations", Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -30,9 +36,6 @@ sidebar_position: 5 ``` - ```json title="Результат" - -https://vk.cc/ctL1sM - + https://vk.cc/ctL1sM ``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-comment.md b/docs/ru/md/VK/Interactive-actions/Write-comment.md index b68b26d7f4..18b0d2d7dc 100644 --- a/docs/ru/md/VK/Interactive-actions/Write-comment.md +++ b/docs/ru/md/VK/Interactive-actions/Write-comment.md @@ -6,6 +6,11 @@ sidebar_position: 4 Создает комментарий под выбранной записью + + +
+ + *Функция НаписатьКомментарий(Знач IDПоста, Знач IDСтены, Знач Текст, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,14 +23,15 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.НаписатьКомментарий(221, -218861756, "Привет", Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -33,14 +39,11 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": { "parents_stack": [], "comment_id": 229 } } - ``` diff --git a/docs/ru/md/VK/Interactive-actions/Write-message.md b/docs/ru/md/VK/Interactive-actions/Write-message.md index 99d34b71d8..6f80fc0b79 100644 --- a/docs/ru/md/VK/Interactive-actions/Write-message.md +++ b/docs/ru/md/VK/Interactive-actions/Write-message.md @@ -6,6 +6,11 @@ sidebar_position: 3 Написать сообщение пользователю в диалоге сообщества + + +
+ + *Функция НаписатьСообщение(Знач Текст, Знач IDПользователя, Знач Communitytoken, Знач Клавиатура = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,16 +24,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - КТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb..."; Ответ = OPI_VK.НаписатьСообщение("Я бот, а ты нет >:)", 657811122, КТ, , Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,11 +42,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": 7 } - ``` diff --git a/docs/ru/md/VK/Order-management/Get-order-list.md b/docs/ru/md/VK/Order-management/Get-order-list.md index 102676399c..1efa842865 100644 --- a/docs/ru/md/VK/Order-management/Get-order-list.md +++ b/docs/ru/md/VK/Order-management/Get-order-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Возвращает список заказов сообщества + + +
+ + *Функция ПолучитьСписокЗаказов(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,12 +20,13 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Параметры = ПолучитьПараметрыВК(); Результат = OPI_VK.ПолучитьСписокЗаказов(Параметры); - ``` + + ```sh title="Пример команды CLI" @@ -28,10 +34,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -[ + [ { "id": 397209, "group_id": 218861756, @@ -218,5 +222,4 @@ sidebar_position: 1 } } ] - ``` diff --git a/docs/ru/md/VK/Others/Form-keyboard.md b/docs/ru/md/VK/Others/Form-keyboard.md index 99c9f96e7e..d09ab77333 100644 --- a/docs/ru/md/VK/Others/Form-keyboard.md +++ b/docs/ru/md/VK/Others/Form-keyboard.md @@ -6,6 +6,11 @@ sidebar_position: 1 Формирует клавиатуру по массиву кнопок + + +
+ + *Функция СформироватьКлавиатуру(Знач МассивКнопок) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,8 +20,8 @@ sidebar_position: 1 Возвращаемое значение: Строка - JSON клавиатуры + ```bsl title="Пример кода" - МассивКнопок = Новый Массив; МассивКнопок.Добавить("Кнопка 1"); @@ -28,8 +33,9 @@ sidebar_position: 1 Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "buttons": [ [ { @@ -59,5 +63,4 @@ sidebar_position: 1 ], "one_time": false } - ``` diff --git a/docs/ru/md/VK/Product-management/Add-product.md b/docs/ru/md/VK/Product-management/Add-product.md index 60794a92f6..47f4501c6e 100644 --- a/docs/ru/md/VK/Product-management/Add-product.md +++ b/docs/ru/md/VK/Product-management/Add-product.md @@ -6,6 +6,11 @@ sidebar_position: 4 Добавляет новый товар в каталог сообщества + + +
+ + *Функция ДобавитьТовар(Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - МассивКартинок = Новый Массив; МассивКартинок.Добавить(Картинка); @@ -44,8 +49,9 @@ sidebar_position: 4 Ответ = OPI_VK.ДобавитьТовар(Товар, ИДПодборки, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -53,13 +59,10 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": { "market_item_id": 8656047 } } - ``` diff --git a/docs/ru/md/VK/Product-management/Delete-product.md b/docs/ru/md/VK/Product-management/Delete-product.md index 383456e702..c6fd217b04 100644 --- a/docs/ru/md/VK/Product-management/Delete-product.md +++ b/docs/ru/md/VK/Product-management/Delete-product.md @@ -6,6 +6,11 @@ sidebar_position: 6 Удаляет ранее созданный товар + + +
+ + *Функция УдалитьТовар(Знач Товар, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.УдалитьТовар(ИДТовара, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-management/Edit-product.md b/docs/ru/md/VK/Product-management/Edit-product.md index 607c9cca1a..6b48381f7d 100644 --- a/docs/ru/md/VK/Product-management/Edit-product.md +++ b/docs/ru/md/VK/Product-management/Edit-product.md @@ -6,6 +6,11 @@ sidebar_position: 5 Изменяет ранее созданный товар + + +
+ + *Функция ИзменитьТовар(Знач Товар, Знач ОписаниеТовара, Знач Подборка = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Товар = Новый Соответствие; Товар.Вставить("Имя", "Тестовый товар измененный"); @@ -27,8 +32,9 @@ sidebar_position: 5 Ответ = OPI_VK.ИзменитьТовар(ИДТовара, Товар, , Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,11 +42,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-management/Get-product-category-list.md b/docs/ru/md/VK/Product-management/Get-product-category-list.md index 1487bdeba3..f4755dc499 100644 --- a/docs/ru/md/VK/Product-management/Get-product-category-list.md +++ b/docs/ru/md/VK/Product-management/Get-product-category-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список ID товарных категорий для указания при создании товара + + +
+ + *Функция ПолучитьСписокКатегорийТоваров(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,13 +20,14 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из Строка - Ключ - ID, Значение - Имя + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСписокКатегорийТоваров(Параметры); //Соответствие - ``` + + ```sh title="Пример команды CLI" @@ -29,13 +35,10 @@ sidebar_position: 1 ``` - ```json title="Результат" - -Ключ Значение + Ключ Значение 1210 "Деловые услуги" 1200 "Фото- и видеоуслуги" 2162 "Ремонт и строительство" ... - ``` diff --git a/docs/ru/md/VK/Product-management/Get-product-description.md b/docs/ru/md/VK/Product-management/Get-product-description.md index 2f3ed6fd85..9dd79856bd 100644 --- a/docs/ru/md/VK/Product-management/Get-product-description.md +++ b/docs/ru/md/VK/Product-management/Get-product-description.md @@ -6,6 +6,11 @@ sidebar_position: 8 + + +
+ + *Функция ПолучитьОписаниеТовара() Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,11 +20,12 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - Пустое описание товара: + ```bsl title="Пример кода" - Результат = OPI_VK.ПолучитьОписаниеТовара(); - ``` + + ```sh title="Пример команды CLI" @@ -27,10 +33,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -Товар = Новый Соответствие(); + Товар = Новый Соответствие(); Товар.Вставить("Имя" , "Новый товар"); // Имя товара Товар.Вставить("Описание" , "Описание товара"); // Описание товара Товар.Вставить("Категория" , "20173"); // См ПолучитьСписокКатегорийТоваров() @@ -47,5 +51,4 @@ sidebar_position: 8 Товар.Вставить("Вес" , Неопределено); // В граммах Товар.Вставить("SKU" , Неопределено); // Артикул Товар.Вставить("ДоступныйОстаток" , 1); - ``` diff --git a/docs/ru/md/VK/Product-management/Get-product-list.md b/docs/ru/md/VK/Product-management/Get-product-list.md index 67dbf3515f..070f997218 100644 --- a/docs/ru/md/VK/Product-management/Get-product-list.md +++ b/docs/ru/md/VK/Product-management/Get-product-list.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает список товаров сообщества + + +
+ + *Функция ПолучитьСписокТоваров(Знач Подборка = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий товаров + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСписокТоваров(, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -[ + [ { "sku": "12 345", "is_main_variant": true, @@ -342,5 +346,4 @@ sidebar_position: 2 "availability": 0 } ] - ``` diff --git a/docs/ru/md/VK/Product-management/Get-products-by-id.md b/docs/ru/md/VK/Product-management/Get-products-by-id.md index 629a5bee52..f89d095d37 100644 --- a/docs/ru/md/VK/Product-management/Get-products-by-id.md +++ b/docs/ru/md/VK/Product-management/Get-products-by-id.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию о товарах по массиву ID + + +
+ + *Функция ПолучитьТоварыПоИД(Знач Товары, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - МассивТоваров = Новый Массив; МассивТоваров.Добавить("8656033"); @@ -26,8 +31,9 @@ sidebar_position: 3 Ответ = OPI_VK.ПолучитьТоварыПоИД(МассивТоваров, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": { "items": [ { @@ -707,5 +711,4 @@ sidebar_position: 3 "count": 2 } } - ``` diff --git a/docs/ru/md/VK/Product-management/Group-products.md b/docs/ru/md/VK/Product-management/Group-products.md index 5da5f2777f..08d1a546d4 100644 --- a/docs/ru/md/VK/Product-management/Group-products.md +++ b/docs/ru/md/VK/Product-management/Group-products.md @@ -6,6 +6,11 @@ sidebar_position: 7 Группирует товары на основе одинаковых наборов свойств + + +
+ + *Функция СгруппироватьТовары(Знач МассивТоваров, Знач СуществующаяГруппа = "", Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - МассивТоваров = Новый Массив; МассивТоваров.Добавить(ИДЖелтогоТовара); @@ -27,8 +32,9 @@ sidebar_position: 7 Ответ = OPI_VK.СгруппироватьТовары(МассивТоваров, , Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -36,13 +42,10 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "response": { "item_group_id": 5957 } } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md index b884b3747c..78e4e67664 100644 --- a/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Add-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 5 Добавляет вариант для существующего свойства + + +
+ + *Функция ДобавитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ДобавитьВариантСвойстваТовара("Красный", 260, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,13 +38,10 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "response": { "variant_id": 980 } } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Create-product-property.md b/docs/ru/md/VK/Product-properties-management/Create-product-property.md index 889b8fdf90..68b6d951ff 100644 --- a/docs/ru/md/VK/Product-properties-management/Create-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Create-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает новое свойство для использования в товарах + + +
+ + *Функция СоздатьСвойствоТовара(Знач Название, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.СоздатьСвойствоТовара("Цвет", Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,13 +37,10 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "response": { "property_id": 260 } } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md index 436248e9e9..d6d8da589c 100644 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 7 Удаляет ранее созданный вариант свойства + + +
+ + *Функция УдалитьВариантСвойстваТовара(Знач Вариант, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.УдалитьВариантСвойстваТовара(980 Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md index 9e877397b2..db2d06873d 100644 --- a/docs/ru/md/VK/Product-properties-management/Delete-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Delete-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет существующее свойство товара + + +
+ + *Функция УдалитьСвойствоТовара(Знач Свойство, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.УдалитьСвойствоТовара(260, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md index 78db8dada8..83a1e7c619 100644 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property-variant.md @@ -6,6 +6,11 @@ sidebar_position: 6 Изменяет значение варианта существующего свойства товара + + +
+ + *Функция ИзменитьВариантСвойстваТовара(Знач Значение, Знач Свойство, Знач Вариант, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,14 +23,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ИзменитьВариантСвойстваТовара("Желтый", 260, 980 Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -33,11 +39,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md index 417750f68e..583c331226 100644 --- a/docs/ru/md/VK/Product-properties-management/Edit-product-property.md +++ b/docs/ru/md/VK/Product-properties-management/Edit-product-property.md @@ -6,6 +6,11 @@ sidebar_position: 3 Изменяет существующее свойство товара + + +
+ + *Функция ИзменитьСвойствоТовара(Знач Название, Знач Свойство, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ИзменитьСвойствоТовара("Цвет (изм.)", Свойство, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,11 +38,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-properties-management/Get-property-list.md b/docs/ru/md/VK/Product-properties-management/Get-property-list.md index c5197d20d1..f373ec91e1 100644 --- a/docs/ru/md/VK/Product-properties-management/Get-property-list.md +++ b/docs/ru/md/VK/Product-properties-management/Get-property-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список свойств товаров группы + + +
+ + *Функция ПолучитьСписокСвойств(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСписокСвойств(Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -[ + [ { "variants": [ { @@ -54,5 +58,4 @@ sidebar_position: 1 "id": 255 } ] - ``` 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 7f8a38508a..3b5c77a56d 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 @@ -6,6 +6,11 @@ sidebar_position: 5 Добавляет товар в подборку + + +
+ + *Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ДобавитьТоварВПодборку(8656559, 40, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,11 +38,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Create-product-collection.md b/docs/ru/md/VK/Product-selection-management/Create-product-collection.md index f1e23e4fed..e07e81a78d 100644 --- a/docs/ru/md/VK/Product-selection-management/Create-product-collection.md +++ b/docs/ru/md/VK/Product-selection-management/Create-product-collection.md @@ -6,6 +6,11 @@ sidebar_position: 3 Создает пустую подборку товаров + + +
+ + *Функция СоздатьПодборкуТоваров(Знач Название, Знач Картинка, Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.СоздатьПодборкуТоваров("Тестовая подборка" , Картинка @@ -30,8 +35,9 @@ sidebar_position: 3 Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -39,14 +45,11 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "response": { "albums_count": 23, "market_album_id": 39 } } - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Delete-selection.md b/docs/ru/md/VK/Product-selection-management/Delete-selection.md index 5d38ee2275..6d5f14fe10 100644 --- a/docs/ru/md/VK/Product-selection-management/Delete-selection.md +++ b/docs/ru/md/VK/Product-selection-management/Delete-selection.md @@ -6,6 +6,11 @@ sidebar_position: 7 Удаляет подборку по ID + + +
+ + *Функция УдалитьПодборку(Знач Подборка, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 7 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.УдалитьПодборку(40, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,11 +37,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md index ea6a5fe62c..cd6537bae3 100644 --- a/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md +++ b/docs/ru/md/VK/Product-selection-management/Edit-product-collection.md @@ -6,6 +6,11 @@ sidebar_position: 4 Изменяет свойства подборки товаров + + +
+ + *Функция ИзменитьПодборкуТоваров(Знач Название, Знач Подборка, Знач Картинка = "", Знач Основная = Ложь, Знач Скрытая = Ложь, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ИзменитьПодборкуТоваров("Измененная подборка" , 40 @@ -32,8 +37,9 @@ sidebar_position: 4 Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -41,11 +47,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selection-list.md b/docs/ru/md/VK/Product-selection-management/Get-selection-list.md index b76f115320..d319966de1 100644 --- a/docs/ru/md/VK/Product-selection-management/Get-selection-list.md +++ b/docs/ru/md/VK/Product-selection-management/Get-selection-list.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает список подборок товаров + + +
+ + *Функция ПолучитьСписокПодборок(Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - Массив соответствий подборок + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСписокПодборок(Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -[ + [ { "is_hidden": false, "is_main": true, @@ -110,5 +114,4 @@ sidebar_position: 1 "id": 38 } ] - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md b/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md index 94d5a537cb..212246d62b 100644 --- a/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md +++ b/docs/ru/md/VK/Product-selection-management/Get-selections-by-id.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получить список подборок по массиву ID + + +
+ + *Функция ПолучитьПодборкиПоИД(Знач Подборки, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьПодборкиПоИД(Подборки, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -[ + [ { "is_hidden": false, "is_main": true, @@ -111,5 +115,4 @@ sidebar_position: 2 "id": 38 } ] - ``` diff --git a/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md b/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md index 01457fe9d4..9f3155514e 100644 --- a/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md +++ b/docs/ru/md/VK/Product-selection-management/Remove-product-from-selection.md @@ -6,6 +6,11 @@ sidebar_position: 6 Удаляет ранее добавленный товар из подборки + + +
+ + *Функция УдалитьТоварИзПодборки(Знач Товар, Знач Подборка, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.УдалитьТоварИзПодборки(8656559, 40, Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,11 +38,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "response": 1 } - ``` diff --git a/docs/ru/md/VK/Statistics/Get-post-statistics.md b/docs/ru/md/VK/Statistics/Get-post-statistics.md index 87f0c5182c..4d1e719495 100644 --- a/docs/ru/md/VK/Statistics/Get-post-statistics.md +++ b/docs/ru/md/VK/Statistics/Get-post-statistics.md @@ -6,6 +6,11 @@ sidebar_position: 2 Получает статистику в разрезе постов + + +
+ + *Функция ПолучитьСтатистикуПостов(Знач МассивИДПостов, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,8 +21,8 @@ sidebar_position: 2 Возвращаемое значение: Массив из Произвольный - Массив данных статистики по постам + ```bsl title="Пример кода" - МассивПостов = Новый Массив; МассивПостов.Добавить(214); @@ -26,8 +31,9 @@ sidebar_position: 2 Ответ = OPI_VK.ПолучитьСтатистикуПостов(МассивПостов, VK_Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -[ + [ { "ad_report": 0, "ad_coverage": 0, @@ -84,5 +88,4 @@ sidebar_position: 2 "post_id": 215 } ] - ``` diff --git a/docs/ru/md/VK/Statistics/Get-statistics.md b/docs/ru/md/VK/Statistics/Get-statistics.md index 3619ff70e1..b480aada67 100644 --- a/docs/ru/md/VK/Statistics/Get-statistics.md +++ b/docs/ru/md/VK/Statistics/Get-statistics.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает общую статистику сообщества за период + + +
+ + *Функция ПолучитьСтатистику(Знач ДатаНачала, Знач ДатаОкончания, Знач Параметры = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,14 +22,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK + ```bsl title="Пример кода" - Ответ = OPI_VK.ПолучитьСтатистику(ТекущаяДатаСеанса() - 60 * 60 * 24, ТекущаяДатаСеанса(), Параметры); Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - ``` + + ```sh title="Пример команды CLI" @@ -32,10 +38,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "response": [ { "visitors": { @@ -543,5 +547,4 @@ sidebar_position: 1 } ] } - ``` diff --git a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md index 46ddd505e1..6b231fc621 100644 --- a/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md +++ b/docs/ru/md/VK/Token-retrieval/Create-token-retrieval-link.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получение ссылки для интерактивного получения токена (access_token), который необходим для дальнейших действий + + +
+ + *Функция СоздатьСсылкуПолученияТокена(Знач App_id) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,12 +20,13 @@ sidebar_position: 1 Возвращаемое значение: Строка - URL, по которому необходимо перейти в браузере + ```bsl title="Пример кода" - Приложение = "51694790"; Результат = OPI_VK.СоздатьСсылкуПолученияТокена(Приложение); - ``` + + ```sh title="Пример команды CLI" @@ -28,9 +34,6 @@ sidebar_position: 1 ``` - ```json title="Результат" - -"https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" - + "https://oauth.vk.com/authorize?client_id=51694790&scope=offline,wall,groups,photos,stats,stories,ads,market,video&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html" ``` diff --git a/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md index dbb9a4b6cb..ffbfc1da8c 100644 --- a/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md +++ b/docs/ru/md/Viber/Message-sending/Create-keyboard-from-array-button.md @@ -6,6 +6,11 @@ sidebar_position: 7 Возвращает структура клавиатуры для сообщений + + +
+ + *Функция СформироватьКлавиатуруИзМассиваКнопок(Знач МассивКнопок, Знач ЦветКнопок = "#2db9b9") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 7 Возвращаемое значение: Структура - Сформировать клавиатуру из массива кнопок: + ```bsl title="Пример кода" - МассивКнопок = Новый Массив; МассивКнопок.Добавить("Кнопка 1"); @@ -28,8 +33,9 @@ sidebar_position: 7 Клавиатура = OPI_Viber.СформироватьКлавиатуруИзМассиваКнопок(МассивКнопок); //Структура JSON = OPI_Инструменты.JSONСтрокой(Клавиатура); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 7 ``` - ```json title="Результат" - -{ + { "Buttons": [ { "ActionType": "reply", @@ -66,5 +70,4 @@ sidebar_position: 7 ], "Type": "keyboard" } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-contact.md b/docs/ru/md/Viber/Message-sending/Send-contact.md index 7f56c18e34..ed4df0b977 100644 --- a/docs/ru/md/Viber/Message-sending/Send-contact.md +++ b/docs/ru/md/Viber/Message-sending/Send-contact.md @@ -6,6 +6,11 @@ sidebar_position: 4 Отправляет контакт с номером телефона в чат или канал + + +
+ + *Функция ОтправитьКонтакт(Знач Токен, Знач ИмяКонтакта, Знач НомерТелефона, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; IDПользователя = "d3jxe1111111111jYGgZg=="; @@ -28,8 +33,9 @@ sidebar_position: 4 Ответ = OPI_Viber.ОтправитьКонтакт(ТокенБота, "Пётр Петров", "+749521231", IDПользователя, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,15 +43,12 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-15_", "message_token": 5925747984748149627, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-file.md b/docs/ru/md/Viber/Message-sending/Send-file.md index 195b9fc009..c6dcc87448 100644 --- a/docs/ru/md/Viber/Message-sending/Send-file.md +++ b/docs/ru/md/Viber/Message-sending/Send-file.md @@ -6,6 +6,11 @@ sidebar_position: 3 Отправляет файл (документ) в чат или канал + + +
+ + *Функция ОтправитьФайл(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Расширение, Знач Размер = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -20,8 +25,8 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; IDПользователя = "tMNGh111111111D+bT4g=="; @@ -29,8 +34,9 @@ sidebar_position: 3 Ответ = OPI_Viber.ОтправитьФайл(ТокенКанала, "https://api.athenaeum.digital/1.txt", IDПользователя, Истина, "txt"); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -38,14 +44,11 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "chat_hostname": "SN-CHAT-09_", "message_token": 5925491906424759104, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-image.md b/docs/ru/md/Viber/Message-sending/Send-image.md index 0d00515ae0..828035b641 100644 --- a/docs/ru/md/Viber/Message-sending/Send-image.md +++ b/docs/ru/md/Viber/Message-sending/Send-image.md @@ -6,6 +6,11 @@ sidebar_position: 2 Отправляет картинку в чат или канал + + +
+ + *Функция ОтправитьКартинку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал, Знач Описание = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенКанала = "523b58ba82afffaa-111111111111111-2222222222222222"; IDПользователя = "tMNGh111111111D+bT4g=="; @@ -28,8 +33,9 @@ sidebar_position: 2 Ответ = OPI_Viber.ОтправитьКартинку(ТокенКанала, "https://api.athenaeum.digital/logo.png", IDПользователя, Истина, "Альпака"); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,14 +43,11 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "chat_hostname": "SN-CHAT-12_", "message_token": 5925484936191962157, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-link.md b/docs/ru/md/Viber/Message-sending/Send-link.md index 406752c435..250cd554a0 100644 --- a/docs/ru/md/Viber/Message-sending/Send-link.md +++ b/docs/ru/md/Viber/Message-sending/Send-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Отправляет URL с предпросмотром в чат или канал + + +
+ + *Функция ОтправитьСсылку(Знач Токен, Знач URL, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; IDПользователя = "d3jxe1111111111jYGgZg=="; @@ -27,8 +32,9 @@ sidebar_position: 6 Ответ = OPI_Viber.ОтправитьСсылку(ТокенБота, "https://github.com/Bayselonarrend", IDПользователя, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -36,15 +42,12 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-15_", "message_token": 5925752472607291800, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-location.md b/docs/ru/md/Viber/Message-sending/Send-location.md index 76f706629b..f87067a2b8 100644 --- a/docs/ru/md/Viber/Message-sending/Send-location.md +++ b/docs/ru/md/Viber/Message-sending/Send-location.md @@ -6,6 +6,11 @@ sidebar_position: 5 Отправляет географические координаты в чат или канал + + +
+ + *Функция ОтправитьЛокацию(Знач Токен, Знач Широта, Знач Долгота, Знач IDПользователя, Знач ОтправкаВКанал) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; IDПользователя = "d3jxe1111111111jYGgZg=="; @@ -28,8 +33,9 @@ sidebar_position: 5 Ответ = OPI_Viber.ОтправитьЛокацию(ТокенБота, "55.75", "37.6167", IDПользователя, Ложь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -37,15 +43,12 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "billing_status": 1, "chat_hostname": "SN-CHAT-10_", "message_token": 5925751017338988046, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Message-sending/Send-text-message.md b/docs/ru/md/Viber/Message-sending/Send-text-message.md index 43dbd0df36..e2d3a34a9c 100644 --- a/docs/ru/md/Viber/Message-sending/Send-text-message.md +++ b/docs/ru/md/Viber/Message-sending/Send-text-message.md @@ -6,6 +6,11 @@ sidebar_position: 1 Отправляет текстовое сообщение в чат или канал + + +
+ + *Функция ОтправитьТекстовоеСообщение(Знач Токен, Знач Текст, Знач IDПользователя, Знач ОтправкаВКанал, Знач Клавиатура = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,8 +24,8 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - ТокенБота = "523b5b25ed27e6ec-111111111111111-2222222222222222"; IDПользователя = "d3jxe1111111111jYGgZg=="; @@ -36,8 +41,9 @@ sidebar_position: 1 Ответ = OPI_Viber.ОтправитьТекстовоеСообщение(ТокенБота, "Привет", IDПользователя, Ложь, Клавиатура); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -45,14 +51,11 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "chat_hostname": "SN-CHAT-10_", "message_token": 5925400810709476620, "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md index 77c1559166..6e94ee9b22 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-channel-information.md @@ -6,6 +6,11 @@ sidebar_position: 2 Тут можно получить ID пользователей канала. ID для бота необходимо получать из прилетов на Webhook ID пользователя из информации о канале не подойдет для отправки сообщений через бота - они разные + + +
+ + *Функция ПолучитьИнформациюОКанале(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,14 +20,15 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - Ответ = OPI_Viber.ПолучитьИнформациюОКанале(ТокенКанала); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -30,10 +36,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "members": [ { "role": "admin", @@ -57,5 +61,4 @@ sidebar_position: 2 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-online-users.md b/docs/ru/md/Viber/Settings-and-information/Get-online-users.md index e56aa69964..bd852b081b 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-online-users.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-online-users.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает статус пользователя или нескольких пользователей по ID + + +
+ + *Функция ПолучитьОнлайнПользователей(Знач Токен, Знач IDПользователей) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - Ответ = OPI_Viber.ПолучитьОнлайнПользователей(Токен, IDПользователя); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "users": [ { "last_online": 1704796869778, @@ -46,5 +50,4 @@ sidebar_position: 4 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Settings-and-information/Get-user-data.md b/docs/ru/md/Viber/Settings-and-information/Get-user-data.md index ab839f0178..e4ab8fefb2 100644 --- a/docs/ru/md/Viber/Settings-and-information/Get-user-data.md +++ b/docs/ru/md/Viber/Settings-and-information/Get-user-data.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию о пользователе по ID + + +
+ + *Функция ПолучитьДанныеПользователя(Знач Токен, Знач IDПользователя) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - Ответ = OPI_Viber.ПолучитьДанныеПользователя(Токен, IDПользователя); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "user": { "device_type": "iPhone8,4", "mnc": 1, @@ -52,5 +56,4 @@ sidebar_position: 3 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md b/docs/ru/md/Viber/Settings-and-information/Set-webhook.md index 1d475f2df6..e8fcd287a8 100644 --- a/docs/ru/md/Viber/Settings-and-information/Set-webhook.md +++ b/docs/ru/md/Viber/Settings-and-information/Set-webhook.md @@ -6,6 +6,11 @@ sidebar_position: 1 ВАЖНО: Установка Webhook обязательна по правилам Viber. Для этого надо иметь свободный URL, который будет возвращать 200 и подлинный SSL сертификат. Если есть сертификат и база опубликована на сервере - можно использовать http-сервис. Туда же будет приходить и информация о новых сообщениях Viber периодически стучит по адресу Webhook, так что если он будет неактивен, то все перестанет работать + + +
+ + *Функция УстановитьWebhook(Знач Токен, Знач URL) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,14 +21,15 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Viber + ```bsl title="Пример кода" - Ответ = OPI_Viber.УстановитьWebhook(Токен, "https://api.athenaeum.digital/opi/hs/viber"); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "event_types": [ "subscribed", "unsubscribed", @@ -51,5 +55,4 @@ sidebar_position: 1 "status_message": "ok", "status": 0 } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md index d710da2970..32f71ffdb1 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-folder.md @@ -6,6 +6,11 @@ sidebar_position: 2 Создает каталог на диске + + +
+ + *Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Тестовая папка" Ответ = OPI_YandexDisk.СоздатьПапку(Токен, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "revision": 1707461457546792, "comment_ids": { "public_resource": "1573541518:ba32b9efac79ab1b04707a4278a1ff583d7b0403ea306035f1b910e56c6ef3ac", @@ -58,5 +62,4 @@ sidebar_position: 2 "sort": "" } } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md index 363f5956b7..ce965bdc2a 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Create-object-copy.md @@ -6,6 +6,11 @@ sidebar_position: 5 Создает копию объекта по заданному пути и пути к оригиналу + + +
+ + *Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Оригинал = "/Альпака.png"; @@ -28,8 +33,9 @@ sidebar_position: 5 Ответ = OPI_YandexDisk.СоздатьКопиюОбъекта(Токен, Оригинал, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707469147481281, @@ -112,5 +116,4 @@ sidebar_position: 5 }, "mime_type": "multipart" } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md index 02a6320486..fccafbfc0f 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Delete-object.md @@ -6,6 +6,11 @@ sidebar_position: 4 Удаляет объект по заданному пути + + +
+ + *Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png" Ответ = OPI_YandexDisk.УдалитьОбъект(Токен, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -34,9 +40,6 @@ sidebar_position: 4 ``` - ```json title="Результат" - -<пустая строка> - + <пустая строка> ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md index 5e9c8b78c5..cb91103a99 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Download-file.md @@ -6,6 +6,11 @@ sidebar_position: 7 Скачивает файл по указанному пути + + +
+ + *Функция СкачатьФайл(Знач Токен, Знач Путь, Знач ПутьСохранения = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,12 +22,13 @@ sidebar_position: 7 Возвращаемое значение: ДвоичныеДанные,Строка - Двоичные данные или путь к файлу при указании параметра ПутьСохранения + ```bsl title="Пример кода" - Путь = "/alpaca.png"; Результат = OPI_YandexDisk.СкачатьФайл(Токен, Путь); - ``` + + ```sh title="Пример команды CLI" @@ -30,9 +36,6 @@ sidebar_position: 7 ``` - ```json title="Результат" - <Двоичные данные файла> - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md index 20fd14f383..e3b07383bc 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-disk-information.md @@ -6,6 +6,11 @@ sidebar_position: 1 Получает информацию о текущем диске + + +
+ + *Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -15,15 +20,16 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Ответ = OPI_YandexDisk.ПолучитьИнформациюОДиске(Токен); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -31,10 +37,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "user": { "login": "bayselonarrend", "country": "by", @@ -70,5 +74,4 @@ sidebar_position: 1 "paid_max_file_size": 53687091200, "max_file_size": 1073741824 } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md index c79b41ce1b..78cebebd05 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-download-link.md @@ -6,6 +6,11 @@ sidebar_position: 6 Получает ссылку для скачивания файла + + +
+ + *Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png" Ответ = OPI_YandexDisk.ПолучитьСсылкуДляСкачивания(Токен, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,13 +39,10 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "templated": false, "method": "GET", "href": "https://downloader.disk.yandex.ru/disk/5e035e14f3580573be69477a0a5a41a598227875d7c471604e386ee2dcfc7067/65c62a93/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=1573541518&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2&etag=8d7bf7d7ee61113f9044f3a28496e458" } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md index 81eddb4023..5feb14966c 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-files-list.md @@ -6,6 +6,11 @@ sidebar_position: 8 Получает список файлов с или без отбора по типу Список доступных типов: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, mage, settings, spreadsheet, text, unknown, video, web + + +
+ + *Функция ПолучитьСписокФайлов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0, Знач ОтборПоТипу = "", Знач СортироватьПоДате = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -19,15 +24,16 @@ sidebar_position: 8 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Ответ = OPI_YandexDisk.ПолучитьСписокФайлов(Токен, 2, 1, "image"); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -35,10 +41,8 @@ sidebar_position: 8 ``` - ```json title="Результат" - -{ + { "limit": 2, "offset": 1, "items": [ @@ -192,5 +196,4 @@ sidebar_position: 8 } ] } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md index 4e0795c092..e6b7de9599 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Get-object.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает информацию об объекте диска по заданному пути + + +
+ + *Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png" Ответ = OPI_YandexDisk.ПолучитьОбъект(Токен, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707464146094880, @@ -108,5 +112,4 @@ sidebar_position: 3 }, "mime_type": "image/png" } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md index 9f320da75d..797bb8b915 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Move-object.md @@ -6,6 +6,11 @@ sidebar_position: 9 Перемещает объект по заданному пути и пути к оригиналу + + +
+ + *Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 9 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Оригинал = "/Альпака.png"; @@ -28,8 +33,9 @@ sidebar_position: 9 Ответ = OPI_YandexDisk.ПереместитьОбъект(Токен, Оригинал, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,10 +43,8 @@ sidebar_position: 9 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707469557170087, @@ -112,5 +116,4 @@ sidebar_position: 9 }, "mime_type": "image/png" } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md index b395dbae70..d28ca88070 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file-by-url.md @@ -6,6 +6,11 @@ sidebar_position: 11 Загружает файл на диск, забирая его по заданному URL + + +
+ + *Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 11 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png"; @@ -27,8 +32,9 @@ sidebar_position: 11 Ответ = OPI_YandexDisk.ЗагрузитьФайлПоURL(Токен, Путь, Адрес); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -36,13 +42,10 @@ sidebar_position: 11 ``` - ```json title="Результат" - -{ + { "templated": false, "method": "GET", "href": "https://cloud-api.yandex.net/v1/disk/operations/b78a7ef2dd49971aa22e5e72f2e615db885da9947d7c61b2822de23a99e855a1" } - ``` diff --git a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md index 167e6d42f9..dc91e3b4d6 100644 --- a/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md +++ b/docs/ru/md/Yandex_Disk/File-and-folder-management/Upload-file.md @@ -6,6 +6,11 @@ sidebar_position: 10 Загружает файл на диск по заданному пути + + +
+ + *Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 10 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/АльпакаИзФайла.png"; @@ -28,8 +33,9 @@ sidebar_position: 10 Ответ = OPI_YandexDisk.ЗагрузитьФайл(Токен, Путь, Файл); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -37,9 +43,6 @@ sidebar_position: 10 ``` - ```json title="Результат" - -<пустая строка> - + <пустая строка> ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md index bcfda54583..57b126c06a 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Cancel-object-publication.md @@ -6,6 +6,11 @@ sidebar_position: 2 Отменяет публикацию ранее опубликованного объекта + + +
+ + *Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 2 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png" Ответ = OPI_YandexDisk.ОтменитьПубликациюОбъекта(Токен, Путь); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 2 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707477571749555, @@ -108,5 +112,4 @@ sidebar_position: 2 }, "mime_type": "image/png" } - ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md index 5980767e9a..d3ac396b92 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-download-link-for-public-object.md @@ -6,6 +6,11 @@ sidebar_position: 5 Получает прямую ссылку для скачивания публичного объекта + + +
+ + *Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,8 +22,8 @@ sidebar_position: 5 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -26,8 +31,9 @@ sidebar_position: 5 Ответ = OPI_YandexDisk.ПолучитьСсылкуСкачиванияПубличногоОбъекта(Токен, URL); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -35,13 +41,10 @@ sidebar_position: 5 ``` - ```json title="Результат" - -{ + { "templated": false, "method": "GET", "href": "https://downloader.disk.yandex.ru/disk/e43662271abc4a5afd5b2122004e702e97e20c36932d687bbca183cfee10413d/65c63eba/gwThwhLBKYvLhQCNnqAHis09lIY3JS6kMxocI4drJ-uZelc6zzgdG8REX8G87z9KG45VhprQarmCtb_OEKbojQ%3D%3D?uid=0&filename=%D0%90%D0%BB%D1%8C%D0%BF%D0%B0%D0%BA%D0%B0.png&disposition=attachment&hash=O%2BtgG9OfyuyJgwBRM%2BBJVaHN3Kg0nH8yi5xbEKU3m%2Bd8vVVsZCwR%2BLHB8oeN%2BwcTq/J6bpmRyOJonT3VoXnDag%3D%3D%3A&limit=0&content_type=image%2Fpng&owner_uid=1573541518&fsize=440431&hid=0e9b208e1aea0dbd58b4b43ccdc3ad5a&media_type=image&tknv=v2" } - ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md index ad98c70475..fc547d0bf0 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-public-object.md @@ -6,6 +6,11 @@ sidebar_position: 4 Получает информацию об опубликованном объекте по его URL + + +
+ + *Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 4 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -27,8 +32,9 @@ sidebar_position: 4 Ответ = OPI_YandexDisk.ПолучитьПубличныйОбъект(Токен, URL); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 4 ``` - ```json title="Результат" - -{ + { "modified": "2024-02-09T10:50:41+00:00", "sizes": [ { @@ -119,5 +123,4 @@ sidebar_position: 4 "antivirus_status": "clean", "mime_type": "image/png" } - ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md index b27e26b8f1..c5126e4c5d 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Get-published-objects-list.md @@ -6,6 +6,11 @@ sidebar_position: 3 Получает список опубликованных объектов + + +
+ + *Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -17,16 +22,17 @@ sidebar_position: 3 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Ответ = OPI_YandexDisk.ПолучитьСписокОпубликованныхОбъектов(Токен, 2, 1); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -34,10 +40,8 @@ sidebar_position: 3 ``` - ```json title="Результат" - -{ + { "limit": 2, "offset": 1, "items": [ @@ -187,5 +191,4 @@ sidebar_position: 3 } ] } - ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md index b9d4c68bb1..e9e9b7b8ff 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Publish-object.md @@ -6,6 +6,11 @@ sidebar_position: 1 Публикует объект диска в публичный доступ + + +
+ + *Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -16,16 +21,17 @@ sidebar_position: 1 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; Путь = "/Альпака.png" Ответ = OPI_YandexDisk.ОпубликоватьОбъект(Токен, Путь); //Соответствие; Ссылка на файл - Ответ["public_url"] Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -33,10 +39,8 @@ sidebar_position: 1 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707475863191537, @@ -110,5 +114,4 @@ sidebar_position: 1 "private_resource": "1573541518:bda4781175def7529059950870dd72cd70beef0ff592e7102e731fd2cb631ec3" } } - ``` diff --git a/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md b/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md index 8f284458c6..e5b9a30b13 100644 --- a/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md +++ b/docs/ru/md/Yandex_Disk/Manage-public-access/Save-public-object-to-disk.md @@ -6,6 +6,11 @@ sidebar_position: 6 Сохраняет публичный объект на ваш диск + + +
+ + *Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт* | Параметр | CLI опция | Тип | Назначение | @@ -18,8 +23,8 @@ sidebar_position: 6 Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex + ```bsl title="Пример кода" - Токен = "y0_AgAAAABdylaOAA..."; URL = "https://disk.yandex.by/i/txwzakUVtxgjoQ" @@ -27,8 +32,9 @@ sidebar_position: 6 Ответ = OPI_YandexDisk.СохранитьПубличныйОбъектНаДиск(Токен, URL); //Соответствие Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка - ``` + + ```sh title="Пример команды CLI" @@ -36,10 +42,8 @@ sidebar_position: 6 ``` - ```json title="Результат" - -{ + { "md5": "8d7bf7d7ee61113f9044f3a28496e458", "sha256": "f7607461b40164d5064d1d5085cbe1e94ecb1326e7ff8db857931b2ccd14b7f8", "revision": 1707476319349747, @@ -111,5 +115,4 @@ sidebar_position: 6 }, "mime_type": "image/png" } - ``` diff --git a/service/dictionaries/en.json b/service/dictionaries/en.json index 9ff5d524ae..08ab1d58f2 100644 --- a/service/dictionaries/en.json +++ b/service/dictionaries/en.json @@ -4768,5 +4768,6 @@ "Работа с Twitter подразумевает работу с двумя API - v1 (1.1) и v2, которые, при этом, не относятся к разным видам действий, но просто являются версиями друг друга. Несмотря на то, что Twitter настаивает на использовании v2, вышло так, что некоторые механизмы (в частности механизм загрузки файлов) в ней так и не появилися. Поэтому, даже для создания обычного твита с картинкой необходима работа с обеими версиями API, а, как следствие, двойной набор авторизационных данны. Этот набор описан в функции": "Working with Twitter involves using two APIs - v1 (1.1) and v2, which are not separate types of actions but simply different versions of the API. Despite Twitter's preference for v2, it turned out that some mechanisms (such as the file upload mechanism) did not appear in it. Therefore, even for creating a regular tweet with an image, you need to work with both API versions, resulting in a double set of authentication data. This set is described in the function", "Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество\/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно": "It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number\/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately", "Ввести домееное имя и URL обработчика перенаправлений. Тут нужно отметить, что данный механизм создания приложений - новый. Еще недавно приложения VK создавались иначе и иметь redirect_url для них было не нужно. На данный момент не совсем понятно, зачем он нужен нам для серверного приложения - просто такого понятия как серверное приложение у VK теперь нет. Теоретически, туда можно вписать что угодно - для работы с библиотекой в получении обратных данных нет необходимости. Однако, с течением времени, это может измениться": "Enter the domain name and the URL of the redirect handler. It's worth noting that this mechanism for creating VK applications is new. Until recently, VK applications were created differently, and having a redirect URL was unnecessary. At the moment, it's not entirely clear why it's needed for our server application - VK no longer distinguishes server applications as such. Theoretically, you can enter anything there - there is no need for receiving callback data to work with the library. However, this may change over time", -"Перечень необходимых данных в виде структуры содержится в функции *ПолучитьСтандартныеПараметры()*. Вы можете указывать значения параметров прямо в ней или же передавать их структурой при вызове любых других методов библиотеки в качестве необязательного параметра *Параметры* (последний во всех методах билиотеки). В последнем случае стандартные параметры будут перезаписаны по ключам теми, которые переданы при вызове метода. Перезаписаны будут только совпадающие по ключам данные. Если какой то параметр есть в наборе стандартных, но не был передан при вызове метода, то он сохранит стандартное значение": "The list of necessary data in the form of a structure is contained in the function *GetStandardParameters()*. You can specify parameter values directly within it or pass them as a structure when calling any other library methods as an optional parameter *Parameters* (the last one in all library methods). In the latter case, the standard parameters will be overwritten by the ones passed during the method call. Only the data with matching keys will be overwritten. If a parameter exists in the standard set but was not passed during the method call, it will retain its default value" +"Перечень необходимых данных в виде структуры содержится в функции *ПолучитьСтандартныеПараметры()*. Вы можете указывать значения параметров прямо в ней или же передавать их структурой при вызове любых других методов библиотеки в качестве необязательного параметра *Параметры* (последний во всех методах билиотеки). В последнем случае стандартные параметры будут перезаписаны по ключам теми, которые переданы при вызове метода. Перезаписаны будут только совпадающие по ключам данные. Если какой то параметр есть в наборе стандартных, но не был передан при вызове метода, то он сохранит стандартное значение": "The list of necessary data in the form of a structure is contained in the function *GetStandardParameters()*. You can specify parameter values directly within it or pass them as a structure when calling any other library methods as an optional parameter *Parameters* (the last one in all library methods). In the latter case, the standard parameters will be overwritten by the ones passed during the method call. Only the data with matching keys will be overwritten. If a parameter exists in the standard set but was not passed during the method call, it will retain its default value", +"Метод API": "API method" } diff --git a/src/ru/OInt/core/Modules/OPI_Bitrix24.os b/src/ru/OInt/core/Modules/OPI_Bitrix24.os index 72a8a87c03..d274e1ebb7 100644 --- a/src/ru/OInt/core/Modules/OPI_Bitrix24.os +++ b/src/ru/OInt/core/Modules/OPI_Bitrix24.os @@ -151,6 +151,9 @@ // Создать новость // Создает новую новость в ленте // +// Примечание: +// Метод API: [log.blogpost.add](@dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +// // Параметры: // URL - Строка - URL внешнего вебхука или адрес Bitrix24 при использовании токена - url // Текст - Строка - Текст новости - text diff --git a/src/ru/OInt/lib.config b/src/ru/OInt/lib.config index 1f77c0d69a..984bd2e070 100644 --- a/src/ru/OInt/lib.config +++ b/src/ru/OInt/lib.config @@ -1,21 +1,21 @@  - - - - - - - - - + + + - + + + + - + - + + + + diff --git a/src/ru/OPI/src/CommonModules/OPI_Bitrix24/Module.bsl b/src/ru/OPI/src/CommonModules/OPI_Bitrix24/Module.bsl index 94e6aafef4..a225a6bbf2 100644 --- a/src/ru/OPI/src/CommonModules/OPI_Bitrix24/Module.bsl +++ b/src/ru/OPI/src/CommonModules/OPI_Bitrix24/Module.bsl @@ -151,6 +151,9 @@ // Создать новость // Создает новую новость в ленте // +// Примечание: +// Метод API: [log.blogpost.add](@dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php) +// // Параметры: // URL - Строка - URL внешнего вебхука или адрес Bitrix24 при использовании токена - url // Текст - Строка - Текст новости - text